Delayed linear solver construction LinearOpWithSolveBase decorator class. More...

#include <Thyra_DelayedLinearOpWithSolve_decl.hpp>

Inheritance diagram for Thyra::DelayedLinearOpWithSolve< Scalar >:

[legend]

Related Symbols
(Note that these are not member symbols.)
template<class Scalar>
RCP< DelayedLinearOpWithSolve< Scalar > >	delayedLinearOpWithSolve ()
	Nonmember constuctor.
template<class Scalar>
RCP< DelayedLinearOpWithSolve< Scalar > >	delayedLinearOpWithSolve (const RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, const RCP< LinearOpWithSolveFactoryBase< Scalar > > &lowsf)
	Nonmember constuctor.
Related Symbols inherited from Thyra::LinearOpWithSolveBase< Scalar >
template<class Scalar>
bool	solveSupports (const LinearOpWithSolveBase< Scalar > &A, const EOpTransp transp)
	Call solveSupports() as a non-member function.
template<class Scalar>
bool	solveSupports (const LinearOpWithSolveBase< Scalar > &A, const EOpTransp transp, const Ptr< const SolveCriteria< Scalar > > solveCriteria)
	Call solveSupports() as a non-member function.
template<class Scalar>
bool	solveSupportsSolveMeasureType (const LinearOpWithSolveBase< Scalar > &A, const EOpTransp transp, const SolveMeasureType &solveMeasureType)
	Call solveSupportsSolveMeasureType() as a non-member function.
template<class Scalar>
SolveStatus< Scalar >	solve (const LinearOpWithSolveBase< Scalar > &A, const EOpTransp A_trans, const MultiVectorBase< Scalar > &B, const Ptr< MultiVectorBase< Scalar > > &X, const Ptr< const SolveCriteria< Scalar > > solveCriteria=Teuchos::null)
	Call solve() as a non-member function.
template<class Scalar>
void	assertSolveSupports (const LinearOpWithSolveBase< Scalar > &lows, const EOpTransp M_trans, const Ptr< const SolveCriteria< Scalar > > solveCriteria=Teuchos::null)
	Assert that a LOWSB object supports a particular solve type.
Related Symbols inherited from Thyra::LinearOpBase< Scalar >
template<class Scalar>
bool	isFullyUninitialized (const LinearOpBase< Scalar > &M)
	Determines if a linear operator is in the "Fully Uninitialized" state or not.
template<class Scalar>
bool	isPartiallyInitialized (const LinearOpBase< Scalar > &M)
	Determines if a linear operator is in the "Partially Initialized" state or not.
template<class Scalar>
bool	isFullyInitialized (const LinearOpBase< Scalar > &M)
	Determines if a linear operator is in the "Fully Initialized" state or not.
template<class Scalar>
bool	opSupported (const LinearOpBase< Scalar > &M, EOpTransp M_trans)
	Determines if an operation is supported for a single scalar type.
template<class Scalar>
void	apply (const LinearOpBase< Scalar > &M, const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< Scalar > > &Y, const Scalar alpha=static_cast< Scalar >(1.0), const Scalar beta=static_cast< Scalar >(0.0))
	Non-member function call for M.apply(...).
void	apply (const LinearOpBase< double > &M, const EOpTransp M_trans, const MultiVectorBase< double > &X, const Ptr< MultiVectorBase< double > > &Y, const double alpha=1.0, const double beta=0.0)
	Calls apply<double>(...).

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

Constructor/Initializers
	DelayedLinearOpWithSolve ()
void	initialize (const RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, const RCP< const PreconditionerBase< Scalar > > &prec, const RCP< const LinearOpSourceBase< Scalar > > &approxFwdOpSrc, const ESupportSolveUse supportSolveUse, const RCP< LinearOpWithSolveFactoryBase< Scalar > > &lowsf)
RCP< const LinearOpSourceBase< Scalar > >	getFwdOpSrc () const
RCP< const PreconditionerBase< Scalar > >	getPrec () const
RCP< const LinearOpSourceBase< Scalar > >	getApproxFwdOpSrc () const
ESupportSolveUse	getSupportSolveUse () const

Overridden from Teuchos::Describable.
std::string	description () const

Overridden from LinearOpBase
RCP< const VectorSpaceBase< Scalar > >	range () const
RCP< const VectorSpaceBase< Scalar > >	domain () const
RCP< const LinearOpBase< Scalar > >	clone () const
void	informUpdatedVerbosityState () const
	Overridden from Teuchos::VerboseObjectBase.
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

Additional Inherited Members
bool	solveSupports (EOpTransp transp) const
	Return if solve() supports the argument transp.
bool	solveSupports (EOpTransp transp, const Ptr< const SolveCriteria< Scalar > > solveCriteria) const
	Return if solve() supports a given transpose and solve criteria specification.
bool	solveSupportsSolveMeasureType (EOpTransp transp, const SolveMeasureType &solveMeasureType) const
	Return if solve() supports the given the solve measure type.
SolveStatus< Scalar >	solve (const EOpTransp A_trans, const MultiVectorBase< Scalar > &B, const Ptr< MultiVectorBase< Scalar > > &X, const Ptr< const SolveCriteria< Scalar > > solveCriteria=Teuchos::null) const
	Request the solution of a block linear system.
bool	opSupported (EOpTransp M_trans) const
	Return if the M_trans operation of apply() is supported or not.
void	apply (const EOpTransp M_trans, const MultiVectorBase< Scalar > &X, const Ptr< MultiVectorBase< Scalar > > &Y, const Scalar alpha, const Scalar beta) const
	Apply the linear operator to a multi-vector : Y = alphaop(M)X + beta*Y.
virtual bool	solveSupportsNewImpl (EOpTransp, const Ptr< const SolveCriteria< Scalar > >) const
	Virtual implementation of solveSupports().

Detailed Description

template<class Scalar>
class Thyra::DelayedLinearOpWithSolve< Scalar >

Delayed linear solver construction LinearOpWithSolveBase decorator class.

This simple class takes a LinearOpWithSolveFactoryBase object and the arguments for a call to LinearOpWithSolveBase::initializeOp() (or one of its related functions) and then waits until a solve is called before it constructs the preconditioner.

This class should never be created directly by a client. Instead, it should be created by a DelayedLinearOpWithSolveFactory object.

Definition at line 33 of file Thyra_DelayedLinearOpWithSolve_decl.hpp.

Constructor & Destructor Documentation

◆ DelayedLinearOpWithSolve()

template<class Scalar>

Thyra::DelayedLinearOpWithSolve< Scalar >::DelayedLinearOpWithSolve ( )

Definition at line 28 of file Thyra_DelayedLinearOpWithSolve_def.hpp.

Member Function Documentation

◆ initialize()

template<class Scalar>

void Thyra::DelayedLinearOpWithSolve< Scalar >::initialize	(	const RCP< const LinearOpSourceBase< Scalar > > &	fwdOpSrc,
		const RCP< const PreconditionerBase< Scalar > > &	prec,
		const RCP< const LinearOpSourceBase< Scalar > > &	approxFwdOpSrc,
		const ESupportSolveUse	supportSolveUse,
		const RCP< LinearOpWithSolveFactoryBase< Scalar > > &	lowsf )

Definition at line 34 of file Thyra_DelayedLinearOpWithSolve_def.hpp.

◆ getFwdOpSrc()

template<class Scalar>

RCP< const LinearOpSourceBase< Scalar > > Thyra::DelayedLinearOpWithSolve< Scalar >::getFwdOpSrc ( ) const

Definition at line 59 of file Thyra_DelayedLinearOpWithSolve_def.hpp.

◆ getPrec()

template<class Scalar>

RCP< const PreconditionerBase< Scalar > > Thyra::DelayedLinearOpWithSolve< Scalar >::getPrec ( ) const

Definition at line 67 of file Thyra_DelayedLinearOpWithSolve_def.hpp.

◆ getApproxFwdOpSrc()

template<class Scalar>

RCP< const LinearOpSourceBase< Scalar > > Thyra::DelayedLinearOpWithSolve< Scalar >::getApproxFwdOpSrc ( ) const

Definition at line 75 of file Thyra_DelayedLinearOpWithSolve_def.hpp.

◆ getSupportSolveUse()

template<class Scalar>

ESupportSolveUse Thyra::DelayedLinearOpWithSolve< Scalar >::getSupportSolveUse ( ) const

Definition at line 83 of file Thyra_DelayedLinearOpWithSolve_def.hpp.

◆ description()

template<class Scalar>

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

virtual

Reimplemented from Teuchos::Describable.

Definition at line 93 of file Thyra_DelayedLinearOpWithSolve_def.hpp.

◆ range()

template<class Scalar>

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

virtual

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 118 of file Thyra_DelayedLinearOpWithSolve_def.hpp.

◆ domain()

template<class Scalar>

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

virtual

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 128 of file Thyra_DelayedLinearOpWithSolve_def.hpp.

◆ clone()

template<class Scalar>

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

virtual

Reimplemented from Thyra::LinearOpBase< Scalar >.

Definition at line 138 of file Thyra_DelayedLinearOpWithSolve_def.hpp.

◆ informUpdatedVerbosityState()

template<class Scalar>

void Thyra::DelayedLinearOpWithSolve< Scalar >::informUpdatedVerbosityState ( ) const

protectedvirtual

Overridden from Teuchos::VerboseObjectBase.

Reimplemented from Teuchos::VerboseObjectBase.

Definition at line 148 of file Thyra_DelayedLinearOpWithSolve_def.hpp.

◆ opSupportedImpl()

template<class Scalar>

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

protectedvirtual

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 165 of file Thyra_DelayedLinearOpWithSolve_def.hpp.

◆ applyImpl()

template<class Scalar>

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

protectedvirtual

Implements Thyra::LinearOpBase< Scalar >.

Definition at line 172 of file Thyra_DelayedLinearOpWithSolve_def.hpp.

◆ solveSupportsImpl()

template<class Scalar>

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

protectedvirtual

Reimplemented from Thyra::LinearOpWithSolveBase< Scalar >.

Definition at line 188 of file Thyra_DelayedLinearOpWithSolve_def.hpp.

◆ solveSupportsSolveMeasureTypeImpl()

template<class Scalar>

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

protectedvirtual

Reimplemented from Thyra::LinearOpWithSolveBase< Scalar >.

Definition at line 196 of file Thyra_DelayedLinearOpWithSolve_def.hpp.

◆ solveImpl()

template<class Scalar>

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

protectedvirtual

Implements Thyra::LinearOpWithSolveBase< Scalar >.

Definition at line 207 of file Thyra_DelayedLinearOpWithSolve_def.hpp.

◆ delayedLinearOpWithSolve() [1/2]

template<class Scalar>

RCP< DelayedLinearOpWithSolve< Scalar > > delayedLinearOpWithSolve ( )

Nonmember constuctor.

Definition at line 154 of file Thyra_DelayedLinearOpWithSolve_decl.hpp.

◆ delayedLinearOpWithSolve() [2/2]

template<class Scalar>

RCP< DelayedLinearOpWithSolve< Scalar > > delayedLinearOpWithSolve	(	const RCP< const LinearOpSourceBase< Scalar > > &	fwdOpSrc,
		const RCP< LinearOpWithSolveFactoryBase< Scalar > > &	lowsf )

Nonmember constuctor.

Definition at line 166 of file Thyra_DelayedLinearOpWithSolve_decl.hpp.

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

Related Symbols

Overridden from LinearOpWithSolveBase.

Constructor/Initializers

Overridden from Teuchos::Describable.

Overridden from LinearOpBase

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DelayedLinearOpWithSolve()

Member Function Documentation

◆ initialize()

◆ getFwdOpSrc()

◆ getPrec()

◆ getApproxFwdOpSrc()

◆ getSupportSolveUse()

◆ description()

◆ range()

◆ domain()

◆ clone()

◆ informUpdatedVerbosityState()

◆ opSupportedImpl()

◆ applyImpl()

◆ solveSupportsImpl()

◆ solveSupportsSolveMeasureTypeImpl()

◆ solveImpl()

Friends And Related Symbol Documentation

◆ delayedLinearOpWithSolve() [1/2]

◆ delayedLinearOpWithSolve() [2/2]