Preconditioner stores left and/or right operators for use in preconditioning. More...
Public Member Functions | |
| Preconditioner () | |
| Preconditioner (Handleable< PreconditionerBase< Scalar > > *rawPtr) | |
| Preconditioner (const RefCountPtr< 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 56 of file PlayaPreconditioner.hpp.
Constructor & Destructor Documentation
| Playa::Preconditioner< Scalar >::Preconditioner | ( | ) | [inline] |
Empty ctor
Definition at line 60 of file PlayaPreconditioner.hpp.
| Playa::Preconditioner< Scalar >::Preconditioner | ( | Handleable< PreconditionerBase< Scalar > > * | rawPtr | ) | [inline] |
Construct a Preconditioner with a raw pointer to a PreconditionerBase<Scalar>
Definition at line 60 of file PlayaPreconditioner.hpp.
| Playa::Preconditioner< Scalar >::Preconditioner | ( | const RefCountPtr< PreconditionerBase< Scalar > > & | smartPtr | ) | [inline] |
Construct a Preconditioner with a smart pointer to a PreconditionerBase<Scalar>
Definition at line 60 of file PlayaPreconditioner.hpp.
Member Function Documentation
| void Playa::Preconditioner< Scalar >::changeParameter | ( | const std::string & | name, |
| const double & | value | ||
| ) |
Change the value of a double parameter
| void Playa::Preconditioner< Scalar >::changeParameter | ( | const std::string & | name, |
| int | value | ||
| ) |
Change the value of an integer parameter
| bool Playa::Preconditioner< Scalar >::hasLeft | ( | ) | const [inline] |
return true if this preconditioner has a nontrivial left component
Definition at line 111 of file PlayaPreconditioner.hpp.
Referenced by Playa::Preconditioner< Scalar >::isIdentity(), Playa::Preconditioner< Scalar >::isTwoSided(), Playa::PCGSolver::solve(), Playa::KrylovSolver< Scalar >::solve(), and Playa::BelosSolver::solve().
| bool Playa::Preconditioner< Scalar >::hasRight | ( | ) | const [inline] |
return true if this preconditioner has a nontrivial right component
Definition at line 117 of file PlayaPreconditioner.hpp.
Referenced by Playa::Preconditioner< Scalar >::isIdentity(), Playa::Preconditioner< Scalar >::isTwoSided(), Playa::PCGSolver::solve(), Playa::KrylovSolver< Scalar >::solve(), and Playa::BelosSolver::solve().
| bool Playa::Preconditioner< Scalar >::isIdentity | ( | ) | const [inline] |
return true if this preconditioner has neither left nor right operators defined
Definition at line 89 of file PlayaPreconditioner.hpp.
References Playa::Preconditioner< Scalar >::hasLeft(), and Playa::Preconditioner< Scalar >::hasRight().
Referenced by Playa::PCGSolver::solve().
| bool Playa::Preconditioner< Scalar >::isTwoSided | ( | ) | const [inline] |
return true if this preconditioner has both left and right components.
Definition at line 78 of file PlayaPreconditioner.hpp.
References Playa::Preconditioner< Scalar >::hasLeft(), and Playa::Preconditioner< Scalar >::hasRight().
Referenced by Playa::PCGSolver::solve().
| LinearOperator< Scalar > Playa::Preconditioner< Scalar >::left | ( | ) | const [inline] |
Left preconditioner
Definition at line 95 of file PlayaPreconditioner.hpp.
Referenced by Playa::PCGSolver::solve(), Playa::KrylovSolver< Scalar >::solve(), and Playa::BelosSolver::solve().
| LinearOperator< Scalar > Playa::Preconditioner< Scalar >::right | ( | ) | const [inline] |
Right preconditioner
Definition at line 103 of file PlayaPreconditioner.hpp.
Referenced by Playa::PCGSolver::solve(), Playa::KrylovSolver< Scalar >::solve(), and Playa::BelosSolver::solve().