Tempus  Version of the Day
Time Integration
Related Functions | List of all members
Thyra::MultiVectorPreconditionerFactory< Scalar > Class Template Reference

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

#include <Thyra_MultiVectorPreconditionerFactory.hpp>

Inheritance diagram for Thyra::MultiVectorPreconditionerFactory< Scalar >:

Public Member Functions

Constructors/initializers/accessors
 MultiVectorPreconditionerFactory ()
 Construct to uninitialized. More...
 
void nonconstInitialize (const RCP< PreconditionerFactoryBase< Scalar > > &prec_fac, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
 
void initialize (const RCP< const PreconditionerFactoryBase< Scalar > > &prec_fac, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
 
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< MultiVectorPreconditionerFactory< Scalar > > multiVectorPreconditionerFactory ()
 Nonmember constructor function. More...
 
template<class Scalar >
RCP< MultiVectorPreconditionerFactory< Scalar > > nonconstMultiVectorPreconditionerFactory (const RCP< PreconditionerFactoryBase< Scalar > > &prec_fac, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
 Nonmember constructor function. More...
 
template<class Scalar >
RCP< MultiVectorPreconditionerFactory< Scalar > > multiVectorPreconditionerFactory (const RCP< const PreconditionerFactoryBase< Scalar > > &prec_fac, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
 Nonmember constructor function. More...
 

Overridden from PreconditionerFactoryBase

typedef Teuchos::ConstNonconstObjectContainer< PreconditionerFactoryBase< Scalar > > CNPFB
 
CNPFB prec_fac_
 
RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > multiVecRange_
 
RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > multiVecDomain_
 
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, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
 

Detailed Description

template<class Scalar>
class Thyra::MultiVectorPreconditionerFactory< Scalar >

Concrete PreconditionerFactoryBase subclass that wraps a preconditioner in MultiVectorPreconditioner.

Definition at line 24 of file Thyra_MultiVectorPreconditionerFactory.hpp.

Member Typedef Documentation

◆ CNPFB

template<class Scalar >
typedef Teuchos::ConstNonconstObjectContainer<PreconditionerFactoryBase<Scalar> > Thyra::MultiVectorPreconditionerFactory< Scalar >::CNPFB
private

Definition at line 183 of file Thyra_MultiVectorPreconditionerFactory.hpp.

Constructor & Destructor Documentation

◆ MultiVectorPreconditionerFactory()

template<class Scalar >
Thyra::MultiVectorPreconditionerFactory< Scalar >::MultiVectorPreconditionerFactory ( )
inline

Construct to uninitialized.

Definition at line 33 of file Thyra_MultiVectorPreconditionerFactory.hpp.

Member Function Documentation

◆ createPrec()

template<class Scalar >
RCP<PreconditionerBase<Scalar> > Thyra::MultiVectorPreconditionerFactory< Scalar >::createPrec ( ) const
inline

Definition at line 125 of file Thyra_MultiVectorPreconditionerFactory.hpp.

◆ description()

template<class Scalar >
std::string Thyra::MultiVectorPreconditionerFactory< Scalar >::description ( ) const
inline

Definition at line 71 of file Thyra_MultiVectorPreconditionerFactory.hpp.

◆ getNonconstParameterList()

template<class Scalar >
RCP<ParameterList> Thyra::MultiVectorPreconditionerFactory< Scalar >::getNonconstParameterList ( )
inline

Definition at line 95 of file Thyra_MultiVectorPreconditionerFactory.hpp.

◆ getNonconstPreconditionerFactory()

template<class Scalar >
RCP<PreconditionerFactoryBase<Scalar> > Thyra::MultiVectorPreconditionerFactory< Scalar >::getNonconstPreconditionerFactory ( )
inline

Definition at line 57 of file Thyra_MultiVectorPreconditionerFactory.hpp.

◆ getParameterList()

template<class Scalar >
RCP<const ParameterList> Thyra::MultiVectorPreconditionerFactory< Scalar >::getParameterList ( ) const
inline

Definition at line 105 of file Thyra_MultiVectorPreconditionerFactory.hpp.

◆ getPreconditionerFactory()

template<class Scalar >
RCP<const PreconditionerFactoryBase<Scalar> > Thyra::MultiVectorPreconditionerFactory< Scalar >::getPreconditionerFactory ( ) const
inline

Definition at line 60 of file Thyra_MultiVectorPreconditionerFactory.hpp.

◆ getValidParameters()

template<class Scalar >
RCP<const ParameterList> Thyra::MultiVectorPreconditionerFactory< Scalar >::getValidParameters ( ) const
inline

Definition at line 110 of file Thyra_MultiVectorPreconditionerFactory.hpp.

◆ initialize()

template<class Scalar >
void Thyra::MultiVectorPreconditionerFactory< Scalar >::initialize ( const RCP< const PreconditionerFactoryBase< Scalar > > &  prec_fac,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  multiVecRange,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  multiVecDomain 
)
inline

Definition at line 46 of file Thyra_MultiVectorPreconditionerFactory.hpp.

◆ initializePrec()

template<class Scalar >
void Thyra::MultiVectorPreconditionerFactory< Scalar >::initializePrec ( const RCP< const LinearOpSourceBase< Scalar > > &  fwdOpSrc,
PreconditionerBase< Scalar > *  precOp,
const ESupportSolveUse  supportSolveUse = SUPPORT_SOLVE_UNSPECIFIED 
) const
inline

Definition at line 131 of file Thyra_MultiVectorPreconditionerFactory.hpp.

◆ isCompatible()

template<class Scalar >
bool Thyra::MultiVectorPreconditionerFactory< Scalar >::isCompatible ( const LinearOpSourceBase< Scalar > &  fwdOpSrc) const
inline

Definition at line 122 of file Thyra_MultiVectorPreconditionerFactory.hpp.

◆ nonconstInitialize()

template<class Scalar >
void Thyra::MultiVectorPreconditionerFactory< Scalar >::nonconstInitialize ( const RCP< PreconditionerFactoryBase< Scalar > > &  prec_fac,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  multiVecRange,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  multiVecDomain 
)
inline

Definition at line 35 of file Thyra_MultiVectorPreconditionerFactory.hpp.

◆ setParameterList()

template<class Scalar >
void Thyra::MultiVectorPreconditionerFactory< Scalar >::setParameterList ( RCP< ParameterList > const &  paramList)
inline

Definition at line 90 of file Thyra_MultiVectorPreconditionerFactory.hpp.

◆ uninitialize()

template<class Scalar >
void Thyra::MultiVectorPreconditionerFactory< Scalar >::uninitialize ( )
inline

Definition at line 62 of file Thyra_MultiVectorPreconditionerFactory.hpp.

◆ uninitializePrec()

template<class Scalar >
void Thyra::MultiVectorPreconditionerFactory< Scalar >::uninitializePrec ( PreconditionerBase< Scalar > *  precOp,
RCP< const LinearOpSourceBase< Scalar > > *  fwdOpSrc = NULL,
ESupportSolveUse *  supportSolveUse = NULL 
) const
inline

Definition at line 151 of file Thyra_MultiVectorPreconditionerFactory.hpp.

◆ unsetParameterList()

template<class Scalar >
RCP<ParameterList> Thyra::MultiVectorPreconditionerFactory< Scalar >::unsetParameterList ( )
inline

Definition at line 100 of file Thyra_MultiVectorPreconditionerFactory.hpp.

◆ validateInitialize()

template<class Scalar >
static void Thyra::MultiVectorPreconditionerFactory< Scalar >::validateInitialize ( const RCP< const PreconditionerFactoryBase< Scalar > > &  prec_fac,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  multiVecRange,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  multiVecDomain 
)
inlinestaticprivate

Definition at line 195 of file Thyra_MultiVectorPreconditionerFactory.hpp.

Friends And Related Function Documentation

◆ multiVectorPreconditionerFactory() [1/2]

template<class Scalar >
RCP< MultiVectorPreconditionerFactory< Scalar > > multiVectorPreconditionerFactory ( )
related

Nonmember constructor function.

Definition at line 216 of file Thyra_MultiVectorPreconditionerFactory.hpp.

◆ multiVectorPreconditionerFactory() [2/2]

template<class Scalar >
RCP< MultiVectorPreconditionerFactory< Scalar > > multiVectorPreconditionerFactory ( const RCP< const PreconditionerFactoryBase< Scalar > > &  prec_fac,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  multiVecRange,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  multiVecDomain 
)
related

Nonmember constructor function.

Definition at line 245 of file Thyra_MultiVectorPreconditionerFactory.hpp.

◆ nonconstMultiVectorPreconditionerFactory()

template<class Scalar >
RCP< MultiVectorPreconditionerFactory< Scalar > > nonconstMultiVectorPreconditionerFactory ( const RCP< PreconditionerFactoryBase< Scalar > > &  prec_fac,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  multiVecRange,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  multiVecDomain 
)
related

Nonmember constructor function.

Definition at line 227 of file Thyra_MultiVectorPreconditionerFactory.hpp.

Member Data Documentation

◆ multiVecDomain_

template<class Scalar >
RCP<const DefaultMultiVectorProductVectorSpace<Scalar> > Thyra::MultiVectorPreconditionerFactory< Scalar >::multiVecDomain_
private

Definition at line 190 of file Thyra_MultiVectorPreconditionerFactory.hpp.

◆ multiVecRange_

template<class Scalar >
RCP<const DefaultMultiVectorProductVectorSpace<Scalar> > Thyra::MultiVectorPreconditionerFactory< Scalar >::multiVecRange_
private

Definition at line 189 of file Thyra_MultiVectorPreconditionerFactory.hpp.

◆ prec_fac_

template<class Scalar >
CNPFB Thyra::MultiVectorPreconditionerFactory< Scalar >::prec_fac_
private

Definition at line 188 of file Thyra_MultiVectorPreconditionerFactory.hpp.

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