LOCA::Epetra::LeftPreconditionedOp Class Reference

An Epetra operator for implementing the operator $P = M^{-1}J$. More...

#include <LOCA_Epetra_LeftPreconditionedOp.H>

Inheritance diagram for LOCA::Epetra::LeftPreconditionedOp:
Inheritance graph
[legend]
Collaboration diagram for LOCA::Epetra::LeftPreconditionedOp:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 LeftPreconditionedOp (const Teuchos::RCP< Epetra_Operator > &jacOperator, const Teuchos::RCP< Epetra_Operator > &precOperator)
 Constructor.
virtual ~LeftPreconditionedOp ()
 Destructor.
virtual int SetUseTranspose (bool UseTranspose)
 Set to true if the transpose of the operator is requested.
virtual int Apply (const Epetra_MultiVector &Input, Epetra_MultiVector &Result) const
 Returns the result of a Epetra_Operator applied to a Epetra_MultiVector Input in Result as described above.
virtual int ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
 Returns the result of the inverse of the operator applied to a Epetra_MultiVector Input in Result as described above.
virtual double NormInf () const
 Returns an approximate infinity norm of the operator matrix.
virtual const char * Label () const
 Returns a character string describing the operator.
virtual bool UseTranspose () const
 Returns the current UseTranspose setting.
virtual bool HasNormInf () const
 Returns true if the this object can provide an approximate Inf-norm, false otherwise.
virtual const Epetra_CommComm () const
 Returns a reference to the Epetra_Comm communicator associated with this operator.
virtual const Epetra_MapOperatorDomainMap () const
 Returns the Epetra_Map object associated with the domain of this matrix operator.
virtual const Epetra_MapOperatorRangeMap () const
 Returns the Epetra_Map object associated with the range of this matrix operator.

Protected Attributes

string label
 Label for operator.
Teuchos::RCP< Epetra_OperatorJ
 Stores operator representing J.
Teuchos::RCP< Epetra_OperatorM
 Stores operator representing M.
bool useTranspose
 Flag indicating whether to use the transpose.

Detailed Description

An Epetra operator for implementing the operator $P = M^{-1}J$.

This class implements the Epetra_Operator interface for $P = M^{-1}J$ where $J$ and $M$ are Epetra_Operator's.


Constructor & Destructor Documentation

LOCA::Epetra::LeftPreconditionedOp::LeftPreconditionedOp ( const Teuchos::RCP< Epetra_Operator > &  jacOperator,
const Teuchos::RCP< Epetra_Operator > &  precOperator 
)

Constructor.

Parameters:
jacOperator [in] Jacobian operator J
precOperator [in] Preconditioner operator M

Member Function Documentation

double LOCA::Epetra::LeftPreconditionedOp::NormInf (  )  const [virtual]

Returns an approximate infinity norm of the operator matrix.

This is defined only if NormInf() of the underlying operators $J$ and $M$ is defined and is given by $\|J\|_\infty+\|M\|_\infty$.

Implements Epetra_Operator.

References J, and M.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Generated on Wed Apr 13 09:59:42 2011 for NOX by  doxygen 1.6.3