Tempus  Version of the Day
Time Integration
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 >:

Public Member Functions

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 ()
 

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

Overridden from PreconditionerBase

typedef Teuchos::ConstNonconstObjectContainer< PreconditionerBase< Scalar > > CNPB
 
CNPB prec_
 
RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > multiVecRange_
 
RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > multiVecDomain_
 
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
 
static void validateInitialize (const RCP< const PreconditionerBase< Scalar > > &prec, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecRange, const RCP< const DefaultMultiVectorProductVectorSpace< Scalar > > &multiVecDomain)
 

Detailed Description

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

Concrete PreconditionerBase subclass that wraps a preconditioner operator in MultiVectorLinearOp.

Definition at line 23 of file Thyra_MultiVectorPreconditioner.hpp.

Member Typedef Documentation

◆ CNPB

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

Definition at line 123 of file Thyra_MultiVectorPreconditioner.hpp.

Constructor & Destructor Documentation

◆ MultiVectorPreconditioner()

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

Construct to uninitialized.

Definition at line 31 of file Thyra_MultiVectorPreconditioner.hpp.

Member Function Documentation

◆ getLeftPrecOp()

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

Definition at line 80 of file Thyra_MultiVectorPreconditioner.hpp.

◆ getNonconstLeftPrecOp()

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

Definition at line 74 of file Thyra_MultiVectorPreconditioner.hpp.

◆ getNonconstPreconditioner()

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

Definition at line 55 of file Thyra_MultiVectorPreconditioner.hpp.

◆ getNonconstRightPrecOp()

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

Definition at line 89 of file Thyra_MultiVectorPreconditioner.hpp.

◆ getNonconstUnspecifiedPrecOp()

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

Definition at line 104 of file Thyra_MultiVectorPreconditioner.hpp.

◆ getPreconditioner()

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

Definition at line 58 of file Thyra_MultiVectorPreconditioner.hpp.

◆ getRightPrecOp()

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

Definition at line 95 of file Thyra_MultiVectorPreconditioner.hpp.

◆ getUnspecifiedPrecOp()

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

Definition at line 110 of file Thyra_MultiVectorPreconditioner.hpp.

◆ initialize()

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 44 of file Thyra_MultiVectorPreconditioner.hpp.

◆ isLeftPrecOpConst()

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

Definition at line 71 of file Thyra_MultiVectorPreconditioner.hpp.

◆ isRightPrecOpConst()

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

Definition at line 86 of file Thyra_MultiVectorPreconditioner.hpp.

◆ isUnspecifiedPrecOpConst()

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

Definition at line 101 of file Thyra_MultiVectorPreconditioner.hpp.

◆ nonconstInitialize()

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

◆ uninitialize()

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

Definition at line 60 of file Thyra_MultiVectorPreconditioner.hpp.

◆ validateInitialize()

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 135 of file Thyra_MultiVectorPreconditioner.hpp.

Friends And Related Function Documentation

◆ multiVectorPreconditioner() [1/2]

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

Nonmember constructor function.

Definition at line 156 of file Thyra_MultiVectorPreconditioner.hpp.

◆ multiVectorPreconditioner() [2/2]

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 185 of file Thyra_MultiVectorPreconditioner.hpp.

◆ nonconstMultiVectorPreconditioner()

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 167 of file Thyra_MultiVectorPreconditioner.hpp.

Member Data Documentation

◆ multiVecDomain_

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

Definition at line 130 of file Thyra_MultiVectorPreconditioner.hpp.

◆ multiVecRange_

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

Definition at line 129 of file Thyra_MultiVectorPreconditioner.hpp.

◆ prec_

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

Definition at line 128 of file Thyra_MultiVectorPreconditioner.hpp.

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