ML_Epetra::MultiLevelOperator Class Reference

MultiLevelOperator: An implementation of the Epetra_Operator class. More...

#include <ml_MultiLevelOperator.h>

Collaboration diagram for ML_Epetra::MultiLevelOperator:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 MultiLevelOperator (ML *ml_handle, const Epetra_Comm &myComm, const Epetra_Map &DomainMap, const Epetra_Map &RangeMap)
 Uses an ML instance to implement the Epetra_Operator interface.
 ~MultiLevelOperator ()
 Destructor.
int SetOwnership (bool ownership)
 If set true, the multigrid hierarchy is destroyed when the Operator is destroyed.
int SetUseTranspose (bool UseTranspose)
 If set true, transpose of this operator will be applied.
int Apply (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
 Returns the result of a Operator applied to a Epetra_MultiVector X in Y.
int ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
 Returns the result of a Operator inverse applied to an Epetra_MultiVector X in Y.
double NormInf () const
 Returns the infinity norm of the global matrix.
const char * Label () const
 Returns a character string describing the operator.
bool UseTranspose () const
 Returns the current UseTranspose setting.
bool HasNormInf () const
 Returns true if the this object can provide an approximate Inf-norm, false otherwise.
const Epetra_Comm & Comm () const
 Returns a pointer to the Epetra_Comm communicator associated with this operator.
const Epetra_Map & OperatorDomainMap () const
 Returns the Epetra_Map object associated with the domain of this operator.
const Epetra_Map & OperatorRangeMap () const
 Returns the Epetra_Map object associated with the range of this operator.
MLsolver_
 Pointer to the ML_Structure.
char * Label_
 Label for this object.
const Epetra_Comm & Comm_
 Reference to Epetra communicator.
const Epetra_Map & DomainMap_
 Reference to Domain Map.
const Epetra_Map & RangeMap_
 Reference to Range Map.
bool ownership_
 MultiLevelOperator (const MultiLevelOperator &RHS)
 Copy constructor (NOT DEFINED).
MultiLevelOperatoroperator= (const MultiLevelOperator &RHS)
 Operator= (NOT DEFINED).


Detailed Description

MultiLevelOperator class implements Epetra_Operator using a pre-constructed ML solver object. This allows ML to be used as preconditioner within an AztecOO solver object.

Constructor & Destructor Documentation

ML_Epetra::MultiLevelOperator::MultiLevelOperator ( ML ml_handle,
const Epetra_Comm &  myComm,
const Epetra_Map &  DomainMap,
const Epetra_Map &  RangeMap 
)

This is designed for using ML as a preconditioner within an AztecOO solver instance.

Parameters:
ml_handle A fully-constructed ML object (In)
myComm - Epetra communicator (In)
DomainMap - Epetra domain map (In)
RangeMap - Epetra range map (In)

ML_Epetra::MultiLevelOperator::~MultiLevelOperator (  ) 

ML_Epetra::MultiLevelOperator::MultiLevelOperator ( const MultiLevelOperator RHS  )  [inline, private]


Member Function Documentation

int ML_Epetra::MultiLevelOperator::Apply ( const Epetra_MultiVector &  X,
Epetra_MultiVector &  Y 
) const [inline]

Parameters:
X (In) - A Epetra_MultiVector of dimension NumVectors to multiply with matrix.
Y (Out) -A Epetra_MultiVector of dimension NumVectors containing result.
Warning:
- This method has no effect and returns -1 as error code.

int ML_Epetra::MultiLevelOperator::ApplyInverse ( const Epetra_MultiVector &  X,
Epetra_MultiVector &  Y 
) const

Parameters:
X (In) - A Epetra_MultiVector of dimension NumVectors to solve for.
Y (Out) -A Epetra_MultiVector of dimension NumVectors containing result.
Returns:
Integer error code, set to 0 if successful.

const Epetra_Comm& ML_Epetra::MultiLevelOperator::Comm (  )  const [inline]

bool ML_Epetra::MultiLevelOperator::HasNormInf (  )  const [inline]

const char* ML_Epetra::MultiLevelOperator::Label (  )  const [inline]

double ML_Epetra::MultiLevelOperator::NormInf (  )  const [inline]

MultiLevelOperator& ML_Epetra::MultiLevelOperator::operator= ( const MultiLevelOperator RHS  )  [inline, private]

const Epetra_Map& ML_Epetra::MultiLevelOperator::OperatorDomainMap (  )  const [inline]

const Epetra_Map& ML_Epetra::MultiLevelOperator::OperatorRangeMap (  )  const [inline]

int ML_Epetra::MultiLevelOperator::SetOwnership ( bool  ownership  )  [inline]

This flag determines the ownership of the multigrid hierarchy. When set to true, this object owns the multigrid hierarchy and so it destroys it when freed. Otherwise, it is assumed that the multigrid hierarchy is owned by another object and so it is not freed. By default, the multigrid hierarchy is not owned by this object.

Parameters:
ownership (In) - If true, this object owns the corresponding multigrid hierarchy.

int ML_Epetra::MultiLevelOperator::SetUseTranspose ( bool  UseTranspose  )  [inline]

This flag allows the transpose of the given operator to be used implicitly. Setting this flag affects only the Apply() and ApplyInverse() methods. If the implementation of this interface does not support transpose use, this method should return a value of -1.

Parameters:
UseTranspose (In) - If true, multiply by the transpose of operator, otherwise just use operator.
Warning:
- This method has no effect and returns -1 as error code.

bool ML_Epetra::MultiLevelOperator::UseTranspose (  )  const [inline]


Member Data Documentation

const Epetra_Comm& ML_Epetra::MultiLevelOperator::Comm_ [private]

const Epetra_Map& ML_Epetra::MultiLevelOperator::DomainMap_ [private]

const Epetra_Map& ML_Epetra::MultiLevelOperator::RangeMap_ [private]


The documentation for this class was generated from the following file: