ML
Version of the Day
|
MultiLevelOperator: An implementation of the Epetra_Operator class. More...
#include <ml_MultiLevelOperator.h>
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. More... | |
~MultiLevelOperator () | |
Destructor. | |
int | SetOwnership (bool ownership) |
If set true, the multigrid hierarchy is destroyed when the Operator is destroyed. More... | |
int | SetUseTranspose (bool UseTrans) |
If set true, transpose of this operator will be applied. More... | |
int | Apply (const Epetra_MultiVector &, Epetra_MultiVector &) const |
Returns the result of a Operator applied to a Epetra_MultiVector X in Y. More... | |
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. More... | |
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. | |
ML * | solver_ |
Pointer to the ML_Structure. | |
const char * | Label_ |
Label for this object. | |
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.
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.
ml_handle | A fully-constructed ML object (In) |
myComm | - Epetra communicator (In) |
DomainMap | - Epetra domain map (In) |
RangeMap | - Epetra range map (In) |
|
inlinevirtual |
Returns the result of a Operator applied to a Epetra_MultiVector X in Y.
X | (In) - A Epetra_MultiVector of dimension NumVectors to multiply with matrix. |
Y | (Out) -A Epetra_MultiVector of dimension NumVectors containing result. |
Implements Epetra_Operator.
|
virtual |
Returns the result of a Operator inverse applied to an Epetra_MultiVector X in Y.
X | (In) - A Epetra_MultiVector of dimension NumVectors to solve for. |
Y | (Out) -A Epetra_MultiVector of dimension NumVectors containing result. |
Implements Epetra_Operator.
|
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.
ownership | (In) - If true, this object owns the corresponding multigrid hierarchy. |
|
inlinevirtual |
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.
UseTranspose | (In) - If true, multiply by the transpose of operator, otherwise just use operator. |
Implements Epetra_Operator.