A one-size-fits-most right preconditioner that can be constructed by accepting an operator for the right op of the preconditioner. More...
Public Member Functions | |
| GenericRightPreconditioner (const LinearOperator< Scalar > &right) | |
| construct with an operator for the right preconditioner | |
| virtual | ~GenericRightPreconditioner () |
| virtual dtor | |
| virtual LinearOperator< Scalar > | right () const |
| Return the right operator. | |
| virtual LinearOperator< Scalar > | left () const |
| A call to left() results in an error for a right precond. | |
| virtual bool | hasRight () const |
| return true because this preconditioner has a nontrivial right component. | |
| virtual bool | hasLeft () const |
| return false, because this preconditioner has no nontrivial left component | |
Private Attributes | |
Handleable interface | |
| LinearOperator< Scalar > | right_ |
Detailed Description
template<class Scalar>
class TSFExtended::GenericRightPreconditioner< Scalar >
A one-size-fits-most right preconditioner that can be constructed by accepting an operator for the right op of the preconditioner.
Definition at line 47 of file TSFGenericRightPreconditioner.hpp.
Constructor & Destructor Documentation
| TSFExtended::GenericRightPreconditioner< Scalar >::GenericRightPreconditioner | ( | const LinearOperator< Scalar > & | right | ) | [inline] |
construct with an operator for the right preconditioner
Definition at line 51 of file TSFGenericRightPreconditioner.hpp.
| virtual TSFExtended::GenericRightPreconditioner< Scalar >::~GenericRightPreconditioner | ( | ) | [inline, virtual] |
virtual dtor
Definition at line 55 of file TSFGenericRightPreconditioner.hpp.
Member Function Documentation
| virtual bool TSFExtended::GenericRightPreconditioner< Scalar >::hasLeft | ( | ) | const [inline, virtual] |
return false, because this preconditioner has no nontrivial left component
Implements TSFExtended::PreconditionerBase< Scalar >.
Definition at line 75 of file TSFGenericRightPreconditioner.hpp.
| virtual bool TSFExtended::GenericRightPreconditioner< Scalar >::hasRight | ( | ) | const [inline, virtual] |
return true because this preconditioner has a nontrivial right component.
Implements TSFExtended::PreconditionerBase< Scalar >.
Definition at line 71 of file TSFGenericRightPreconditioner.hpp.
| virtual LinearOperator<Scalar> TSFExtended::GenericRightPreconditioner< Scalar >::left | ( | ) | const [inline, virtual] |
A call to left() results in an error for a right precond.
Implements TSFExtended::PreconditionerBase< Scalar >.
Definition at line 62 of file TSFGenericRightPreconditioner.hpp.
| virtual LinearOperator<Scalar> TSFExtended::GenericRightPreconditioner< Scalar >::right | ( | ) | const [inline, virtual] |
Return the right operator.
Implements TSFExtended::PreconditionerBase< Scalar >.
Definition at line 59 of file TSFGenericRightPreconditioner.hpp.
References TSFExtended::GenericRightPreconditioner< Scalar >::right_.
Member Data Documentation
LinearOperator<Scalar> TSFExtended::GenericRightPreconditioner< Scalar >::right_ [private] |
Definition at line 81 of file TSFGenericRightPreconditioner.hpp.
Referenced by TSFExtended::GenericRightPreconditioner< Scalar >::right().