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::MultiVectorPreconditioner< Scalar > Class Template Reference

Concrete PreconditionerBase subclass that wraps a preconditioner operator in MultiVectorLinearOp. More...

#include <Thyra_MultiVectorPreconditioner.hpp>

Inheritance diagram for Thyra::MultiVectorPreconditioner< Scalar >:
Thyra::PreconditionerBase< Scalar > Teuchos::Describable Teuchos::LabeledObject

Private Types

typedef
Teuchos::ConstNonconstObjectContainer
< PreconditionerBase< Scalar > > 		CNPB
 

Static Private Member Functions

static void validateInitialize (const RCP< const PreconditionerBase< Scalar > > &prec, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
 

Private Attributes

CNPB prec_
 
RCP< const
DefaultMultiVectorProductVectorSpace
< Scalar > > 		multiVecRange_
 
RCP< const
DefaultMultiVectorProductVectorSpace
< Scalar > > 		multiVecDomain_
 

Related Functions

(Note that these are not member functions.)

template<class Scalar >
RCP< MultiVectorPreconditioner
< Scalar > > 		multiVectorPreconditioner ()
 Nonmember constructor function. More...
 
template<class Scalar >
RCP< MultiVectorPreconditioner
< Scalar > > 		nonconstMultiVectorPreconditioner (const RCP< PreconditionerBase< Scalar > > &prec, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
 Nonmember constructor function. More...
 
template<class Scalar >
RCP< MultiVectorPreconditioner
< Scalar > > 		multiVectorPreconditioner (const RCP< const PreconditionerBase< Scalar > > &prec, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
 Nonmember constructor function. More...
 

Constructors/initializers/accessors

 MultiVectorPreconditioner ()
 Construct to uninitialized. More...
 
void nonconstInitialize (const RCP< PreconditionerBase< Scalar > > &prec, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
 
void initialize (const RCP< const PreconditionerBase< Scalar > > &prec, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
 
RCP< PreconditionerBase< Scalar > > getNonconstPreconditioner ()
 
RCP< const PreconditionerBase
< Scalar > > 		getPreconditioner () const
 
void uninitialize ()
 

Overridden from PreconditionerBase

bool isLeftPrecOpConst () const
 
Teuchos::RCP< LinearOpBase
< Scalar > > 		getNonconstLeftPrecOp ()
 
Teuchos::RCP< const
LinearOpBase< Scalar > > 		getLeftPrecOp () const
 
bool isRightPrecOpConst () const
 
Teuchos::RCP< LinearOpBase
< Scalar > > 		getNonconstRightPrecOp ()
 
Teuchos::RCP< const
LinearOpBase< Scalar > > 		getRightPrecOp () const
 
bool isUnspecifiedPrecOpConst () const
 
Teuchos::RCP< LinearOpBase
< Scalar > > 		getNonconstUnspecifiedPrecOp ()
 
Teuchos::RCP< const
LinearOpBase< Scalar > > 		getUnspecifiedPrecOp () const
 

Additional Inherited Members

- Public Member Functions inherited from Teuchos::Describable
virtual std::string description () const
 
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)
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 

Detailed Description

template<class Scalar>
class Thyra::MultiVectorPreconditioner< Scalar >

Concrete PreconditionerBase subclass that wraps a preconditioner operator in MultiVectorLinearOp.

Definition at line 24 of file Thyra_MultiVectorPreconditioner.hpp.

Member Typedef Documentation

template<class Scalar >
typedef Teuchos::ConstNonconstObjectContainer<PreconditionerBase<Scalar> > Thyra::MultiVectorPreconditioner< Scalar >::CNPB
private

Definition at line 140 of file Thyra_MultiVectorPreconditioner.hpp.

Constructor & Destructor Documentation

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

Construct to uninitialized.

Definition at line 30 of file Thyra_MultiVectorPreconditioner.hpp.

Member Function Documentation

template<class Scalar >
void Thyra::MultiVectorPreconditioner< Scalar >::nonconstInitialize ( const RCP< PreconditionerBase< Scalar > > &  prec,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  multiVecRange,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  multiVecDomain 
)
inline

Definition at line 32 of file Thyra_MultiVectorPreconditioner.hpp.

template<class Scalar >
void Thyra::MultiVectorPreconditioner< Scalar >::initialize ( const RCP< const PreconditionerBase< Scalar > > &  prec,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  multiVecRange,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  multiVecDomain 
)
inline

Definition at line 45 of file Thyra_MultiVectorPreconditioner.hpp.

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

Definition at line 57 of file Thyra_MultiVectorPreconditioner.hpp.

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

Definition at line 62 of file Thyra_MultiVectorPreconditioner.hpp.

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

Definition at line 67 of file Thyra_MultiVectorPreconditioner.hpp.

template<class Scalar >
bool Thyra::MultiVectorPreconditioner< Scalar >::isLeftPrecOpConst ( ) const
inlinevirtual

Implements Thyra::PreconditionerBase< Scalar >.

Definition at line 79 of file Thyra_MultiVectorPreconditioner.hpp.

template<class Scalar >
Teuchos::RCP<LinearOpBase<Scalar> > Thyra::MultiVectorPreconditioner< Scalar >::getNonconstLeftPrecOp ( )
inlinevirtual

Implements Thyra::PreconditionerBase< Scalar >.

Definition at line 84 of file Thyra_MultiVectorPreconditioner.hpp.

template<class Scalar >
Teuchos::RCP<const LinearOpBase<Scalar> > Thyra::MultiVectorPreconditioner< Scalar >::getLeftPrecOp ( ) const
inlinevirtual

Implements Thyra::PreconditionerBase< Scalar >.

Definition at line 91 of file Thyra_MultiVectorPreconditioner.hpp.

template<class Scalar >
bool Thyra::MultiVectorPreconditioner< Scalar >::isRightPrecOpConst ( ) const
inlinevirtual

Implements Thyra::PreconditionerBase< Scalar >.

Definition at line 97 of file Thyra_MultiVectorPreconditioner.hpp.

template<class Scalar >
Teuchos::RCP<LinearOpBase<Scalar> > Thyra::MultiVectorPreconditioner< Scalar >::getNonconstRightPrecOp ( )
inlinevirtual

Implements Thyra::PreconditionerBase< Scalar >.

Definition at line 102 of file Thyra_MultiVectorPreconditioner.hpp.

template<class Scalar >
Teuchos::RCP<const LinearOpBase<Scalar> > Thyra::MultiVectorPreconditioner< Scalar >::getRightPrecOp ( ) const
inlinevirtual

Implements Thyra::PreconditionerBase< Scalar >.

Definition at line 109 of file Thyra_MultiVectorPreconditioner.hpp.

template<class Scalar >
bool Thyra::MultiVectorPreconditioner< Scalar >::isUnspecifiedPrecOpConst ( ) const
inlinevirtual

Implements Thyra::PreconditionerBase< Scalar >.

Definition at line 115 of file Thyra_MultiVectorPreconditioner.hpp.

template<class Scalar >
Teuchos::RCP<LinearOpBase<Scalar> > Thyra::MultiVectorPreconditioner< Scalar >::getNonconstUnspecifiedPrecOp ( )
inlinevirtual

Implements Thyra::PreconditionerBase< Scalar >.

Definition at line 120 of file Thyra_MultiVectorPreconditioner.hpp.

template<class Scalar >
Teuchos::RCP<const LinearOpBase<Scalar> > Thyra::MultiVectorPreconditioner< Scalar >::getUnspecifiedPrecOp ( ) const
inlinevirtual

Implements Thyra::PreconditionerBase< Scalar >.

Definition at line 127 of file Thyra_MultiVectorPreconditioner.hpp.

template<class Scalar >
static void Thyra::MultiVectorPreconditioner< Scalar >::validateInitialize ( const RCP< const PreconditionerBase< Scalar > > &  prec,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  multiVecRange,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  multiVecDomain 
)
inlinestaticprivate

Definition at line 152 of file Thyra_MultiVectorPreconditioner.hpp.

Friends And Related Function Documentation

template<class Scalar >
RCP< MultiVectorPreconditioner< Scalar > > multiVectorPreconditioner ( )
related

Nonmember constructor function.

Definition at line 178 of file Thyra_MultiVectorPreconditioner.hpp.

template<class Scalar >
RCP< MultiVectorPreconditioner< Scalar > > nonconstMultiVectorPreconditioner ( const RCP< PreconditionerBase< Scalar > > &  prec,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  multiVecRange,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  multiVecDomain 
)
related

Nonmember constructor function.

Definition at line 188 of file Thyra_MultiVectorPreconditioner.hpp.

template<class Scalar >
RCP< MultiVectorPreconditioner< Scalar > > multiVectorPreconditioner ( const RCP< const PreconditionerBase< Scalar > > &  prec,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  multiVecRange,
const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &  multiVecDomain 
)
related

Nonmember constructor function.

Definition at line 206 of file Thyra_MultiVectorPreconditioner.hpp.

Member Data Documentation

template<class Scalar >
CNPB Thyra::MultiVectorPreconditioner< Scalar >::prec_
private

Definition at line 145 of file Thyra_MultiVectorPreconditioner.hpp.

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

Definition at line 146 of file Thyra_MultiVectorPreconditioner.hpp.

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

Definition at line 147 of file Thyra_MultiVectorPreconditioner.hpp.

The documentation for this class was generated from the following file:
Generated on Wed Dec 25 2024 09:25:48 for Tempus by   doxygen 1.8.5