Thyra::BelosLinearOpWithSolveFactory< Scalar > Class Template Reference

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

#include <Thyra_BelosLinearOpWithSolveFactoryDecl.hpp>

Inheritance diagram for Thyra::BelosLinearOpWithSolveFactory< Scalar >:

Inheritance graph
[legend]

List of all members.

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 = "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"
 

Constructors/initializers/accessors



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

Overridden public functions from LinearOpWithSolveFactoryBase



bool acceptsPreconditionerFactory () const
 Returns true .
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 > 		getParameterList ()
 
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 21 of file Thyra_BelosLinearOpWithSolveFactoryDecl.hpp.

Member Typedef Documentation

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

Definition at line 28 of file Thyra_BelosLinearOpWithSolveFactoryDecl.hpp.

Constructor & Destructor Documentation

template<class Scalar >
Thyra::BelosLinearOpWithSolveFactory< Scalar >::BelosLinearOpWithSolveFactory (  )  [inline]

Construct without preconditioner factory.

Definition at line 37 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

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

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

Definition at line 44 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

Member Function Documentation

template<class Scalar >
bool Thyra::BelosLinearOpWithSolveFactory< Scalar >::acceptsPreconditionerFactory (  )  const [inline, virtual]

Returns true .

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 55 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

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

Definition at line 61 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar >
Teuchos::RCP< PreconditionerFactoryBase< Scalar > > Thyra::BelosLinearOpWithSolveFactory< Scalar >::getPreconditionerFactory (  )  const [inline, virtual]

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 81 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

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

Definition at line 87 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

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

Definition at line 100 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar >
Teuchos::RCP< LinearOpWithSolveBase< Scalar > > Thyra::BelosLinearOpWithSolveFactory< Scalar >::createOp (  )  const [inline, virtual]

Implements Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 111 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

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

Definition at line 117 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

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

Definition at line 128 of file Thyra_BelosLinearOpWithSolveFactory.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 [inline]

Definition at line 172 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

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

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 138 of file Thyra_BelosLinearOpWithSolveFactory.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 [inline]

Definition at line 148 of file Thyra_BelosLinearOpWithSolveFactory.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 [inline]

Definition at line 160 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

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

Implements Teuchos::ParameterListAcceptor.

Definition at line 205 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar >
Teuchos::RCP< Teuchos::ParameterList > Thyra::BelosLinearOpWithSolveFactory< Scalar >::getParameterList (  )  [inline, virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 218 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar >
Teuchos::RCP< Teuchos::ParameterList > Thyra::BelosLinearOpWithSolveFactory< Scalar >::unsetParameterList (  )  [inline, virtual]

Implements Teuchos::ParameterListAcceptor.

Definition at line 225 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

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

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 234 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

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

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 241 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

template<class Scalar >
std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::description (  )  const [inline, virtual]

Reimplemented from Teuchos::Describable.

Definition at line 249 of file Thyra_BelosLinearOpWithSolveFactory.hpp.

Member Data Documentation

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

Definition at line 36 of file Thyra_BelosLinearOpWithSolveFactoryDecl.hpp.

template<class Scalar >
const std::string Thyra::BelosLinearOpWithSolveFactory< Scalar >::SolverType_default = "Block GMRES" [inline, static]

Definition at line 38 of file Thyra_BelosLinearOpWithSolveFactoryDecl.hpp.

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

Definition at line 40 of file Thyra_BelosLinearOpWithSolveFactoryDecl.hpp.

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

Definition at line 42 of file Thyra_BelosLinearOpWithSolveFactoryDecl.hpp.

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

Definition at line 44 of file Thyra_BelosLinearOpWithSolveFactoryDecl.hpp.

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

Definition at line 46 of file Thyra_BelosLinearOpWithSolveFactoryDecl.hpp.

The documentation for this class was generated from the following files:
Generated on Wed Jul 22 13:20:49 2009 for Stratimikos by doxygen 1.5.8