Playa::GenericRightPreconditioner< Scalar > Class Template Reference
#include <PlayaGenericRightPreconditioner.hpp>
Public Member Functions | |
| GenericRightPreconditioner (const LinearOperator< Scalar > &right) | |
| virtual | ~GenericRightPreconditioner () |
| virtual LinearOperator< Scalar > | right () const |
| virtual LinearOperator< Scalar > | left () const |
| virtual bool | hasRight () const |
| virtual bool | hasLeft () const |
| virtual Teuchos::RCP < PreconditionerBase< Scalar > > | getRcp () |
Detailed Description
template<class Scalar>
class Playa::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 23 of file PlayaGenericRightPreconditioner.hpp.
Constructor & Destructor Documentation
| Playa::GenericRightPreconditioner< Scalar >::GenericRightPreconditioner | ( | const LinearOperator< Scalar > & | right | ) | [inline] |
construct with an operator for the right preconditioner
Definition at line 27 of file PlayaGenericRightPreconditioner.hpp.
| virtual Playa::GenericRightPreconditioner< Scalar >::~GenericRightPreconditioner | ( | ) | [inline, virtual] |
virtual dtor
Definition at line 31 of file PlayaGenericRightPreconditioner.hpp.
Member Function Documentation
| virtual LinearOperator<Scalar> Playa::GenericRightPreconditioner< Scalar >::right | ( | ) | const [inline, virtual] |
Return the right operator
Implements Playa::PreconditionerBase< Scalar >.
Definition at line 35 of file PlayaGenericRightPreconditioner.hpp.
| virtual LinearOperator<Scalar> Playa::GenericRightPreconditioner< Scalar >::left | ( | ) | const [inline, virtual] |
A call to left() results in an error for a right precond.
Implements Playa::PreconditionerBase< Scalar >.
Definition at line 38 of file PlayaGenericRightPreconditioner.hpp.
| virtual bool Playa::GenericRightPreconditioner< Scalar >::hasRight | ( | ) | const [inline, virtual] |
return true because this preconditioner has a nontrivial right component.
Implements Playa::PreconditionerBase< Scalar >.
Definition at line 47 of file PlayaGenericRightPreconditioner.hpp.
| virtual bool Playa::GenericRightPreconditioner< Scalar >::hasLeft | ( | ) | const [inline, virtual] |
return false, because this preconditioner has no nontrivial left component
Implements Playa::PreconditionerBase< Scalar >.
Definition at line 51 of file PlayaGenericRightPreconditioner.hpp.
| virtual Teuchos::RCP< PreconditionerBase<Scalar> > Playa::GenericRightPreconditioner< Scalar >::getRcp | ( | ) | [inline, virtual] |
Handleable<PreconditionerBase<Scalar> > interface
Implements Playa::Handleable< PreconditionerBase< Scalar > >.
Definition at line 54 of file PlayaGenericRightPreconditioner.hpp.
The documentation for this class was generated from the following file:
