Playa::InverseOperator< Scalar > Class Template Reference
#include <PlayaInverseOperatorDecl.hpp>
Inheritance diagram for Playa::InverseOperator< Scalar >:
Public Member Functions | |
| InverseOperator (const LinearOperator< Scalar > &op, const LinearSolver< Scalar > &solver) | |
| virtual | ~InverseOperator () |
| virtual void | apply (Teuchos::ETransp applyType, const Vector< Scalar > &in, Vector< Scalar > out) const |
| void | print (std::ostream &os) const |
| LinearOperator< Scalar > | op () const |
Detailed Description
template<class Scalar>
class Playa::InverseOperator< Scalar >
PlayaInverseOperator represents the inverse of some other operator. An inverse operator object will contain an operator and a solver. The operator data member is the operator whose inverse this represents. The solver data member is the solver that will be used in applying the inverse. If the solver is null, the operator is assumed to have self-contained ability to solve systems, as for a dense matrix that does solves by factoring and backsolves.
Definition at line 29 of file PlayaInverseOperatorDecl.hpp.
Constructor & Destructor Documentation
template<class Scalar >
| Playa::InverseOperator< Scalar >::InverseOperator | ( | const LinearOperator< Scalar > & | op, | |
| const LinearSolver< Scalar > & | solver | |||
| ) | [inline] |
Ctor with a linear operator and a solver specified.
Definition at line 30 of file PlayaInverseOperatorImpl.hpp.
template<class Scalar>
| virtual Playa::InverseOperator< Scalar >::~InverseOperator | ( | ) | [inline, virtual] |
Virtual dtor
Definition at line 40 of file PlayaInverseOperatorDecl.hpp.
Member Function Documentation
template<class Scalar >
| void Playa::InverseOperator< Scalar >::apply | ( | Teuchos::ETransp | applyType, | |
| const Vector< Scalar > & | in, | |||
| Vector< Scalar > | out | |||
| ) | const [inline, virtual] |
Apply the operator.
- Parameters:
-
applyType Indicates whether to apply the operator, its transpose, or its conjugate transpose. in The vector on which the operator is to act out The vector into which the result of the operation is to be written. This vector should already be initialized by the appropriate space.
Implements Playa::LinearOperatorBase< Scalar >.
Definition at line 37 of file PlayaInverseOperatorImpl.hpp.
template<class Scalar >
| void Playa::InverseOperator< Scalar >::print | ( | std::ostream & | os | ) | const [inline, virtual] |
template<class Scalar>
| LinearOperator<Scalar> Playa::InverseOperator< Scalar >::op | ( | ) | const [inline] |
Definition at line 63 of file PlayaInverseOperatorDecl.hpp.
The documentation for this class was generated from the following files:
