Concreate LinearOpWithSolveFactoryBase subclass that creates DefaultSerialDenseLinearOpWithSolve objects that use LAPACK. More...

#include <Thyra_DefaultSerialDenseLinearOpWithSolveFactory_decl.hpp>

Inheritance diagram for Thyra::DefaultSerialDenseLinearOpWithSolveFactory< Scalar >:

[legend]

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

Overridden from LinearOpWithSolveFactoyBase
virtual bool	acceptsPreconditionerFactory () const
	returns false.
virtual void	setPreconditionerFactory (const RCP< PreconditionerFactoryBase< Scalar > > &precFactory, const std::string &precFactoryName)
	Throws exception.
virtual RCP< PreconditionerFactoryBase< Scalar > >	getPreconditionerFactory () const
	Returns null .
virtual void	unsetPreconditionerFactory (RCP< PreconditionerFactoryBase< Scalar > > precFactory, std::string precFactoryName)
	Throws exception.
virtual bool	isCompatible (const LinearOpSourceBase< Scalar > &fwdOpSrc) const
virtual RCP< LinearOpWithSolveBase< Scalar > >	createOp () const
	Returns a DefaultSerialDenseLinearOpWithSolve object .
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

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::DefaultSerialDenseLinearOpWithSolveFactory< Scalar >

Concreate LinearOpWithSolveFactoryBase subclass that creates DefaultSerialDenseLinearOpWithSolve objects that use LAPACK.

This class will work with any serial MultiVectorBase object for which there are BLAS and LAPACK wrappers in Teuchos for.

Definition at line 28 of file Thyra_DefaultSerialDenseLinearOpWithSolveFactory_decl.hpp.

Member Function Documentation

◆ setParameterList()

template<class Scalar>

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

virtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 28 of file Thyra_DefaultSerialDenseLinearOpWithSolveFactory_def.hpp.

◆ getValidParameters()

template<class Scalar>

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

virtual

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 39 of file Thyra_DefaultSerialDenseLinearOpWithSolveFactory_def.hpp.

◆ acceptsPreconditionerFactory()

template<class Scalar>

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

virtual

returns false.

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 50 of file Thyra_DefaultSerialDenseLinearOpWithSolveFactory_def.hpp.

◆ setPreconditionerFactory()

template<class Scalar>

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

virtual

Throws exception.

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 57 of file Thyra_DefaultSerialDenseLinearOpWithSolveFactory_def.hpp.

◆ getPreconditionerFactory()

template<class Scalar>

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

virtual

Returns null .

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 68 of file Thyra_DefaultSerialDenseLinearOpWithSolveFactory_def.hpp.

◆ unsetPreconditionerFactory()

template<class Scalar>

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

virtual

Throws exception.

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 75 of file Thyra_DefaultSerialDenseLinearOpWithSolveFactory_def.hpp.

◆ isCompatible()

template<class Scalar>

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

virtual

Implements Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 85 of file Thyra_DefaultSerialDenseLinearOpWithSolveFactory_def.hpp.

◆ createOp()

template<class Scalar>

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

virtual

Returns a DefaultSerialDenseLinearOpWithSolve object .

Implements Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 96 of file Thyra_DefaultSerialDenseLinearOpWithSolveFactory_def.hpp.

◆ initializeOp()

template<class Scalar>

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

virtual

Implements Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 103 of file Thyra_DefaultSerialDenseLinearOpWithSolveFactory_def.hpp.

◆ initializeAndReuseOp()

template<class Scalar>

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

virtual

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 132 of file Thyra_DefaultSerialDenseLinearOpWithSolveFactory_def.hpp.

◆ uninitializeOp()

template<class Scalar>

void Thyra::DefaultSerialDenseLinearOpWithSolveFactory< 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 142 of file Thyra_DefaultSerialDenseLinearOpWithSolveFactory_def.hpp.

◆ supportsPreconditionerInputType()

template<class Scalar>

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

virtual

Reimplemented from Thyra::LinearOpWithSolveFactoryBase< Scalar >.

Definition at line 173 of file Thyra_DefaultSerialDenseLinearOpWithSolveFactory_def.hpp.

◆ initializePreconditionedOp()

template<class Scalar>

void Thyra::DefaultSerialDenseLinearOpWithSolveFactory< 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 183 of file Thyra_DefaultSerialDenseLinearOpWithSolveFactory_def.hpp.

◆ initializeApproxPreconditionedOp()

template<class Scalar>

void Thyra::DefaultSerialDenseLinearOpWithSolveFactory< 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 195 of file Thyra_DefaultSerialDenseLinearOpWithSolveFactory_def.hpp.

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

Overridden from ParameterListAcceptor (simple forwarding functions)

Overridden from LinearOpWithSolveFactoyBase

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ setParameterList()

◆ getValidParameters()

◆ acceptsPreconditionerFactory()

◆ setPreconditionerFactory()

◆ getPreconditionerFactory()

◆ unsetPreconditionerFactory()

◆ isCompatible()

◆ createOp()

◆ initializeOp()

◆ initializeAndReuseOp()

◆ uninitializeOp()

◆ supportsPreconditionerInputType()

◆ initializePreconditionedOp()

◆ initializeApproxPreconditionedOp()