Concrete PreconditionerFactoryBase subclass that just returns an already created/initialized preconditioner object. More...

#include <Thyra_ReusePreconditionerFactory.hpp>

Inheritance diagram for Thyra::ReusePreconditionerFactory< Scalar >:

Public Member Functions
Constructors/initializers/accessors
	ReusePreconditionerFactory ()
	Construct to uninitialized. More...

void	initialize (const RCP< PreconditionerBase< Scalar > > &prec)

RCP< PreconditionerBase< Scalar > >	getNonconstPreconditioner ()

RCP< const PreconditionerBase< Scalar > >	getPreconditioner () const

void	uninitialize ()

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

Related Functions
(Note that these are not member functions.)
template<class Scalar >
RCP< ReusePreconditionerFactory< Scalar > >	reusePreconditionerFactory ()
	Nonmember constructor function. More...

template<class Scalar >
RCP< ReusePreconditionerFactory< Scalar > >	reusePreconditionerFactory (const RCP< PreconditionerBase< Scalar > > &prec)
	Nonmember constructor function. More...

Overridden from PreconditionerFactoryBase
RCP< PreconditionerBase< Scalar > >	prec_

bool	isCompatible (const LinearOpSourceBase< Scalar > &fwdOpSrc) const

RCP< PreconditionerBase< Scalar > >	createPrec () const

void	initializePrec (const RCP< const LinearOpSourceBase< Scalar > > &fwdOpSrc, PreconditionerBase< Scalar > *precOp, const ESupportSolveUse supportSolveUse=SUPPORT_SOLVE_UNSPECIFIED) const

void	uninitializePrec (PreconditionerBase< Scalar > precOp, RCP< const LinearOpSourceBase< Scalar > > fwdOpSrc=NULL, ESupportSolveUse *supportSolveUse=NULL) const

Detailed Description

template<class Scalar>
class Thyra::ReusePreconditionerFactory< Scalar >

Concrete PreconditionerFactoryBase subclass that just returns an already created/initialized preconditioner object.

Definition at line 20 of file Thyra_ReusePreconditionerFactory.hpp.

Constructor & Destructor Documentation

◆ ReusePreconditionerFactory()

template<class Scalar >

Thyra::ReusePreconditionerFactory< Scalar >::ReusePreconditionerFactory ( )

inline

Construct to uninitialized.

Definition at line 29 of file Thyra_ReusePreconditionerFactory.hpp.

Member Function Documentation

◆ createPrec()

template<class Scalar >

RCP<PreconditionerBase<Scalar> > Thyra::ReusePreconditionerFactory< Scalar >::createPrec ( ) const

inline

Definition at line 106 of file Thyra_ReusePreconditionerFactory.hpp.

◆ description()

template<class Scalar >

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

inline

Definition at line 53 of file Thyra_ReusePreconditionerFactory.hpp.

◆ getNonconstParameterList()

template<class Scalar >

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

inline

Definition at line 76 of file Thyra_ReusePreconditionerFactory.hpp.

◆ getNonconstPreconditioner()

template<class Scalar >

RCP<PreconditionerBase<Scalar> > Thyra::ReusePreconditionerFactory< Scalar >::getNonconstPreconditioner ( )

inline

Definition at line 41 of file Thyra_ReusePreconditionerFactory.hpp.

◆ getParameterList()

template<class Scalar >

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

inline

Definition at line 86 of file Thyra_ReusePreconditionerFactory.hpp.

◆ getPreconditioner()

template<class Scalar >

RCP<const PreconditionerBase<Scalar> > Thyra::ReusePreconditionerFactory< Scalar >::getPreconditioner ( ) const

inline

Definition at line 44 of file Thyra_ReusePreconditionerFactory.hpp.

◆ getValidParameters()

template<class Scalar >

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

inline

Definition at line 91 of file Thyra_ReusePreconditionerFactory.hpp.

◆ initialize()

template<class Scalar >

void Thyra::ReusePreconditionerFactory< Scalar >::initialize ( const RCP< PreconditionerBase< Scalar > > & prec )

inline

Definition at line 31 of file Thyra_ReusePreconditionerFactory.hpp.

◆ initializePrec()

template<class Scalar >

void Thyra::ReusePreconditionerFactory< Scalar >::initializePrec	(	const RCP< const LinearOpSourceBase< Scalar > > &	fwdOpSrc,
		PreconditionerBase< Scalar > *	precOp,
		const ESupportSolveUse	supportSolveUse = `SUPPORT_SOLVE_UNSPECIFIED`
	)		const

inline

Definition at line 109 of file Thyra_ReusePreconditionerFactory.hpp.

◆ isCompatible()

template<class Scalar >

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

inline

Definition at line 103 of file Thyra_ReusePreconditionerFactory.hpp.

◆ setParameterList()

template<class Scalar >

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

inline

Definition at line 72 of file Thyra_ReusePreconditionerFactory.hpp.

◆ uninitialize()

template<class Scalar >

void Thyra::ReusePreconditionerFactory< Scalar >::uninitialize ( )

inline

Definition at line 46 of file Thyra_ReusePreconditionerFactory.hpp.

◆ uninitializePrec()

template<class Scalar >

void Thyra::ReusePreconditionerFactory< Scalar >::uninitializePrec	(	PreconditionerBase< Scalar > *	precOp,
		RCP< const LinearOpSourceBase< Scalar > > *	fwdOpSrc = `NULL`,
		ESupportSolveUse *	supportSolveUse = `NULL`
	)		const

inline

Definition at line 117 of file Thyra_ReusePreconditionerFactory.hpp.

◆ unsetParameterList()

template<class Scalar >

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

inline

Definition at line 81 of file Thyra_ReusePreconditionerFactory.hpp.

Friends And Related Function Documentation

◆ reusePreconditionerFactory() [1/2]

template<class Scalar >

RCP< ReusePreconditionerFactory< Scalar > > reusePreconditionerFactory ( )

Definition at line 142 of file Thyra_ReusePreconditionerFactory.hpp.

◆ reusePreconditionerFactory() [2/2]

template<class Scalar >

RCP< ReusePreconditionerFactory< Scalar > > reusePreconditionerFactory ( const RCP< PreconditionerBase< Scalar > > & prec )

Definition at line 153 of file Thyra_ReusePreconditionerFactory.hpp.

Member Data Documentation

◆ prec_

template<class Scalar >

RCP< PreconditionerBase<Scalar> > Thyra::ReusePreconditionerFactory< Scalar >::prec_

private

Definition at line 132 of file Thyra_ReusePreconditionerFactory.hpp.

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

/home/abuild/rpmbuild/BUILD/Trilinos-trilinos-release-12-14-1/packages/tempus/src/Thyra_ReusePreconditionerFactory.hpp

Public Member Functions

Related Functions

Overridden from PreconditionerFactoryBase

Detailed Description

template<class Scalar> class Thyra::ReusePreconditionerFactory< Scalar >

Constructor & Destructor Documentation

◆ ReusePreconditionerFactory()

Member Function Documentation

◆ createPrec()

◆ description()

◆ getNonconstParameterList()

◆ getNonconstPreconditioner()

◆ getParameterList()

◆ getPreconditioner()

◆ getValidParameters()

◆ initialize()

◆ initializePrec()

◆ isCompatible()

◆ setParameterList()

◆ uninitialize()

◆ uninitializePrec()

◆ unsetParameterList()

Friends And Related Function Documentation

◆ reusePreconditionerFactory() [1/2]

◆ reusePreconditionerFactory() [2/2]

Member Data Documentation

◆ prec_

template<class Scalar>
class Thyra::ReusePreconditionerFactory< Scalar >