Thyra::BelosLinearOpWithSolveFactory< Scalar > Class Template Reference

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

#include <Thyra_BelosLinearOpWithSolveFactoryDecl.hpp>

List of all members.

Public types
typedef Teuchos::ScalarTraits< Scalar >::magnitudeType	MagnitudeType
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 >	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
Parameter names for Parameter List
const std::string	SolverType_name = "Solver Type"
const std::string	SolverType_default = "Block GMRES"
const std::string	SolverTypes_name = "Solver Types"
const std::string	BlockGMRES_name = "Block GMRES"
const std::string	PseudoBlockGMRES_name = "Pseudo Block GMRES"
const std::string	BlockCG_name = "Block CG"

---

Detailed Description

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

LinearOpWithSolveFactoryBase subclass implemented in terms of Belos.

ToDo: Finish Documentation!

---

Member Typedef Documentation

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

---

Constructor & Destructor Documentation

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

Construct without preconditioner factory.

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

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

---

Member Function Documentation

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

Returns true .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

---

Member Data Documentation

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

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

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

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

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

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

---

The documentation for this class was generated from the following files:

• Thyra_BelosLinearOpWithSolveFactoryDecl.hpp
• Thyra_BelosLinearOpWithSolveFactory.hpp

---