Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Private Types | Static Private Member Functions | Private Attributes | 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 >:
Thyra::PreconditionerFactoryBase< Scalar > Teuchos::Describable Teuchos::ParameterListAcceptor Teuchos::LabeledObject

Private Types

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

Static Private Member Functions

static void validateInitialize (const RCP< const PreconditionerFactoryBase< Scalar > > &prec_fac, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
 

Private Attributes

CNPFB prec_fac_
 
RCP< const
DefaultMultiVectorProductVectorSpace
< Scalar > > 		multiVecRange_
 
RCP< const
DefaultMultiVectorProductVectorSpace
< Scalar > > 		multiVecDomain_
 

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

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
 

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::MultiVectorPreconditionerFactory< Scalar >

Concrete PreconditionerFactoryBase subclass that wraps a preconditioner in MultiVectorPreconditioner.

Definition at line 24 of file Thyra_MultiVectorPreconditionerFactory.hpp.

Member Typedef Documentation

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

Definition at line 186 of file Thyra_MultiVectorPreconditionerFactory.hpp.

Constructor & Destructor Documentation

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

Construct to uninitialized.

Definition at line 31 of file Thyra_MultiVectorPreconditionerFactory.hpp.

Member Function Documentation

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 33 of file Thyra_MultiVectorPreconditionerFactory.hpp.

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.

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

Definition at line 58 of file Thyra_MultiVectorPreconditionerFactory.hpp.

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

Definition at line 63 of file Thyra_MultiVectorPreconditionerFactory.hpp.

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

Definition at line 68 of file Thyra_MultiVectorPreconditionerFactory.hpp.

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

Reimplemented from Teuchos::Describable.

Definition at line 78 of file Thyra_MultiVectorPreconditionerFactory.hpp.

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

Definition at line 97 of file Thyra_MultiVectorPreconditionerFactory.hpp.

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

Implements Teuchos::ParameterListAcceptor.

Definition at line 102 of file Thyra_MultiVectorPreconditionerFactory.hpp.

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

Implements Teuchos::ParameterListAcceptor.

Definition at line 107 of file Thyra_MultiVectorPreconditionerFactory.hpp.

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

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 112 of file Thyra_MultiVectorPreconditionerFactory.hpp.

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

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 117 of file Thyra_MultiVectorPreconditionerFactory.hpp.

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

Implements Thyra::PreconditionerFactoryBase< Scalar >.

Definition at line 129 of file Thyra_MultiVectorPreconditionerFactory.hpp.

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

Implements Thyra::PreconditionerFactoryBase< Scalar >.

Definition at line 134 of file Thyra_MultiVectorPreconditionerFactory.hpp.

template<class Scalar >
void Thyra::MultiVectorPreconditionerFactory< 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 140 of file Thyra_MultiVectorPreconditionerFactory.hpp.

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

Implements Thyra::PreconditionerFactoryBase< Scalar >.

Definition at line 158 of file Thyra_MultiVectorPreconditionerFactory.hpp.

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 198 of file Thyra_MultiVectorPreconditionerFactory.hpp.

Friends And Related Function Documentation

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

Nonmember constructor function.

Definition at line 225 of file Thyra_MultiVectorPreconditionerFactory.hpp.

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 236 of file Thyra_MultiVectorPreconditionerFactory.hpp.

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 254 of file Thyra_MultiVectorPreconditionerFactory.hpp.

Member Data Documentation

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

Definition at line 191 of file Thyra_MultiVectorPreconditionerFactory.hpp.

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

Definition at line 192 of file Thyra_MultiVectorPreconditionerFactory.hpp.

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

Definition at line 193 of file Thyra_MultiVectorPreconditionerFactory.hpp.

The documentation for this class was generated from the following file:
Generated on Fri Apr 26 2024 09:25:47 for Tempus by   doxygen 1.8.5