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

#include <Thyra_BelosLinearOpWithSolveFactory_decl.hpp>

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

Parameter names for Parameter List
static const std::string	SolverType_name
static const std::string	SolverType_default
static const std::string	SolverTypes_name
static const std::string	BlockGMRES_name
static const std::string	PseudoBlockGMRES_name
static const std::string	BlockCG_name
static const std::string	PseudoBlockCG_name
static const std::string	PseudoBlockStochasticCG_name
static const std::string	GCRODR_name
static const std::string	RCG_name
static const std::string	MINRES_name
static const std::string	TFQMR_name
static const std::string	BiCGStab_name
static const std::string	FixedPoint_name
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

Public functions overridden from Teuchos::Describable.
std::string	description () const

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

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

◆ MagnitudeType

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

◆ BelosLinearOpWithSolveFactory() [1/2]

template<class Scalar>

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

Construct without preconditioner factory.

Definition at line 99 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

◆ BelosLinearOpWithSolveFactory() [2/2]

template<class Scalar>

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

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

Member Function Documentation

◆ acceptsPreconditionerFactory()

template<class Scalar>

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

Returns true .

Definition at line 121 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

◆ setPreconditionerFactory()

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.

◆ getPreconditionerFactory()

template<class Scalar>

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

Definition at line 149 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

◆ unsetPreconditionerFactory()

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.

◆ isCompatible()

template<class Scalar>

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

Definition at line 170 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

◆ createOp()

template<class Scalar>

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

Definition at line 182 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

◆ initializeOp()

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.

◆ initializeAndReuseOp()

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.

◆ uninitializeOp()

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.

◆ supportsPreconditionerInputType()

template<class Scalar>

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

Definition at line 212 of file Thyra_BelosLinearOpWithSolveFactory_def.hpp.

◆ initializePreconditionedOp()

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.

◆ initializeApproxPreconditionedOp()

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