Stratimikos  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
List of all members
Thyra::BelosLinearOpWithSolveFactory< Scalar > Class Template Reference

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

#include <Thyra_BelosLinearOpWithSolveFactory_decl.hpp>

Inheritance diagram for Thyra::BelosLinearOpWithSolveFactory< Scalar >:
Inheritance graph
[legend]

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 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 86 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

Member Typedef Documentation

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

Definition at line 93 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

Constructor & Destructor Documentation

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

Construct without preconditioner factory.

Definition at line 112 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 121 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

Member Function Documentation

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

Returns true .

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 134 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

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

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 141 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

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

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 162 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

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

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 169 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

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

Implements Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 183 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

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

Implements Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 195 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
virtual

Implements Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 202 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
virtual

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 214 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
virtual

Implements Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 262 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

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

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 225 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
virtual

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 236 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
virtual

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 249 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

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

Implements Teuchos::ParameterListAcceptor.

Definition at line 297 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

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

Implements Teuchos::ParameterListAcceptor.

Definition at line 314 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

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

Implements Teuchos::ParameterListAcceptor.

Definition at line 322 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

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

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 332 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

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

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 340 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

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

Reimplemented from Teuchos::Describable.

Definition at line 350 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 101 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

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

Definition at line 103 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

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

Definition at line 105 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

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

Definition at line 107 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

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

Definition at line 109 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

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

Definition at line 111 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

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

Definition at line 113 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 115 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

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

Definition at line 117 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

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

Definition at line 119 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

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

Definition at line 121 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

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

Definition at line 123 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

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

Definition at line 125 of file Thyra_BelosLinearOpWithSolveFactory_decl.hpp.

The documentation for this class was generated from the following files:
Generated on Fri Aug 14 2020 10:57:43 for Stratimikos by doxygen 1.8.5