Thyra::ReusePreconditionerFactory< Scalar > Class Template Reference

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

#include <Thyra_ReusePreconditionerFactory.hpp>

Inheritance diagram for Thyra::ReusePreconditionerFactory< Scalar >:

Related Symbols
(Note that these are not member symbols.)
template<class Scalar >
RCP< ReusePreconditionerFactory< Scalar > >	reusePreconditionerFactory ()
	Nonmember constructor function.
template<class Scalar >
RCP< ReusePreconditionerFactory< Scalar > >	reusePreconditionerFactory (const RCP< PreconditionerBase< Scalar > > &prec)
	Nonmember constructor function.

Overridden from PreconditionerFactoryBase
RCP< PreconditionerBase< Scalar > >	prec_
bool	isCompatible (const LinearOpSourceBase< Scalar > &) const
RCP< PreconditionerBase< Scalar > >	createPrec () const
void	initializePrec (const RCP< const LinearOpSourceBase< Scalar > > &, PreconditionerBase< Scalar > *, const ESupportSolveUse=SUPPORT_SOLVE_UNSPECIFIED) const
void	uninitializePrec (PreconditionerBase< Scalar > *, RCP< const LinearOpSourceBase< Scalar > > *fwdOpSrc=NULL, ESupportSolveUse *supportSolveUse=NULL) const

Constructors/initializers/accessors
	ReusePreconditionerFactory ()
	Construct to uninitialized.
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 &)
RCP< ParameterList >	getNonconstParameterList ()
RCP< ParameterList >	unsetParameterList ()
RCP< const ParameterList >	getParameterList () const
RCP< const ParameterList >	getValidParameters () 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 21 of file Thyra_ReusePreconditionerFactory.hpp.

Constructor & Destructor Documentation

ReusePreconditionerFactory()

template<class Scalar >

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

inline

Construct to uninitialized.

Definition at line 28 of file Thyra_ReusePreconditionerFactory.hpp.

Member Function Documentation

initialize()

template<class Scalar >

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

inline

Definition at line 30 of file Thyra_ReusePreconditionerFactory.hpp.

getNonconstPreconditioner()

template<class Scalar >

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

inline

Definition at line 38 of file Thyra_ReusePreconditionerFactory.hpp.

getPreconditioner()

template<class Scalar >

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

inline

Definition at line 40 of file Thyra_ReusePreconditionerFactory.hpp.

uninitialize()

template<class Scalar >

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

inline

Definition at line 45 of file Thyra_ReusePreconditionerFactory.hpp.

description()

template<class Scalar >

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

inline

Definition at line 50 of file Thyra_ReusePreconditionerFactory.hpp.

setParameterList()

template<class Scalar >

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

inline

Definition at line 69 of file Thyra_ReusePreconditionerFactory.hpp.

getNonconstParameterList()

template<class Scalar >

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

inline

Definition at line 71 of file Thyra_ReusePreconditionerFactory.hpp.

unsetParameterList()

template<class Scalar >

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

inline

Definition at line 73 of file Thyra_ReusePreconditionerFactory.hpp.

getParameterList()

template<class Scalar >

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

inline

Definition at line 75 of file Thyra_ReusePreconditionerFactory.hpp.

getValidParameters()

template<class Scalar >

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

inline

Definition at line 77 of file Thyra_ReusePreconditionerFactory.hpp.

isCompatible()

template<class Scalar >

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

inline

Definition at line 89 of file Thyra_ReusePreconditionerFactory.hpp.

createPrec()

template<class Scalar >

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

inline

Definition at line 94 of file Thyra_ReusePreconditionerFactory.hpp.

initializePrec()

template<class Scalar >

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

inline

Definition at line 96 of file Thyra_ReusePreconditionerFactory.hpp.

uninitializePrec()

template<class Scalar >

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

inline

Definition at line 104 of file Thyra_ReusePreconditionerFactory.hpp.

Friends And Related Symbol Documentation

reusePreconditionerFactory() [1/2]

template<class Scalar >

RCP< ReusePreconditionerFactory< Scalar > > reusePreconditionerFactory ( )

related

Nonmember constructor function.

Definition at line 124 of file Thyra_ReusePreconditionerFactory.hpp.

reusePreconditionerFactory() [2/2]

template<class Scalar >

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

related

Nonmember constructor function.

Definition at line 134 of file Thyra_ReusePreconditionerFactory.hpp.

Member Data Documentation

prec_

template<class Scalar >

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

private

Definition at line 116 of file Thyra_ReusePreconditionerFactory.hpp.

---

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

• Thyra_ReusePreconditionerFactory.hpp