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