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

#include <Thyra_DelayedLinearOpWithSolve_decl.hpp>

Inheritance diagram for Thyra::DelayedLinearOpWithSolve< Scalar >:

Related Functions
(Note that these are not member functions.)
template<class Scalar >
RCP< DelayedLinearOpWithSolve < Scalar > >	delayedLinearOpWithSolve ()
	Nonmember constuctor. More...

template<class Scalar >
RCP< DelayedLinearOpWithSolve < Scalar > >	delayedLinearOpWithSolve (const RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, const RCP< LinearOpWithSolveFactoryBase< Scalar > > &lowsf)
	Nonmember constuctor. More...

Related Functions inherited from Thyra::LinearOpWithSolveBase< Scalar >
template<class Scalar >
bool	solveSupports (const LinearOpWithSolveBase< Scalar > &A, const EOpTransp transp)
	Call `solveSupports()` as a non-member function. More...

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. More...

template<class Scalar >
bool	solveSupportsSolveMeasureType (const LinearOpWithSolveBase< Scalar > &A, const EOpTransp transp, const SolveMeasureType &solveMeasureType)
	Call `solveSupportsSolveMeasureType()` as a non-member function. More...

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. More...

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. More...

Related Functions 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. More...

template<class Scalar >
bool	isPartiallyInitialized (const LinearOpBase< Scalar > &M)
	Determines if a linear operator is in the "Partially Initialized" state or not. More...

template<class Scalar >
bool	isFullyInitialized (const LinearOpBase< Scalar > &M)
	Determines if a linear operator is in the "Fully Initialized" state or not. More...

template<class Scalar >
bool	opSupported (const LinearOpBase< Scalar > &M, EOpTransp M_trans)
	Determines if an operation is supported for a single scalar type. More...

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(...)`. More...

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>(...)`. More...

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

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

void	informUpdatedVerbosityState () const
	Overridden from Teuchos::VerboseObjectBase. More...

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

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

template<class Scalar >

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

Definition at line 28 of file Thyra_DelayedLinearOpWithSolve_def.hpp.

Member Function Documentation

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.

template<class Scalar >

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

Definition at line 59 of file Thyra_DelayedLinearOpWithSolve_def.hpp.

template<class Scalar >

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

Definition at line 67 of file Thyra_DelayedLinearOpWithSolve_def.hpp.

template<class Scalar >

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

Definition at line 75 of file Thyra_DelayedLinearOpWithSolve_def.hpp.

template<class Scalar >

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

Definition at line 83 of file Thyra_DelayedLinearOpWithSolve_def.hpp.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

Friends And Related Function Documentation

template<class Scalar >

RCP< DelayedLinearOpWithSolve< Scalar > > delayedLinearOpWithSolve ( )

Definition at line 154 of file Thyra_DelayedLinearOpWithSolve_decl.hpp.

template<class Scalar >

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

Definition at line 166 of file Thyra_DelayedLinearOpWithSolve_decl.hpp.

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

Related Functions

Constructor/Initializers

Overridden from Teuchos::Describable.

Overridden from LinearOpBase

Overridden from LinearOpWithSolveBase.

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

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