MultiLevelOperator: An implementation of the Epetra_Operator class.
More...
#include <ml_MultiLevelOperator.h>
|
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.
◆ MultiLevelOperator()
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_handle | A fully-constructed ML object (In) |
myComm | - Epetra communicator (In) |
DomainMap | - Epetra domain map (In) |
RangeMap | - Epetra range map (In) |
◆ Apply()
Returns the result of a Operator applied to a Epetra_MultiVector X in Y.
- Parameters
-
- Warning
- - This method has no effect and returns -1 as error code.
Implements Epetra_Operator.
◆ ApplyInverse()
Returns the result of a Operator inverse applied to an Epetra_MultiVector X in Y.
- Parameters
-
- Returns
- Integer error code, set to 0 if successful.
Implements Epetra_Operator.
◆ Comm()
const Epetra_Comm & ML_Epetra::MultiLevelOperator::Comm |
( |
| ) |
const |
|
inlinevirtual |
◆ HasNormInf()
bool ML_Epetra::MultiLevelOperator::HasNormInf |
( |
| ) |
const |
|
inlinevirtual |
Returns true if the this object can provide an approximate Inf-norm, false otherwise.
Implements Epetra_Operator.
◆ Label()
const char * ML_Epetra::MultiLevelOperator::Label |
( |
| ) |
const |
|
inlinevirtual |
◆ NormInf()
double ML_Epetra::MultiLevelOperator::NormInf |
( |
| ) |
const |
|
inlinevirtual |
Returns the infinity norm of the global matrix.
Implements Epetra_Operator.
◆ OperatorDomainMap()
const Epetra_Map & ML_Epetra::MultiLevelOperator::OperatorDomainMap |
( |
| ) |
const |
|
inlinevirtual |
◆ OperatorRangeMap()
const Epetra_Map & ML_Epetra::MultiLevelOperator::OperatorRangeMap |
( |
| ) |
const |
|
inlinevirtual |
◆ SetOwnership()
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. |
◆ SetUseTranspose()
int ML_Epetra::MultiLevelOperator::SetUseTranspose |
( |
bool | UseTrans | ) |
|
|
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.
- 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.
◆ UseTranspose()
bool ML_Epetra::MultiLevelOperator::UseTranspose |
( |
| ) |
const |
|
inlinevirtual |
The documentation for this class was generated from the following file: