Thyra::DefaultPreconditioner< RangeScalar, DomainScalar > Class Template Reference

Default implementation of a PreconditionerBase that just accepts precreated preconditioner linear operators. More...

#include <Thyra_DefaultPreconditionerDecl.hpp>

Inheritance diagram for Thyra::DefaultPreconditioner< RangeScalar, DomainScalar >:


Constructors/initializers/accessors
	DefaultPreconditioner ()
	Construct to uninitialized.
	DefaultPreconditioner (const Teuchos::RCP< LinearOpBase< RangeScalar, DomainScalar > > &leftPrecOp, const Teuchos::RCP< LinearOpBase< RangeScalar, DomainScalar > > &rightPrecOp)
	Construct a left-only, or right-only, or split left/right preconditioner.
	DefaultPreconditioner (const Teuchos::RCP< const LinearOpBase< RangeScalar, DomainScalar > > &leftPrecOp, const Teuchos::RCP< const LinearOpBase< RangeScalar, DomainScalar > > &rightPrecOp)
	Construct a const-only left-only, or right-only, or split left/right preconditioner.
	DefaultPreconditioner (const Teuchos::RCP< LinearOpBase< RangeScalar, DomainScalar > > &unspecifiedPrecOp)
	Construct a single unspecified preconditioner.
	DefaultPreconditioner (const Teuchos::RCP< const LinearOpBase< RangeScalar, DomainScalar > > &unspecifiedPrecOp)
	Construct a const-only single unspecified preconditioner.
void	initializeLeft (const Teuchos::RCP< LinearOpBase< RangeScalar, DomainScalar > > &leftPrecOp)
	Initialize a left preconditioner.
void	initializeLeft (const Teuchos::RCP< const LinearOpBase< RangeScalar, DomainScalar > > &leftPrecOp)
	Initialize a const-only left preconditioner.
void	initializeRight (const Teuchos::RCP< LinearOpBase< RangeScalar, DomainScalar > > &rightPrecOp)
	Initialize a right preconditioner.
void	initializeRight (const Teuchos::RCP< const LinearOpBase< RangeScalar, DomainScalar > > &rightPrecOp)
	Initialize a const-only right preconditioner.
void	initializeLeftRight (const Teuchos::RCP< LinearOpBase< RangeScalar, DomainScalar > > &leftPrecOp, const Teuchos::RCP< LinearOpBase< RangeScalar, DomainScalar > > &rightPrecOp)
	Initialize a split left/right preconditioner.
void	initializeLeftRight (const Teuchos::RCP< const LinearOpBase< RangeScalar, DomainScalar > > &leftPrecOp, const Teuchos::RCP< const LinearOpBase< RangeScalar, DomainScalar > > &rightPrecOp)
	Initialize a const-only split left/right preconditioner.
void	initializeUnspecified (const Teuchos::RCP< LinearOpBase< RangeScalar, DomainScalar > > &unspecifiedPrecOp)
	Initialize a single unspecified preconditioner operator.
void	initializeUnspecified (const Teuchos::RCP< const LinearOpBase< RangeScalar, DomainScalar > > &unspecifiedPrecOp)
	Initialize a const-only single unspecified preconditioner operator.
void	uninitialize ()
	Uninitialize.
Overridden from Teuchos::Describable
std::string	description () const

void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel) const

Overridden from PreconditionerBase
bool	isLeftPrecOpConst () const

Teuchos::RCP< LinearOpBase< RangeScalar, DomainScalar > >	getNonconstLeftPrecOp ()

Teuchos::RCP< const LinearOpBase< RangeScalar, DomainScalar > >	getLeftPrecOp () const

bool	isRightPrecOpConst () const

Teuchos::RCP< LinearOpBase< RangeScalar, DomainScalar > >	getNonconstRightPrecOp ()

Teuchos::RCP< const LinearOpBase< RangeScalar, DomainScalar > >	getRightPrecOp () const

bool	isUnspecifiedPrecOpConst () const

Teuchos::RCP< LinearOpBase< RangeScalar, DomainScalar > >	getNonconstUnspecifiedPrecOp ()

Teuchos::RCP< const LinearOpBase< RangeScalar, DomainScalar > >	getUnspecifiedPrecOp () const

Related Functions
(Note that these are not member functions.)
Teuchos::RCP< const DefaultPreconditioner< Scalar > >	unspecifiedPrec (const Teuchos::RCP< const LinearOpBase< Scalar > > &unspecifiedPrecOp)
	Create a precondioner from a single linear operator not targeted to be used on the left or the right.
Teuchos::RCP< const DefaultPreconditioner< Scalar > >	leftPrec (const Teuchos::RCP< const LinearOpBase< Scalar > > &leftPrecOp)
	Create a precondioner from a single linear operator targeted to be used on the left.
Teuchos::RCP< const DefaultPreconditioner< Scalar > >	rightPrec (const Teuchos::RCP< const LinearOpBase< Scalar > > &rightPrecOp)
	Create a precondioner from a single linear operator targeted to be used on the right.
Teuchos::RCP< const DefaultPreconditioner< Scalar > >	splitPrec (const Teuchos::RCP< const LinearOpBase< Scalar > > &leftPrecOp, const Teuchos::RCP< const LinearOpBase< Scalar > > &rightPrecOp)
	Create a split precondioner from two linear operators, one to be applied on the left and one to be applied on the right.

Detailed Description

template<class RangeScalar, class DomainScalar = RangeScalar>
class Thyra::DefaultPreconditioner< RangeScalar, DomainScalar >

Default implementation of a PreconditionerBase that just accepts precreated preconditioner linear operators.

Here is how to construct a precondtioner for the four different types of preconditioners:

Single preconditioner linear operator designed or targeted to be applied on the left:
- DefaultPreconditioner(leftPrecOp,Teuchos::null);
Single preconditioner linear operator designed or targeted to be applied on the right: DefaultPreconditioner(Teuchos::null,righPrecOp);
Split two-sided preconditioner with linear operators designed or targeted to be applied on the left and the right: DefaultPreconditioner(leftPrecOp,rightPrecOp);
Single preconditioner linear operator not designed or targeted to be applied on the left or the right: DefaultPreconditioner(precOp); <>
ToDo: Finish documentation!

Definition at line 65 of file Thyra_DefaultPreconditionerDecl.hpp.