Tempus  Version of the Day
Time Integration
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Private Attributes | Related Functions | List of all members
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 >:
Inheritance graph
[legend]

Private Attributes

RCP< PreconditionerBase< Scalar > > prec_
 

Related Functions

(Note that these are not member functions.)

template<class Scalar >
RCP
< ReusePreconditionerFactory
< Scalar > > 		reusePreconditionerFactory ()
 Nonmember constructor function. More...
 
template<class Scalar >
RCP
< ReusePreconditionerFactory
< Scalar > > 		reusePreconditionerFactory (const RCP< PreconditionerBase< Scalar > > &prec)
 Nonmember constructor function. More...
 

Constructors/initializers/accessors

 ReusePreconditionerFactory ()
 Construct to uninitialized. More...
 
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
 

Overridden from PreconditionerFactoryBase

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
 

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

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

Definition at line 20 of file Thyra_ReusePreconditionerFactory.hpp.

Constructor & Destructor Documentation

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

Construct to uninitialized.

Definition at line 29 of file Thyra_ReusePreconditionerFactory.hpp.

Member Function Documentation

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

Definition at line 31 of file Thyra_ReusePreconditionerFactory.hpp.

template<class Scalar >
RCP<PreconditionerBase<Scalar> > Thyra::ReusePreconditionerFactory< Scalar >::getNonconstPreconditioner ( )
inline

Definition at line 41 of file Thyra_ReusePreconditionerFactory.hpp.

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

Definition at line 44 of file Thyra_ReusePreconditionerFactory.hpp.

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

Definition at line 46 of file Thyra_ReusePreconditionerFactory.hpp.

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

Reimplemented from Teuchos::Describable.

Definition at line 53 of file Thyra_ReusePreconditionerFactory.hpp.

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

Definition at line 72 of file Thyra_ReusePreconditionerFactory.hpp.

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

Implements Teuchos::ParameterListAcceptor.

Definition at line 76 of file Thyra_ReusePreconditionerFactory.hpp.

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

Implements Teuchos::ParameterListAcceptor.

Definition at line 81 of file Thyra_ReusePreconditionerFactory.hpp.

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

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 86 of file Thyra_ReusePreconditionerFactory.hpp.

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

Reimplemented from Teuchos::ParameterListAcceptor.

Definition at line 91 of file Thyra_ReusePreconditionerFactory.hpp.

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

Implements Thyra::PreconditionerFactoryBase< Scalar >.

Definition at line 103 of file Thyra_ReusePreconditionerFactory.hpp.

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

Implements Thyra::PreconditionerFactoryBase< Scalar >.

Definition at line 106 of file Thyra_ReusePreconditionerFactory.hpp.

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

Implements Thyra::PreconditionerFactoryBase< Scalar >.

Definition at line 109 of file Thyra_ReusePreconditionerFactory.hpp.

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

Implements Thyra::PreconditionerFactoryBase< Scalar >.

Definition at line 117 of file Thyra_ReusePreconditionerFactory.hpp.

Friends And Related Function Documentation

template<class Scalar >
RCP< ReusePreconditionerFactory< Scalar > > reusePreconditionerFactory ( )
related

Nonmember constructor function.

Definition at line 142 of file Thyra_ReusePreconditionerFactory.hpp.

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

Nonmember constructor function.

Definition at line 153 of file Thyra_ReusePreconditionerFactory.hpp.

Member Data Documentation

template<class Scalar >
RCP< PreconditionerBase<Scalar> > Thyra::ReusePreconditionerFactory< Scalar >::prec_
private

Definition at line 132 of file Thyra_ReusePreconditionerFactory.hpp.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.5