Playa::Preconditioner< Scalar > Class Template Reference

Preconditioner stores left and/or right operators for use in preconditioning. More...

#include <PlayaPreconditioner.hpp>

Inheritance diagram for Playa::Preconditioner< Scalar >:

Playa::Handle< PreconditionerBase< Scalar > >

List of all members.

Public Member Functions

 Preconditioner ()
 Preconditioner (Playa::Handleable< PreconditionerBase< Scalar > > *rawPtr)
 Preconditioner (const Teuchos::RCP< PreconditionerBase< Scalar > > &smartPtr)
void changeParameter (const std::string &name, const double &value)
void changeParameter (const std::string &name, int value)
LinearOperator< Scalar > left () const
LinearOperator< Scalar > right () const
bool isTwoSided () const
bool hasLeft () const
bool hasRight () const
bool isIdentity () const


Detailed Description

template<class Scalar>
class Playa::Preconditioner< Scalar >

Preconditioner stores left and/or right operators for use in preconditioning.

Definition at line 19 of file PlayaPreconditioner.hpp.


Constructor & Destructor Documentation

template<class Scalar>
Playa::Preconditioner< Scalar >::Preconditioner (  )  [inline]

Empty ctor

Definition at line 23 of file PlayaPreconditioner.hpp.

template<class Scalar>
Playa::Preconditioner< Scalar >::Preconditioner ( Playa::Handleable< PreconditionerBase< Scalar > > *  rawPtr  )  [inline]

Construct a # Preconditioner with a raw pointer to a # PreconditionerBase<Scalar>

Definition at line 23 of file PlayaPreconditioner.hpp.

template<class Scalar>
Playa::Preconditioner< Scalar >::Preconditioner ( const Teuchos::RCP< PreconditionerBase< Scalar > > &  smartPtr  )  [inline]

Construct a # Preconditioner with a smart pointer to a # PreconditionerBase<Scalar>

Definition at line 23 of file PlayaPreconditioner.hpp.


Member Function Documentation

template<class Scalar>
void Playa::Preconditioner< Scalar >::changeParameter ( const std::string &  name,
const double &  value 
)

Change the value of a double parameter

template<class Scalar>
void Playa::Preconditioner< Scalar >::changeParameter ( const std::string &  name,
int  value 
)

Change the value of an integer parameter

template<class Scalar >
LinearOperator< Scalar > Playa::Preconditioner< Scalar >::left (  )  const [inline]

Left preconditioner

Definition at line 58 of file PlayaPreconditioner.hpp.

template<class Scalar >
LinearOperator< Scalar > Playa::Preconditioner< Scalar >::right (  )  const [inline]

Right preconditioner

Definition at line 66 of file PlayaPreconditioner.hpp.

template<class Scalar>
bool Playa::Preconditioner< Scalar >::isTwoSided (  )  const [inline]

return true if this preconditioner has both left and right components.

Definition at line 41 of file PlayaPreconditioner.hpp.

template<class Scalar >
bool Playa::Preconditioner< Scalar >::hasLeft (  )  const [inline]

return true if this preconditioner has a nontrivial left component

Definition at line 74 of file PlayaPreconditioner.hpp.

template<class Scalar >
bool Playa::Preconditioner< Scalar >::hasRight (  )  const [inline]

return true if this preconditioner has a nontrivial right component

Definition at line 80 of file PlayaPreconditioner.hpp.

template<class Scalar>
bool Playa::Preconditioner< Scalar >::isIdentity (  )  const [inline]

return true if this preconditioner has neither left nor right operators defined

Definition at line 52 of file PlayaPreconditioner.hpp.


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

doxygen