Concrete PreconditionerFactoryBase subclass that wraps a preconditioner in AdjointPreconditioner. More...

#include <Thyra_AdjointPreconditionerFactory.hpp>

Inheritance diagram for Thyra::AdjointPreconditionerFactory< Scalar >:

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

void	nonconstInitialize (const RCP< PreconditionerFactoryBase< Scalar > > &prec_fac)

void	initialize (const RCP< const PreconditionerFactoryBase< Scalar > > &prec_fac)

RCP< PreconditionerFactoryBase< Scalar > >	getNonconstPreconditionerFactory ()

RCP< const PreconditionerFactoryBase< Scalar > >	getPreconditionerFactory () 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< AdjointPreconditionerFactory< Scalar > >	adjointPreconditionerFactory ()
	Nonmember constructor function. More...

template<class Scalar >
RCP< AdjointPreconditionerFactory< Scalar > >	nonconstAdjointPreconditionerFactory (const RCP< PreconditionerFactoryBase< Scalar > > &prec_fac)
	Nonmember constructor function. More...

template<class Scalar >
RCP< AdjointPreconditionerFactory< Scalar > >	adjointPreconditionerFactory (const RCP< const PreconditionerFactoryBase< Scalar > > &prec_fac)
	Nonmember constructor function. More...

Overridden from PreconditionerFactoryBase
typedef Teuchos::ConstNonconstObjectContainer< PreconditionerFactoryBase< Scalar > >	CNPFB

CNPFB	prec_fac_

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

static void	validateInitialize (const RCP< const PreconditionerFactoryBase< Scalar > > &prec_fac)

Detailed Description

template<class Scalar>
class Thyra::AdjointPreconditionerFactory< Scalar >

Concrete PreconditionerFactoryBase subclass that wraps a preconditioner in AdjointPreconditioner.

Definition at line 23 of file Thyra_AdjointPreconditionerFactory.hpp.

Member Typedef Documentation

◆ CNPFB

template<class Scalar >

typedef Teuchos::ConstNonconstObjectContainer<PreconditionerFactoryBase<Scalar> > Thyra::AdjointPreconditionerFactory< Scalar >::CNPFB

private

Definition at line 167 of file Thyra_AdjointPreconditionerFactory.hpp.

Constructor & Destructor Documentation

◆ AdjointPreconditionerFactory()

template<class Scalar >

Thyra::AdjointPreconditionerFactory< Scalar >::AdjointPreconditionerFactory ( )

inline

Construct to uninitialized.

Definition at line 32 of file Thyra_AdjointPreconditionerFactory.hpp.

Member Function Documentation

◆ createPrec()

template<class Scalar >

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

inline

Definition at line 113 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ description()

template<class Scalar >

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

inline

Definition at line 59 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ getNonconstParameterList()

template<class Scalar >

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

inline

Definition at line 83 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ getNonconstPreconditionerFactory()

template<class Scalar >

RCP<PreconditionerFactoryBase<Scalar> > Thyra::AdjointPreconditionerFactory< Scalar >::getNonconstPreconditionerFactory ( )

inline

Definition at line 47 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ getParameterList()

template<class Scalar >

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

inline

Definition at line 93 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ getPreconditionerFactory()

template<class Scalar >

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

inline

Definition at line 50 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ getValidParameters()

template<class Scalar >

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

inline

Definition at line 98 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ initialize()

template<class Scalar >

void Thyra::AdjointPreconditionerFactory< Scalar >::initialize ( const RCP< const PreconditionerFactoryBase< Scalar > > & prec_fac )

inline

Definition at line 40 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ initializePrec()

template<class Scalar >

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

inline

Definition at line 117 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ isCompatible()

template<class Scalar >

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

inline

Definition at line 110 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ nonconstInitialize()

template<class Scalar >

void Thyra::AdjointPreconditionerFactory< Scalar >::nonconstInitialize ( const RCP< PreconditionerFactoryBase< Scalar > > & prec_fac )

inline

Definition at line 34 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ setParameterList()

template<class Scalar >

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

inline

Definition at line 78 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ uninitialize()

template<class Scalar >

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

inline

Definition at line 52 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ uninitializePrec()

template<class Scalar >

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

inline

Definition at line 137 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ unsetParameterList()

template<class Scalar >

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

inline

Definition at line 88 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ validateInitialize()

template<class Scalar >

static void Thyra::AdjointPreconditionerFactory< Scalar >::validateInitialize ( const RCP< const PreconditionerFactoryBase< Scalar > > & prec_fac )

inlinestaticprivate

Definition at line 177 of file Thyra_AdjointPreconditionerFactory.hpp.

Friends And Related Function Documentation

◆ adjointPreconditionerFactory() [1/2]

template<class Scalar >

RCP< AdjointPreconditionerFactory< Scalar > > adjointPreconditionerFactory ( )

Definition at line 192 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ adjointPreconditionerFactory() [2/2]

template<class Scalar >

RCP< AdjointPreconditionerFactory< Scalar > > adjointPreconditionerFactory ( const RCP< const PreconditionerFactoryBase< Scalar > > & prec_fac )

Definition at line 218 of file Thyra_AdjointPreconditionerFactory.hpp.

◆ nonconstAdjointPreconditionerFactory()

template<class Scalar >

RCP< AdjointPreconditionerFactory< Scalar > > nonconstAdjointPreconditionerFactory ( const RCP< PreconditionerFactoryBase< Scalar > > & prec_fac )

Definition at line 203 of file Thyra_AdjointPreconditionerFactory.hpp.

Member Data Documentation

◆ prec_fac_

template<class Scalar >

CNPFB Thyra::AdjointPreconditionerFactory< Scalar >::prec_fac_

private

Definition at line 172 of file Thyra_AdjointPreconditionerFactory.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_AdjointPreconditionerFactory.hpp

Public Member Functions

Related Functions

Overridden from PreconditionerFactoryBase

Detailed Description

template<class Scalar> class Thyra::AdjointPreconditionerFactory< Scalar >

Member Typedef Documentation

◆ CNPFB

Constructor & Destructor Documentation

◆ AdjointPreconditionerFactory()

Member Function Documentation

◆ createPrec()

◆ description()

◆ getNonconstParameterList()

◆ getNonconstPreconditionerFactory()

◆ getParameterList()

◆ getPreconditionerFactory()

◆ getValidParameters()

◆ initialize()

◆ initializePrec()

◆ isCompatible()

◆ nonconstInitialize()

◆ setParameterList()

◆ uninitialize()

◆ uninitializePrec()

◆ unsetParameterList()

◆ validateInitialize()

Friends And Related Function Documentation

◆ adjointPreconditionerFactory() [1/2]

◆ adjointPreconditionerFactory() [2/2]

◆ nonconstAdjointPreconditionerFactory()

Member Data Documentation

◆ prec_fac_

template<class Scalar>
class Thyra::AdjointPreconditionerFactory< Scalar >