Stratimikos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
Thyra::BelosLinearOpWithSolveFactory< Scalar > Class Template Reference
Belos to Thyra Linear Solver Adapter Code

LinearOpWithSolveFactoryBase subclass implemented in terms of Belos. More...

#include <Thyra_BelosLinearOpWithSolveFactory_decl.hpp>

Inherits LinearOpWithSolveFactoryBase< Scalar >.

Private Member Functions

void updateThisValidParamList ()
 
void initializeOpImpl (const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &approxFwdOpSrc, const Teuchos::RCP< const PreconditionerBase< Scalar > > &prec, const bool reusePrec, LinearOpWithSolveBase< Scalar > *Op, const ESupportSolveUse supportSolveUse) const
 

Static Private Member Functions

static Teuchos::RCP< const
Teuchos::ParameterList > 		generateAndGetValidParameters ()
 

Private Attributes

Teuchos::RCP
< PreconditionerFactoryBase
< Scalar > > 		precFactory_
 
std::string precFactoryName_
 
Teuchos::RCP
< Teuchos::ParameterList > 		thisValidParamList_
 
Teuchos::RCP
< Teuchos::ParameterList > 		paramList_
 
EBelosSolverType solverType_
 
int convergenceTestFrequency_
 

Public types

typedef Teuchos::ScalarTraits
< Scalar >::magnitudeType 		MagnitudeType
 

Parameter names for Parameter List

static const std::string SolverType_name = "Solver Type"
 
static const std::string SolverType_default = "Pseudo Block GMRES"
 
static const std::string SolverTypes_name = "Solver Types"
 
static const std::string BlockGMRES_name = "Block GMRES"
 
static const std::string PseudoBlockGMRES_name = "Pseudo Block GMRES"
 
static const std::string BlockCG_name = "Block CG"
 
static const std::string PseudoBlockCG_name = "Pseudo Block CG"
 
static const std::string PseudoBlockStochasticCG_name = "Pseudo Block Stochastic CG"
 
static const std::string GCRODR_name = "GCRODR"
 
static const std::string RCG_name = "RCG"
 
static const std::string MINRES_name = "MINRES"
 
static const std::string TFQMR_name = "TFQMR"
 
static const std::string BiCGStab_name = "BiCGStab"
 
static const std::string FixedPoint_name = "Fixed Point"
 
static const std::string TpetraGmres_name
 
static const std::string TpetraGmresPipeline_name
 
static const std::string TpetraGmresSingleReduce_name
 
static const std::string TpetraGmresSstep_name
 
static const std::string ConvergenceTestFrequency_name = "Convergence Test Frequency"
 

Constructors/initializers/accessors

 BelosLinearOpWithSolveFactory ()
 Construct without preconditioner factory. More...
 
 BelosLinearOpWithSolveFactory (const Teuchos::RCP< PreconditionerFactoryBase< Scalar > > &precFactory)
 Calls this->setPreconditionerFactory(precFactory)</tt. . More...
 

Overridden public functions from LinearOpWithSolveFactoryBase

bool acceptsPreconditionerFactory () const
 Returns true . More...
 
void setPreconditionerFactory (const Teuchos::RCP< PreconditionerFactoryBase< Scalar > > &precFactory, const std::string &precFactoryName)
 
Teuchos::RCP
< PreconditionerFactoryBase
< Scalar > > 		getPreconditionerFactory () const
 
void unsetPreconditionerFactory (Teuchos::RCP< PreconditionerFactoryBase< Scalar > > *precFactory, std::string *precFactoryName)
 
bool isCompatible (const LinearOpSourceBase< Scalar > &fwdOpSrc) const
 
Teuchos::RCP
< LinearOpWithSolveBase
< Scalar > > 		createOp () const
 
void initializeOp (const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, LinearOpWithSolveBase< Scalar > *Op, const ESupportSolveUse supportSolveUse) const
 
void initializeAndReuseOp (const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, LinearOpWithSolveBase< Scalar > *Op) const
 
void uninitializeOp (LinearOpWithSolveBase< Scalar > *Op, Teuchos::RCP< const LinearOpSourceBase< Scalar > > *fwdOpSrc, Teuchos::RCP< const PreconditionerBase< Scalar > > *prec, Teuchos::RCP< const LinearOpSourceBase< Scalar > > *approxFwdOpSrc, ESupportSolveUse *supportSolveUse) const
 
bool supportsPreconditionerInputType (const EPreconditionerInputType precOpType) const
 
void initializePreconditionedOp (const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, const Teuchos::RCP< const PreconditionerBase< Scalar > > &prec, LinearOpWithSolveBase< Scalar > *Op, const ESupportSolveUse supportSolveUse) const
 
void initializeApproxPreconditionedOp (const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &approxFwdOpSrc, LinearOpWithSolveBase< Scalar > *Op, const ESupportSolveUse supportSolveUse) const
 

Overridden from ParameterListAcceptor

void setParameterList (Teuchos::RCP< Teuchos::ParameterList > const &paramList)
 
Teuchos::RCP
< Teuchos::ParameterList > 		getNonconstParameterList ()
 
Teuchos::RCP
< Teuchos::ParameterList > 		unsetParameterList ()
 
Teuchos::RCP< const
Teuchos::ParameterList > 		getParameterList () const
 
Teuchos::RCP< const
Teuchos::ParameterList > 		getValidParameters () const
 

Public functions overridden from Teuchos::Describable.

std::string description () const
 

Detailed Description

template<class Scalar>
class Thyra::BelosLinearOpWithSolveFactory< Scalar >

LinearOpWithSolveFactoryBase subclass implemented in terms of Belos.

ToDo: Finish Documentation!

Definition at line 63 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

Member Typedef Documentation

template<class Scalar>
typedef Teuchos::ScalarTraits<Scalar>::magnitudeType Thyra::BelosLinearOpWithSolveFactory< Scalar >::MagnitudeType

Definition at line 70 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >
Thyra::BelosLinearOpWithSolveFactory< Scalar >::BelosLinearOpWithSolveFactory ( )

Construct without preconditioner factory.

Definition at line 99 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

template<class Scalar >
Thyra::BelosLinearOpWithSolveFactory< Scalar >::BelosLinearOpWithSolveFactory ( const Teuchos::RCP< PreconditionerFactoryBase< Scalar > > &  precFactory)

Calls this->setPreconditionerFactory(precFactory)</tt. .

Definition at line 108 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

Member Function Documentation

template<class Scalar >
bool Thyra::BelosLinearOpWithSolveFactory< Scalar >::acceptsPreconditionerFactory ( ) const

Returns true .

Definition at line 121 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

template<class Scalar >
void Thyra::BelosLinearOpWithSolveFactory< Scalar >::setPreconditionerFactory ( const Teuchos::RCP< PreconditionerFactoryBase< Scalar > > &  precFactory,
const std::string &  precFactoryName 
)

Definition at line 128 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

template<class Scalar >
RCP< PreconditionerFactoryBase< Scalar > > Thyra::BelosLinearOpWithSolveFactory< Scalar >::getPreconditionerFactory ( ) const

Definition at line 149 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

template<class Scalar >
void Thyra::BelosLinearOpWithSolveFactory< Scalar >::unsetPreconditionerFactory ( Teuchos::RCP< PreconditionerFactoryBase< Scalar > > *  precFactory,
std::string *  precFactoryName 
)

Definition at line 156 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

template<class Scalar >
bool Thyra::BelosLinearOpWithSolveFactory< Scalar >::isCompatible ( const LinearOpSourceBase< Scalar > &  fwdOpSrc) const

Definition at line 170 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

template<class Scalar >
RCP< LinearOpWithSolveBase< Scalar > > Thyra::BelosLinearOpWithSolveFactory< Scalar >::createOp ( ) const

Definition at line 182 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

template<class Scalar >
void Thyra::BelosLinearOpWithSolveFactory< Scalar >::initializeOp ( const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &  fwdOpSrc,
LinearOpWithSolveBase< Scalar > *  Op,
const ESupportSolveUse  supportSolveUse 
) const

Definition at line 189 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

template<class Scalar >
void Thyra::BelosLinearOpWithSolveFactory< Scalar >::initializeAndReuseOp ( const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &  fwdOpSrc,
LinearOpWithSolveBase< Scalar > *  Op 
) const

Definition at line 201 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

template<class Scalar >
void Thyra::BelosLinearOpWithSolveFactory< Scalar >::uninitializeOp ( LinearOpWithSolveBase< Scalar > *  Op,
Teuchos::RCP< const LinearOpSourceBase< Scalar > > *  fwdOpSrc,
Teuchos::RCP< const PreconditionerBase< Scalar > > *  prec,
Teuchos::RCP< const LinearOpSourceBase< Scalar > > *  approxFwdOpSrc,
ESupportSolveUse *  supportSolveUse 
) const

Definition at line 249 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

template<class Scalar >
bool Thyra::BelosLinearOpWithSolveFactory< Scalar >::supportsPreconditionerInputType ( const EPreconditionerInputType  precOpType) const

Definition at line 212 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

template<class Scalar >
void Thyra::BelosLinearOpWithSolveFactory< Scalar >::initializePreconditionedOp ( const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &  fwdOpSrc,
const Teuchos::RCP< const PreconditionerBase< Scalar > > &  prec,
LinearOpWithSolveBase< Scalar > *  Op,
const ESupportSolveUse  supportSolveUse 
) const

Definition at line 223 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

template<class Scalar >
void Thyra::BelosLinearOpWithSolveFactory< Scalar >::initializeApproxPreconditionedOp ( const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &  fwdOpSrc,
const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &  approxFwdOpSrc,
LinearOpWithSolveBase< Scalar > *  Op,
const ESupportSolveUse  supportSolveUse 
) const

Definition at line 236 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

template<class Scalar >
void Thyra::BelosLinearOpWithSolveFactory< Scalar >::setParameterList ( Teuchos::RCP< Teuchos::ParameterList > const &  paramList)

Definition at line 284 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

template<class Scalar >
RCP< Teuchos::ParameterList > Thyra::BelosLinearOpWithSolveFactory< Scalar >::getNonconstParameterList ( )

Definition at line 301 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

template<class Scalar >
RCP< Teuchos::ParameterList > Thyra::BelosLinearOpWithSolveFactory< Scalar >::unsetParameterList ( )

Definition at line 309 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

template<class Scalar >
RCP< const Teuchos::ParameterList > Thyra::BelosLinearOpWithSolveFactory< Scalar >::getParameterList ( ) const

Definition at line 319 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

template<class Scalar >
RCP< const Teuchos::ParameterList > Thyra::BelosLinearOpWithSolveFactory< Scalar >::getValidParameters ( ) const

Definition at line 327 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

template<class Scalar >
std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::description ( ) const

Definition at line 337 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

template<class Scalar >
RCP< const Teuchos::ParameterList > Thyra::BelosLinearOpWithSolveFactory< Scalar >::generateAndGetValidParameters ( )
staticprivate

Definition at line 355 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

template<class Scalar >
void Thyra::BelosLinearOpWithSolveFactory< Scalar >::updateThisValidParamList ( )
private

Definition at line 583 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

template<class Scalar >
void Thyra::BelosLinearOpWithSolveFactory< Scalar >::initializeOpImpl ( const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &  fwdOpSrc,
const Teuchos::RCP< const LinearOpSourceBase< Scalar > > &  approxFwdOpSrc,
const Teuchos::RCP< const PreconditionerBase< Scalar > > &  prec,
const bool  reusePrec,
LinearOpWithSolveBase< Scalar > *  Op,
const ESupportSolveUse  supportSolveUse 
) const
private

Definition at line 593 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

Member Data Documentation

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::SolverType_name = "Solver Type"
static

Definition at line 78 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::SolverType_default = "Pseudo Block GMRES"
static

Definition at line 80 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::SolverTypes_name = "Solver Types"
static

Definition at line 82 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::BlockGMRES_name = "Block GMRES"
static

Definition at line 84 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::PseudoBlockGMRES_name = "Pseudo Block GMRES"
static

Definition at line 86 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::BlockCG_name = "Block CG"
static

Definition at line 88 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::PseudoBlockCG_name = "Pseudo Block CG"
static

Definition at line 90 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::PseudoBlockStochasticCG_name = "Pseudo Block Stochastic CG"
static

Definition at line 92 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::GCRODR_name = "GCRODR"
static

Definition at line 94 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::RCG_name = "RCG"
static

Definition at line 96 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::MINRES_name = "MINRES"
static

Definition at line 98 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::TFQMR_name = "TFQMR"
static

Definition at line 100 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::BiCGStab_name = "BiCGStab"
static

Definition at line 102 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::FixedPoint_name = "Fixed Point"
static

Definition at line 104 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::TpetraGmres_name
static

Definition at line 106 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::TpetraGmresPipeline_name
static

Definition at line 108 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::TpetraGmresSingleReduce_name
static

Definition at line 110 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::TpetraGmresSstep_name
static

Definition at line 112 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::ConvergenceTestFrequency_name = "Convergence Test Frequency"
static

Definition at line 114 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
Teuchos::RCP<PreconditionerFactoryBase<Scalar> > Thyra::BelosLinearOpWithSolveFactory< Scalar >::precFactory_
private

Definition at line 221 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::precFactoryName_
private

Definition at line 222 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
Teuchos::RCP<Teuchos::ParameterList> Thyra::BelosLinearOpWithSolveFactory< Scalar >::thisValidParamList_
private

Definition at line 223 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
Teuchos::RCP<Teuchos::ParameterList> Thyra::BelosLinearOpWithSolveFactory< Scalar >::paramList_
private

Definition at line 224 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
EBelosSolverType Thyra::BelosLinearOpWithSolveFactory< Scalar >::solverType_
private

Definition at line 225 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

template<class Scalar>
int Thyra::BelosLinearOpWithSolveFactory< Scalar >::convergenceTestFrequency_
private

Definition at line 226 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.5