General delayed construction LinearOpWithSolveFactoryBase subclass. More...

#include <Thyra_DelayedLinearOpWithSolveFactory_decl.hpp>

Inheritance diagram for Thyra::DelayedLinearOpWithSolveFactory< Scalar >:

[legend]

Overridden from LinearOpWithSolveFactoyBase
virtual bool	acceptsPreconditionerFactory () const
virtual void	setPreconditionerFactory (const RCP< PreconditionerFactoryBase< Scalar > > &precFactory, const std::string &precFactoryName)
virtual RCP< PreconditionerFactoryBase< Scalar > >	getPreconditionerFactory () const
virtual void	unsetPreconditionerFactory (RCP< PreconditionerFactoryBase< Scalar > > precFactory, std::string precFactoryName)
virtual bool	isCompatible (const LinearOpSourceBase< Scalar > &fwdOpSrc) const
virtual RCP< LinearOpWithSolveBase< Scalar > >	createOp () const
virtual void	initializeOp (const RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, LinearOpWithSolveBase< Scalar > *Op, const ESupportSolveUse supportSolveUse) const
virtual void	initializeAndReuseOp (const RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, LinearOpWithSolveBase< Scalar > *Op) const
virtual void	uninitializeOp (LinearOpWithSolveBase< Scalar > Op, RCP< const LinearOpSourceBase< Scalar > > fwdOpSrc, RCP< const PreconditionerBase< Scalar > > prec, RCP< const LinearOpSourceBase< Scalar > > approxFwdOpSrc, ESupportSolveUse *supportSolveUse) const
virtual bool	supportsPreconditionerInputType (const EPreconditionerInputType precOpType) const
virtual void	initializePreconditionedOp (const RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, const RCP< const PreconditionerBase< Scalar > > &prec, LinearOpWithSolveBase< Scalar > *Op, const ESupportSolveUse supportSolveUse) const
virtual void	initializeApproxPreconditionedOp (const RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, const RCP< const LinearOpSourceBase< Scalar > > &approxFwdOpSrc, LinearOpWithSolveBase< Scalar > *Op, const ESupportSolveUse supportSolveUse) const
void	informUpdatedVerbosityState () const
	Overridden from Teuchos::VerboseObjectBase.

Overridden from Constructors/Initializers/Accessors
	DelayedLinearOpWithSolveFactory (const RCP< LinearOpWithSolveFactoryBase< Scalar > > &lowsf)
RCP< LinearOpWithSolveFactoryBase< Scalar > >	getUnderlyingLOWSF ()
RCP< const LinearOpWithSolveFactoryBase< Scalar > >	getUnderlyingLOWSF () const

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

Overridden from ParameterListAcceptor (simple forwarding functions)
void	setParameterList (RCP< ParameterList > const &paramList)
RCP< ParameterList >	getNonconstParameterList ()
RCP< ParameterList >	unsetParameterList ()
RCP< const ParameterList >	getParameterList () const
RCP< const ParameterList >	getValidParameters () const

Additional Inherited Members
Related Symbols inherited from Thyra::LinearOpWithSolveFactoryBase< Scalar >
template<class Scalar>
bool	isCompatible (const LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, const LinearOpBase< Scalar > &fwdOp)
	Return if the forward operator is a compatible source for a LOWSFB object.
template<class Scalar>
void	setDefaultObjectLabel (const LinearOpBase< Scalar > &fwdOp, const Ptr< LinearOpWithSolveBase< Scalar > > &Op)
	Set default label on a LOWSB object.
template<class Scalar>
void	initializeOp (const LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, const RCP< const LinearOpBase< Scalar > > &fwdOp, const Ptr< LinearOpWithSolveBase< Scalar > > &Op, const ESupportSolveUse supportSolveUse=SUPPORT_SOLVE_UNSPECIFIED)
	Initialize a pre-created LOWSB object given a forward operator.
template<class Scalar>
void	initializeAndReuseOp (const LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, const RCP< const LinearOpBase< Scalar > > &fwdOp, const Ptr< LinearOpWithSolveBase< Scalar > > &Op)
	Reinitialize a pre-created LOWSB object given a forward operator, reusing a much as possible from the prior LOWSB object.
template<class Scalar>
void	initializePreconditionedOp (const LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, const RCP< const LinearOpBase< Scalar > > &fwdOp, const RCP< const PreconditionerBase< Scalar > > &prec, const Ptr< LinearOpWithSolveBase< Scalar > > &Op, const ESupportSolveUse supportSolveUse=SUPPORT_SOLVE_UNSPECIFIED)
	Initialize a preconditioned LOWSB object given an external preconditioner.
template<class Scalar>
void	initializeApproxPreconditionedOp (const LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, const RCP< const LinearOpBase< Scalar > > &fwdOp, const RCP< const LinearOpBase< Scalar > > &approxFwdOp, const Ptr< LinearOpWithSolveBase< Scalar > > &Op, const ESupportSolveUse supportSolveUse=SUPPORT_SOLVE_UNSPECIFIED)
	Initialize a preconditioned LOWSB object given an external operator to be used to generate the preconditioner internally.
template<class Scalar>
RCP< LinearOpWithSolveBase< Scalar > >	linearOpWithSolve (const LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, const RCP< const LinearOpBase< Scalar > > &fwdOp, const ESupportSolveUse supportSolveUse=SUPPORT_SOLVE_UNSPECIFIED)
	Create and initialize a LinearOpWithSolveBase object from a LinearOpBase object using a LinearOpWithSolveFactoryBase strategy object.
template<class Scalar>
RCP< LinearOpBase< Scalar > >	inverse (const LinearOpWithSolveFactoryBase< Scalar > &LOWSF, const RCP< const LinearOpBase< Scalar > > &fwdOp, const ESupportSolveUse supportSolveUse=SUPPORT_SOLVE_UNSPECIFIED, const Ptr< const SolveCriteria< Scalar > > &fwdSolveCriteria=Teuchos::null, const EThrowOnSolveFailure throwOnFwdSolveFailure=THROW_ON_SOLVE_FAILURE, const Ptr< const SolveCriteria< Scalar > > &adjSolveCriteria=Teuchos::null, const EThrowOnSolveFailure throwOnAdjSolveFailure=THROW_ON_SOLVE_FAILURE)
	Form a const implicit inverse operator M = inv(A) given a factory.
template<class Scalar>
void	uninitializeOp (const LinearOpWithSolveFactoryBase< Scalar > &lowsFactory, const Ptr< LinearOpWithSolveBase< Scalar > > &Op, const Ptr< RCP< const LinearOpBase< Scalar > > > &fwdOp=Teuchos::null, const Ptr< RCP< const PreconditionerBase< Scalar > > > &prec=Teuchos::null, const Ptr< RCP< const LinearOpBase< Scalar > > > &approxFwdOp=Teuchos::null, const Ptr< ESupportSolveUse > &supportSolveUse=Teuchos::null)
	Uninitialized a pre-created LOWSB object, returning input objects used to initialize it.

Detailed Description

template<class Scalar>
class Thyra::DelayedLinearOpWithSolveFactory< Scalar >

General delayed construction LinearOpWithSolveFactoryBase subclass.

This simple decorator class allows for the delayed construction of the linear solver until the last possible moment when the linear solver is needed. This class creates LinearOpWithSolveBase objects of type DelayedLinearOpWithSolve. The class object DelayedLinearOpWithSolve actually implements the delayed linear solver construction.

Definition at line 30 of file Thyra_DelayedLinearOpWithSolveFactory_decl.hpp.

Constructor & Destructor Documentation

◆ DelayedLinearOpWithSolveFactory()

template<class Scalar>

Thyra::DelayedLinearOpWithSolveFactory< Scalar >::DelayedLinearOpWithSolveFactory ( const RCP< LinearOpWithSolveFactoryBase< Scalar > > & lowsf )

Definition at line 26 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

Member Function Documentation

◆ getUnderlyingLOWSF() [1/2]

template<class Scalar>

RCP< LinearOpWithSolveFactoryBase< Scalar > > Thyra::DelayedLinearOpWithSolveFactory< Scalar >::getUnderlyingLOWSF ( )

Definition at line 38 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

◆ getUnderlyingLOWSF() [2/2]

template<class Scalar>

RCP< const LinearOpWithSolveFactoryBase< Scalar > > Thyra::DelayedLinearOpWithSolveFactory< Scalar >::getUnderlyingLOWSF ( ) const

Definition at line 46 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

◆ description()

template<class Scalar>

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

virtual

Reimplemented from Teuchos::Describable.

Definition at line 56 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

◆ setParameterList()

template<class Scalar>

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

virtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 75 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

◆ getNonconstParameterList()

template<class Scalar>

RCP< ParameterList > Thyra::DelayedLinearOpWithSolveFactory< Scalar >::getNonconstParameterList ( )

virtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 85 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

◆ unsetParameterList()

template<class Scalar>

RCP< ParameterList > Thyra::DelayedLinearOpWithSolveFactory< Scalar >::unsetParameterList ( )

virtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 93 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

◆ getParameterList()

template<class Scalar>

RCP< const ParameterList > Thyra::DelayedLinearOpWithSolveFactory< Scalar >::getParameterList ( ) const

virtual

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 101 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

◆ getValidParameters()

template<class Scalar>

RCP< const ParameterList > Thyra::DelayedLinearOpWithSolveFactory< Scalar >::getValidParameters ( ) const

virtual

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 109 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

◆ acceptsPreconditionerFactory()

template<class Scalar>

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

virtual

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 119 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

◆ setPreconditionerFactory()

template<class Scalar>

void Thyra::DelayedLinearOpWithSolveFactory< Scalar >::setPreconditionerFactory	(	const RCP< PreconditionerFactoryBase< Scalar > > &	precFactory,
		const std::string &	precFactoryName )

virtual

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 126 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

◆ getPreconditionerFactory()

template<class Scalar>

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

virtual

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 137 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

◆ unsetPreconditionerFactory()

template<class Scalar>

void Thyra::DelayedLinearOpWithSolveFactory< Scalar >::unsetPreconditionerFactory	(	RCP< PreconditionerFactoryBase< Scalar > > *	precFactory,
		std::string *	precFactoryName )

virtual

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 144 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

◆ isCompatible()

template<class Scalar>

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

virtual

Implements Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 154 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

◆ createOp()

template<class Scalar>

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

virtual

Implements Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 164 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

◆ initializeOp()

template<class Scalar>

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

virtual

Implements Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 175 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

◆ initializeAndReuseOp()

template<class Scalar>

void Thyra::DelayedLinearOpWithSolveFactory< Scalar >::initializeAndReuseOp	(	const RCP< const LinearOpSourceBase< Scalar > > &	fwdOpSrc,
		LinearOpWithSolveBase< Scalar > *	Op ) const

virtual

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 193 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

◆ uninitializeOp()

template<class Scalar>

void Thyra::DelayedLinearOpWithSolveFactory< Scalar >::uninitializeOp	(	LinearOpWithSolveBase< Scalar > *	Op,
		RCP< const LinearOpSourceBase< Scalar > > *	fwdOpSrc,
		RCP< const PreconditionerBase< Scalar > > *	prec,
		RCP< const LinearOpSourceBase< Scalar > > *	approxFwdOpSrc,
		ESupportSolveUse *	supportSolveUse ) const

virtual

Implements Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 203 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

◆ supportsPreconditionerInputType()

template<class Scalar>

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

virtual

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 236 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

◆ initializePreconditionedOp()

template<class Scalar>

void Thyra::DelayedLinearOpWithSolveFactory< Scalar >::initializePreconditionedOp	(	const RCP< const LinearOpSourceBase< Scalar > > &	fwdOpSrc,
		const RCP< const PreconditionerBase< Scalar > > &	prec,
		LinearOpWithSolveBase< Scalar > *	Op,
		const ESupportSolveUse	supportSolveUse ) const

virtual

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 245 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

◆ initializeApproxPreconditionedOp()

template<class Scalar>

void Thyra::DelayedLinearOpWithSolveFactory< Scalar >::initializeApproxPreconditionedOp	(	const RCP< const LinearOpSourceBase< Scalar > > &	fwdOpSrc,
		const RCP< const LinearOpSourceBase< Scalar > > &	approxFwdOpSrc,
		LinearOpWithSolveBase< Scalar > *	Op,
		const ESupportSolveUse	supportSolveUse ) const

virtual

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 264 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

◆ informUpdatedVerbosityState()

template<class Scalar>

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

protectedvirtual

Overridden from Teuchos::VerboseObjectBase.

Reimplemented from Teuchos::VerboseObjectBase.

Definition at line 286 of file Thyra_DelayedLinearOpWithSolveFactory_def.hpp.

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

Overridden from LinearOpWithSolveFactoyBase

Overridden from Constructors/Initializers/Accessors

Overridden from Teuchos::Describable.

Overridden from ParameterListAcceptor (simple forwarding functions)

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DelayedLinearOpWithSolveFactory()

Member Function Documentation

◆ getUnderlyingLOWSF() [1/2]

◆ getUnderlyingLOWSF() [2/2]

◆ description()

◆ setParameterList()

◆ getNonconstParameterList()

◆ unsetParameterList()

◆ getParameterList()

◆ getValidParameters()

◆ acceptsPreconditionerFactory()

◆ setPreconditionerFactory()

◆ getPreconditionerFactory()

◆ unsetPreconditionerFactory()

◆ isCompatible()

◆ createOp()

◆ initializeOp()

◆ initializeAndReuseOp()

◆ uninitializeOp()

◆ supportsPreconditionerInputType()

◆ initializePreconditionedOp()

◆ initializeApproxPreconditionedOp()

◆ informUpdatedVerbosityState()