Concrete LinearOpWithSolveBase subclass in terms of Belos. More...

#include <Thyra_BelosLinearOpWithSolve_decl.hpp>

Public typedefs
typedef MultiVectorBase< Scalar >	MV_t
typedef LinearOpBase< Scalar >	LO_t

Overridden from LinearOpWithSolveBase.
virtual bool	solveSupportsImpl (EOpTransp M_trans) const
virtual bool	solveSupportsNewImpl (EOpTransp transp, const Ptr< const SolveCriteria< Scalar > > solveCriteria) const
virtual bool	solveSupportsSolveMeasureTypeImpl (EOpTransp M_trans, const SolveMeasureType &solveMeasureType) const
virtual SolveStatus< Scalar >	solveImpl (const EOpTransp transp, const MultiVectorBase< Scalar > &B, const Ptr< MultiVectorBase< Scalar > > &X, const Ptr< const SolveCriteria< Scalar > > solveCriteria) const

Constructors/initializers/accessors
	BelosLinearOpWithSolve ()
	Construct to unintialize.
void	initialize (const RCP< Belos::LinearProblem< Scalar, MV_t, LO_t > > &lp, const RCP< Teuchos::ParameterList > &solverPL, const RCP< Belos::SolverManager< Scalar, MV_t, LO_t > > &iterativeSolver, const RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, const RCP< const PreconditionerBase< Scalar > > &prec, const bool isExternalPrec, const RCP< const LinearOpSourceBase< Scalar > > &approxFwdOpSrc, const ESupportSolveUse &supportSolveUse, const int convergenceTestFrequency)
	Initializes given precreated solver objects.
RCP< const LinearOpSourceBase< Scalar > >	extract_fwdOpSrc ()
RCP< const PreconditionerBase< Scalar > >	extract_prec ()
bool	isExternalPrec () const
RCP< const LinearOpSourceBase< Scalar > >	extract_approxFwdOpSrc ()
ESupportSolveUse	supportSolveUse () const
void	uninitialize (RCP< Belos::LinearProblem< Scalar, MV_t, LO_t > > lp=NULL, RCP< Teuchos::ParameterList > solverPL=NULL, RCP< Belos::SolverManager< Scalar, MV_t, LO_t > > iterativeSolver=NULL, RCP< const LinearOpSourceBase< Scalar > > fwdOpSrc=NULL, RCP< const PreconditionerBase< Scalar > > prec=NULL, bool isExternalPrec=NULL, RCP< const LinearOpSourceBase< Scalar > > approxFwdOpSrc=NULL, ESupportSolveUse supportSolveUse=NULL)
	Uninitializes and returns stored quantities.

Overridden from LinearOpBase
RCP< const VectorSpaceBase< Scalar > >	range () const
RCP< const VectorSpaceBase< Scalar > >	domain () const
RCP< const LinearOpBase< Scalar > >	clone () const
virtual bool	opSupportedImpl (EOpTransp M_trans) const
virtual void	applyImpl (const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< Scalar > > &Y, const Scalar alpha, const Scalar beta) const

Overridden from Teuchos::Describable
std::string	description () const
void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const

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

Detailed Description

template<class Scalar>
class Thyra::BelosLinearOpWithSolve< Scalar >

Concrete LinearOpWithSolveBase subclass in terms of Belos.

ToDo: Finish documentation!

Definition at line 31 of file Thyra_BelosLinearOpWithSolve_decl.hpp.

Member Typedef Documentation

◆ MV_t

template<class Scalar>

typedef MultiVectorBase<Scalar> Thyra::BelosLinearOpWithSolve< Scalar >::MV_t

Definition at line 39 of file Thyra_BelosLinearOpWithSolve_decl.hpp.

◆ LO_t

template<class Scalar>

typedef LinearOpBase<Scalar> Thyra::BelosLinearOpWithSolve< Scalar >::LO_t

Definition at line 41 of file Thyra_BelosLinearOpWithSolve_decl.hpp.

Constructor & Destructor Documentation

◆ BelosLinearOpWithSolve()

template<class Scalar>

Thyra::BelosLinearOpWithSolve< Scalar >::BelosLinearOpWithSolve ( )

Construct to unintialize.

Definition at line 120 of file Thyra_BelosLinearOpWithSolve_def.hpp.

Member Function Documentation

◆ initialize()

template<class Scalar>

void Thyra::BelosLinearOpWithSolve< Scalar >::initialize	(	const RCP< Belos::LinearProblem< Scalar, MV_t, LO_t > > &	lp,
		const RCP< Teuchos::ParameterList > &	solverPL,
		const RCP< Belos::SolverManager< Scalar, MV_t, LO_t > > &	iterativeSolver,
		const RCP< const LinearOpSourceBase< Scalar > > &	fwdOpSrc,
		const RCP< const PreconditionerBase< Scalar > > &	prec,
		const bool	isExternalPrec,
		const RCP< const LinearOpSourceBase< Scalar > > &	approxFwdOpSrc,
		const ESupportSolveUse &	supportSolveUse,
		const int	convergenceTestFrequency )

Initializes given precreated solver objects.

Parameters

lp	[in] The linear problem that was used to initialize the iterative solver. The RHS and LHS arguments are set on this object to solve a linear system.
solverPL	[in] Parameter list that is used by the iterative solver.
iterativeSolver	[in] The iterative solver manager that will be used to solve for linear systems. This has links to lp, solverPL already embedded.
fwdOpSrc	[in] The source for the forward operator object defining the linear system. This object is not used here, it is just being "remembered" so that it can be extracted by BelosLinearOpWithSolveFactory::unitializeOp().
prec	[in] The preconditioner object that was used to get the preconditioners set in *lp This object is not used here, it is just being "remembered" so that it can be extracted by BelosLinearOpWithSolveFactory::unitializeOp().
isExternalPrec	[in] Determines if the preconditioner was set by an external client or was created internally by the BelosLinearOpWithSolveFactory object. This is not used here, it is just being "remembered" so that it can be used in the logic for BelosLinearOpWithSolveFactory::unitializeOp().
approxFwdOpSrc	[in] The external approximate forward operator object that was used to create the internal preconditioner. This object is not used here, it is just being "remembered" so that it can be extracted by BelosLinearOpWithSolveFactory::unitializeOp().
supportSolveUse	[in] Argument passed to BelosLinearOpWithSolveFactory that is being remembered here to be passed back to BelosLinearOpWithSolveFactory::unitializeOp().

ToDo: Finish documentation!

Definition at line 133 of file Thyra_BelosLinearOpWithSolve_def.hpp.

◆ extract_fwdOpSrc()

template<class Scalar>

RCP< const LinearOpSourceBase< Scalar > > Thyra::BelosLinearOpWithSolve< Scalar >::extract_fwdOpSrc ( )

Definition at line 255 of file Thyra_BelosLinearOpWithSolve_def.hpp.

◆ extract_prec()

template<class Scalar>

RCP< const PreconditionerBase< Scalar > > Thyra::BelosLinearOpWithSolve< Scalar >::extract_prec ( )

Definition at line 266 of file Thyra_BelosLinearOpWithSolve_def.hpp.

◆ isExternalPrec()

template<class Scalar>

bool Thyra::BelosLinearOpWithSolve< Scalar >::isExternalPrec ( ) const

Definition at line 276 of file Thyra_BelosLinearOpWithSolve_def.hpp.

◆ extract_approxFwdOpSrc()

template<class Scalar>

RCP< const LinearOpSourceBase< Scalar > > Thyra::BelosLinearOpWithSolve< Scalar >::extract_approxFwdOpSrc ( )

Definition at line 284 of file Thyra_BelosLinearOpWithSolve_def.hpp.

◆ supportSolveUse()

template<class Scalar>

ESupportSolveUse Thyra::BelosLinearOpWithSolve< Scalar >::supportSolveUse ( ) const

Definition at line 294 of file Thyra_BelosLinearOpWithSolve_def.hpp.

◆ uninitialize()

template<class Scalar>

void Thyra::BelosLinearOpWithSolve< Scalar >::uninitialize	(	RCP< Belos::LinearProblem< Scalar, MV_t, LO_t > > *	lp = NULL,
		RCP< Teuchos::ParameterList > *	solverPL = NULL,
		RCP< Belos::SolverManager< Scalar, MV_t, LO_t > > *	iterativeSolver = NULL,
		RCP< const LinearOpSourceBase< Scalar > > *	fwdOpSrc = NULL,
		RCP< const PreconditionerBase< Scalar > > *	prec = NULL,
		bool *	isExternalPrec = NULL,
		RCP< const LinearOpSourceBase< Scalar > > *	approxFwdOpSrc = NULL,
		ESupportSolveUse *	supportSolveUse = NULL )

Uninitializes and returns stored quantities.

ToDo: Finish documentation!

Definition at line 301 of file Thyra_BelosLinearOpWithSolve_def.hpp.

◆ range()

template<class Scalar>

RCP< const VectorSpaceBase< Scalar > > Thyra::BelosLinearOpWithSolve< Scalar >::range ( ) const

Definition at line 337 of file Thyra_BelosLinearOpWithSolve_def.hpp.

◆ domain()

template<class Scalar>

RCP< const VectorSpaceBase< Scalar > > Thyra::BelosLinearOpWithSolve< Scalar >::domain ( ) const

Definition at line 347 of file Thyra_BelosLinearOpWithSolve_def.hpp.

◆ clone()

template<class Scalar>

RCP< const LinearOpBase< Scalar > > Thyra::BelosLinearOpWithSolve< Scalar >::clone ( ) const

Definition at line 357 of file Thyra_BelosLinearOpWithSolve_def.hpp.

◆ description()

template<class Scalar>

std::string Thyra::BelosLinearOpWithSolve< Scalar >::description ( ) const

Definition at line 367 of file Thyra_BelosLinearOpWithSolve_def.hpp.

◆ describe()

template<class Scalar>

void Thyra::BelosLinearOpWithSolve< Scalar >::describe	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verbLevel ) const

Definition at line 388 of file Thyra_BelosLinearOpWithSolve_def.hpp.

◆ setParameterList()

template<class Scalar>

void Thyra::BelosLinearOpWithSolve< Scalar >::setParameterList ( RCP< Teuchos::ParameterList > const & paramList )

◆ getNonconstParameterList()

template<class Scalar>

RCP< Teuchos::ParameterList > Thyra::BelosLinearOpWithSolve< Scalar >::getNonconstParameterList ( )

◆ unsetParameterList()

template<class Scalar>

RCP< Teuchos::ParameterList > Thyra::BelosLinearOpWithSolve< Scalar >::unsetParameterList ( )

◆ getParameterList()

template<class Scalar>

RCP< const Teuchos::ParameterList > Thyra::BelosLinearOpWithSolve< Scalar >::getParameterList ( ) const

◆ getValidParameters()

template<class Scalar>

RCP< const Teuchos::ParameterList > Thyra::BelosLinearOpWithSolve< Scalar >::getValidParameters ( ) const

◆ opSupportedImpl()

template<class Scalar>

bool Thyra::BelosLinearOpWithSolve< Scalar >::opSupportedImpl ( EOpTransp M_trans ) const

protectedvirtual

Definition at line 436 of file Thyra_BelosLinearOpWithSolve_def.hpp.

◆ applyImpl()

template<class Scalar>

void Thyra::BelosLinearOpWithSolve< Scalar >::applyImpl	(	const EOpTransp	M_trans,
		const MultiVectorBase< Scalar > &	X,
		const Ptr< MultiVectorBase< Scalar > > &	Y,
		const Scalar	alpha,
		const Scalar	beta ) const

protectedvirtual

Definition at line 443 of file Thyra_BelosLinearOpWithSolve_def.hpp.

◆ solveSupportsImpl()

template<class Scalar>

bool Thyra::BelosLinearOpWithSolve< Scalar >::solveSupportsImpl ( EOpTransp M_trans ) const

protectedvirtual

Definition at line 460 of file Thyra_BelosLinearOpWithSolve_def.hpp.

◆ solveSupportsNewImpl()

template<class Scalar>

bool Thyra::BelosLinearOpWithSolve< Scalar >::solveSupportsNewImpl	(	EOpTransp	transp,
		const Ptr< const SolveCriteria< Scalar > >	solveCriteria ) const

protectedvirtual

Definition at line 468 of file Thyra_BelosLinearOpWithSolve_def.hpp.

◆ solveSupportsSolveMeasureTypeImpl()

template<class Scalar>

bool Thyra::BelosLinearOpWithSolve< Scalar >::solveSupportsSolveMeasureTypeImpl	(	EOpTransp	M_trans,
		const SolveMeasureType &	solveMeasureType ) const

protectedvirtual

Definition at line 492 of file Thyra_BelosLinearOpWithSolve_def.hpp.

◆ solveImpl()

template<class Scalar>

SolveStatus< Scalar > Thyra::BelosLinearOpWithSolve< Scalar >::solveImpl	(	const EOpTransp	transp,
		const MultiVectorBase< Scalar > &	B,
		const Ptr< MultiVectorBase< Scalar > > &	X,
		const Ptr< const SolveCriteria< Scalar > >	solveCriteria ) const

protectedvirtual

Definition at line 502 of file Thyra_BelosLinearOpWithSolve_def.hpp.

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

Public typedefs

Overridden from LinearOpWithSolveBase.

Constructors/initializers/accessors

Overridden from LinearOpBase

Overridden from Teuchos::Describable

Overridden from ParameterListAcceptor

Detailed Description

Member Typedef Documentation

◆ MV_t

◆ LO_t

Constructor & Destructor Documentation

◆ BelosLinearOpWithSolve()

Member Function Documentation

◆ initialize()

◆ extract_fwdOpSrc()

◆ extract_prec()

◆ isExternalPrec()

◆ extract_approxFwdOpSrc()

◆ supportSolveUse()

◆ uninitialize()

◆ range()

◆ domain()

◆ clone()

◆ description()

◆ describe()

◆ setParameterList()

◆ getNonconstParameterList()

◆ unsetParameterList()

◆ getParameterList()

◆ getValidParameters()

◆ opSupportedImpl()

◆ applyImpl()

◆ solveSupportsImpl()

◆ solveSupportsNewImpl()

◆ solveSupportsSolveMeasureTypeImpl()

◆ solveImpl()