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

#include <Thyra_AdjointPreconditionerFactory.hpp>

Inheritance diagram for Thyra::AdjointPreconditionerFactory< Scalar >:

Private Types
typedef Teuchos::ConstNonconstObjectContainer < PreconditionerFactoryBase < Scalar > >	CNPFB

Static Private Member Functions
static void	validateInitialize (const RCP< const PreconditionerFactoryBase< Scalar > > &prec_fac)

Private Attributes
CNPFB	prec_fac_

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...

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

Overridden from PreconditionerFactoryBase
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

Additional Inherited Members
Public Member Functions inherited from Thyra::PreconditionerFactoryBase< Scalar >
void	initializePrec (const PreconditionerFactoryBase< Scalar > &precFactory, const Teuchos::RCP< const LinearOpBase< Scalar > > &fwdOp, const Teuchos::Ptr< PreconditionerBase< Scalar > > &prec, const ESupportSolveUse supportSolveUse=SUPPORT_SOLVE_UNSPECIFIED)

void	uninitializePrec (const PreconditionerFactoryBase< Scalar > &precFactory, const Teuchos::Ptr< PreconditionerBase< Scalar > > &prec, const Teuchos::Ptr< Teuchos::RCP< const LinearOpBase< Scalar > > > &fwdOp=Teuchos::null, const Teuchos::Ptr< ESupportSolveUse > &supportSolveUse=Teuchos::null)

Teuchos::RCP < PreconditionerBase< Scalar > >	prec (const PreconditionerFactoryBase< Scalar > &precFactory, const Teuchos::RCP< const LinearOpBase< Scalar > > &fwdOp, const ESupportSolveUse supportSolveUse=SUPPORT_SOLVE_UNSPECIFIED)

virtual bool	applySupportsConj (EConj conj) const

virtual bool	applyTransposeSupportsConj (EConj conj) const

Public Member Functions inherited from Teuchos::Describable
virtual void	describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

virtual	~Describable ()

	LabeledObject ()

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)

virtual std::string	getObjectLabel () const

DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)

Public Member Functions inherited from Teuchos::ParameterListAcceptor
virtual void	setParameterList (const RCP< ParameterList > &paramList)=0

Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

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

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

template<class Scalar >

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

inline

Construct to uninitialized.

Definition at line 30 of file Thyra_AdjointPreconditionerFactory.hpp.

Member Function Documentation

template<class Scalar >

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

inline

Definition at line 32 of file Thyra_AdjointPreconditionerFactory.hpp.

template<class Scalar >

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

inline

Definition at line 39 of file Thyra_AdjointPreconditionerFactory.hpp.

template<class Scalar >

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

inline

Definition at line 45 of file Thyra_AdjointPreconditionerFactory.hpp.

template<class Scalar >

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

inline

Definition at line 50 of file Thyra_AdjointPreconditionerFactory.hpp.

template<class Scalar >

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

inline

Definition at line 55 of file Thyra_AdjointPreconditionerFactory.hpp.

template<class Scalar >

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

inlinevirtual

Reimplemented from Teuchos::Describable.

Definition at line 60 of file Thyra_AdjointPreconditionerFactory.hpp.

template<class Scalar >

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

inline

Definition at line 79 of file Thyra_AdjointPreconditionerFactory.hpp.

template<class Scalar >

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

inlinevirtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 84 of file Thyra_AdjointPreconditionerFactory.hpp.

template<class Scalar >

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

inlinevirtual

Implements Teuchos::ParameterListAcceptor.

Definition at line 89 of file Thyra_AdjointPreconditionerFactory.hpp.

template<class Scalar >

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

inlinevirtual

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 94 of file Thyra_AdjointPreconditionerFactory.hpp.

template<class Scalar >

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

inlinevirtual

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 99 of file Thyra_AdjointPreconditionerFactory.hpp.

template<class Scalar >

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

inlinevirtual

Implements Thyra::PreconditionerFactoryBase< Scalar >.

Definition at line 111 of file Thyra_AdjointPreconditionerFactory.hpp.

template<class Scalar >

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

inlinevirtual

Implements Thyra::PreconditionerFactoryBase< Scalar >.

Definition at line 116 of file Thyra_AdjointPreconditionerFactory.hpp.

template<class Scalar >

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

inlinevirtual

Implements Thyra::PreconditionerFactoryBase< Scalar >.

Definition at line 121 of file Thyra_AdjointPreconditionerFactory.hpp.

template<class Scalar >

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