ML Version of the Day
ML_Epetra::MultiLevelOperator Class Reference

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

#include <ml_MultiLevelOperator.h>

Inheritance diagram for ML_Epetra::MultiLevelOperator:
Inheritance graph
[legend]
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_CommComm () const
 Returns a pointer to the Epetra_Comm communicator associated with this operator.
const Epetra_MapOperatorDomainMap () const
 Returns the Epetra_Map object associated with the domain of this operator.
const Epetra_MapOperatorRangeMap () 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.

Detailed Description

MultiLevelOperator: An implementation of the Epetra_Operator class.

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 
)

Uses an ML instance to implement the Epetra_Operator interface.

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

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

Member Function Documentation

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

Returns the result of a Operator applied to a Epetra_MultiVector X in Y.

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.

Implements Epetra_Operator.

int ML_Epetra::MultiLevelOperator::ApplyInverse ( const Epetra_MultiVector X,
Epetra_MultiVector Y 
) const [virtual]

Returns the result of a Operator inverse applied to an Epetra_MultiVector X in Y.

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.

Implements Epetra_Operator.

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

If set true, the multigrid hierarchy is destroyed when the Operator is destroyed.

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, virtual]

If set true, transpose of this operator will be applied.

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.

Implements Epetra_Operator.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends