Public Member Functions | |
| Preconditioner () | |
| Empty ctor. | |
| Preconditioner (Handleable< PreconditionerBase< Scalar > > *rawPtr) | |
| Construct a Preconditioner with a raw pointer to a PreconditionerBase<Scalar> | |
| Preconditioner (const RefCountPtr< PreconditionerBase< Scalar > > &smartPtr) | |
| Construct a Preconditioner with a smart pointer to a PreconditionerBase<Scalar> | |
| void | changeParameter (const std::string &name, const double &value) |
| Change the value of a double parameter. | |
| void | changeParameter (const std::string &name, int value) |
| Change the value of an integer parameter. | |
| LinearOperator< Scalar > | left () const |
| Left preconditioner. | |
| LinearOperator< Scalar > | right () const |
| Right preconditioner. | |
| bool | isTwoSided () const |
| return true if this preconditioner has both left and right components. | |
| bool | hasLeft () const |
| return true if this preconditioner has a nontrivial left component | |
| bool | hasRight () const |
| return true if this preconditioner has a nontrivial right component | |
| bool | isIdentity () const |
| return true if this preconditioner has neither left nor right operators defined | |
Detailed Description
template<class Scalar>
class TSFExtended::Preconditioner< Scalar >
Definition at line 42 of file TSFPreconditioner.hpp.
Constructor & Destructor Documentation
| TSFExtended::Preconditioner< Scalar >::Preconditioner | ( | ) | [inline] |
Empty ctor.
Definition at line 46 of file TSFPreconditioner.hpp.
| TSFExtended::Preconditioner< Scalar >::Preconditioner | ( | Handleable< PreconditionerBase< Scalar > > * | rawPtr | ) | [inline] |
Construct a Preconditioner with a raw pointer to a PreconditionerBase<Scalar>
Definition at line 46 of file TSFPreconditioner.hpp.
| TSFExtended::Preconditioner< Scalar >::Preconditioner | ( | const RefCountPtr< PreconditionerBase< Scalar > > & | smartPtr | ) | [inline] |
Construct a Preconditioner with a smart pointer to a PreconditionerBase<Scalar>
Definition at line 46 of file TSFPreconditioner.hpp.
Member Function Documentation
| void TSFExtended::Preconditioner< Scalar >::changeParameter | ( | const std::string & | name, |
| const double & | value | ||
| ) |
Change the value of a double parameter.
| void TSFExtended::Preconditioner< Scalar >::changeParameter | ( | const std::string & | name, |
| int | value | ||
| ) |
Change the value of an integer parameter.
| bool TSFExtended::Preconditioner< Scalar >::hasLeft | ( | ) | const [inline] |
return true if this preconditioner has a nontrivial left component
Definition at line 97 of file TSFPreconditioner.hpp.
Referenced by TSFExtended::Preconditioner< Scalar >::isIdentity(), TSFExtended::Preconditioner< Scalar >::isTwoSided(), TSFExtended::KrylovSolver< Scalar >::solve(), and TSFExtended::BelosSolver::solve().
| bool TSFExtended::Preconditioner< Scalar >::hasRight | ( | ) | const [inline] |
return true if this preconditioner has a nontrivial right component
Definition at line 103 of file TSFPreconditioner.hpp.
Referenced by TSFExtended::Preconditioner< Scalar >::isIdentity(), TSFExtended::Preconditioner< Scalar >::isTwoSided(), TSFExtended::KrylovSolver< Scalar >::solve(), and TSFExtended::BelosSolver::solve().
| bool TSFExtended::Preconditioner< Scalar >::isIdentity | ( | ) | const [inline] |
return true if this preconditioner has neither left nor right operators defined
Definition at line 75 of file TSFPreconditioner.hpp.
References TSFExtended::Preconditioner< Scalar >::hasLeft(), and TSFExtended::Preconditioner< Scalar >::hasRight().
| bool TSFExtended::Preconditioner< Scalar >::isTwoSided | ( | ) | const [inline] |
return true if this preconditioner has both left and right components.
Definition at line 64 of file TSFPreconditioner.hpp.
References TSFExtended::Preconditioner< Scalar >::hasLeft(), and TSFExtended::Preconditioner< Scalar >::hasRight().
| LinearOperator< Scalar > TSFExtended::Preconditioner< Scalar >::left | ( | ) | const [inline] |
Left preconditioner.
Definition at line 81 of file TSFPreconditioner.hpp.
Referenced by TSFExtended::KrylovSolver< Scalar >::solve(), and TSFExtended::BelosSolver::solve().
| LinearOperator< Scalar > TSFExtended::Preconditioner< Scalar >::right | ( | ) | const [inline] |
Right preconditioner.
Definition at line 89 of file TSFPreconditioner.hpp.
Referenced by TSFExtended::KrylovSolver< Scalar >::solve(), and TSFExtended::BelosSolver::solve().