#include <Ifpack_ILU.h>
Public Member Functions | |
Ifpack_ILU (Epetra_RowMatrix *A) | |
Constructor. | |
~Ifpack_ILU () | |
Destructor. | |
int | Initialize () |
Initialize the preconditioner, does not touch matrix values. | |
bool | IsInitialized () const |
Returns true if the preconditioner has been successfully initialized. | |
int | Compute () |
Compute ILU factors L and U using the specified graph, diagonal perturbation thresholds and relaxation parameters. | |
bool | IsComputed () const |
If factor is completed, this query returns true, otherwise it returns false. | |
int | SetParameters (Teuchos::ParameterList ¶meterlist) |
Set parameters using a Teuchos::ParameterList object. | |
int | SetUseTranspose (bool UseTranspose_in) |
If set true, transpose of this operator will be applied. | |
int | Apply (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const |
int | Multiply (bool Trans, const Epetra_MultiVector &X, Epetra_MultiVector &Y) const |
int | ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const |
Returns the result of a Epetra_Operator inverse applied to an Epetra_MultiVector X in Y. | |
double | Condest (const Ifpack_CondestType CT=Ifpack_Cheap, const int MaxIters=1550, const double Tol=1e-9, Epetra_RowMatrix *Matrix_in=0) |
Computes the estimated condition number and returns the value. | |
double | Condest () const |
Returns the computed estimated condition number, or -1.0 if not computed. | |
const Epetra_CrsMatrix & | L () const |
Returns the address of the L factor associated with this factored matrix. | |
const Epetra_Vector & | D () const |
Returns the address of the D factor associated with this factored matrix. | |
const Epetra_CrsMatrix & | U () const |
Returns the address of the L factor associated with this factored matrix. | |
const char * | Label () const |
Returns a character string describing the operator. | |
int | SetLabel (const char *Label_in) |
Sets label for this object. | |
double | NormInf () const |
Returns 0.0 because this class cannot compute Inf-norm. | |
bool | HasNormInf () const |
Returns false because this class cannot compute an Inf-norm. | |
bool | UseTranspose () const |
Returns the current UseTranspose setting. | |
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. | |
const Epetra_Comm & | Comm () const |
Returns the Epetra_BlockMap object associated with the range of this matrix operator. | |
const Epetra_RowMatrix & | Matrix () const |
Returns a reference to the matrix to be preconditioned. | |
virtual ostream & | Print (ostream &os) const |
Prints on stream basic information about this object. | |
virtual int | NumInitialize () const |
Returns the number of calls to Initialize(). | |
virtual int | NumCompute () const |
Returns the number of calls to Compute(). | |
virtual int | NumApplyInverse () const |
Returns the number of calls to ApplyInverse(). | |
virtual double | InitializeTime () const |
Returns the time spent in Initialize(). | |
virtual double | ComputeTime () const |
Returns the time spent in Compute(). | |
virtual double | ApplyInverseTime () const |
Returns the time spent in ApplyInverse(). | |
virtual double | InitializeFlops () const |
Returns the number of flops in the initialization phase. | |
virtual double | ComputeFlops () const |
Returns the number of flops in the computation phase. | |
virtual double | ApplyInverseFlops () const |
Returns the number of flops in the application of the preconditioner. |
The Ifpack_ILU class computes a "Relaxed" ILU factorization with level k fill of a given Epetra_RowMatrix.
Please refer to General description of incomplete factorizations for a general description of the ILU algorithm.
The complete list of supported parameters is reported in page List of Supported Parameters.
Ifpack_ILU::Ifpack_ILU | ( | Epetra_RowMatrix * | A | ) |
Constructor.
Ifpack_ILU::~Ifpack_ILU | ( | ) | [inline] |
Destructor.
int Ifpack_ILU::Apply | ( | const Epetra_MultiVector & | X, | |
Epetra_MultiVector & | Y | |||
) | const [inline] |
int Ifpack_ILU::ApplyInverse | ( | const Epetra_MultiVector & | X, | |
Epetra_MultiVector & | Y | |||
) | const [virtual] |
Returns the result of a Epetra_Operator inverse applied to an Epetra_MultiVector X in Y.
In this implementation, we use several existing attributes to determine how virtual method ApplyInverse() should call the concrete method Solve(). We pass in the UpperTriangular(), the Epetra_CrsMatrix::UseTranspose(), and NoDiagonal() methods. The most notable warning is that if a matrix has no diagonal values we assume that there is an implicit unit diagonal that should be accounted for when doing a triangular solve.
X | - (In) A Epetra_MultiVector of dimension NumVectors to solve for. | |
Out | Y - (Out) A Epetra_MultiVector of dimension NumVectors containing result. |
Implements Ifpack_Preconditioner.
virtual double Ifpack_ILU::ApplyInverseFlops | ( | ) | const [inline, virtual] |
Returns the number of flops in the application of the preconditioner.
Implements Ifpack_Preconditioner.
virtual double Ifpack_ILU::ApplyInverseTime | ( | ) | const [inline, virtual] |
const Epetra_Comm& Ifpack_ILU::Comm | ( | ) | const [inline] |
Returns the Epetra_BlockMap object associated with the range of this matrix operator.
int Ifpack_ILU::Compute | ( | ) | [virtual] |
Compute ILU factors L and U using the specified graph, diagonal perturbation thresholds and relaxation parameters.
This function computes the ILU(k) factors L and U using the current:
Implements Ifpack_Preconditioner.
virtual double Ifpack_ILU::ComputeFlops | ( | ) | const [inline, virtual] |
virtual double Ifpack_ILU::ComputeTime | ( | ) | const [inline, virtual] |
double Ifpack_ILU::Condest | ( | ) | const [inline, virtual] |
Returns the computed estimated condition number, or -1.0 if not computed.
Implements Ifpack_Preconditioner.
double Ifpack_ILU::Condest | ( | const Ifpack_CondestType | CT = Ifpack_Cheap , |
|
const int | MaxIters = 1550 , |
|||
const double | Tol = 1e-9 , |
|||
Epetra_RowMatrix * | Matrix_in = 0 | |||
) | [virtual] |
const Epetra_Vector& Ifpack_ILU::D | ( | ) | const [inline] |
Returns the address of the D factor associated with this factored matrix.
bool Ifpack_ILU::HasNormInf | ( | ) | const [inline] |
Returns false because this class cannot compute an Inf-norm.
int Ifpack_ILU::Initialize | ( | ) | [virtual] |
virtual double Ifpack_ILU::InitializeFlops | ( | ) | const [inline, virtual] |
virtual double Ifpack_ILU::InitializeTime | ( | ) | const [inline, virtual] |
bool Ifpack_ILU::IsComputed | ( | ) | const [inline, virtual] |
If factor is completed, this query returns true, otherwise it returns false.
Implements Ifpack_Preconditioner.
bool Ifpack_ILU::IsInitialized | ( | ) | const [inline, virtual] |
Returns true
if the preconditioner has been successfully initialized.
Implements Ifpack_Preconditioner.
const Epetra_CrsMatrix& Ifpack_ILU::L | ( | ) | const [inline] |
Returns the address of the L factor associated with this factored matrix.
const char* Ifpack_ILU::Label | ( | ) | const [inline] |
Returns a character string describing the operator.
const Epetra_RowMatrix& Ifpack_ILU::Matrix | ( | ) | const [inline, virtual] |
int Ifpack_ILU::Multiply | ( | bool | Trans, | |
const Epetra_MultiVector & | X, | |||
Epetra_MultiVector & | Y | |||
) | const |
double Ifpack_ILU::NormInf | ( | ) | const [inline] |
Returns 0.0 because this class cannot compute Inf-norm.
virtual int Ifpack_ILU::NumApplyInverse | ( | ) | const [inline, virtual] |
virtual int Ifpack_ILU::NumCompute | ( | ) | const [inline, virtual] |
virtual int Ifpack_ILU::NumInitialize | ( | ) | const [inline, virtual] |
const Epetra_Map& Ifpack_ILU::OperatorDomainMap | ( | ) | const [inline] |
Returns the Epetra_Map object associated with the domain of this operator.
const Epetra_Map& Ifpack_ILU::OperatorRangeMap | ( | ) | const [inline] |
Returns the Epetra_Map object associated with the range of this operator.
virtual ostream& Ifpack_ILU::Print | ( | ostream & | os | ) | const [virtual] |
Prints on stream basic information about this
object.
int Ifpack_ILU::SetLabel | ( | const char * | Label_in | ) | [inline] |
Sets label for this
object.
int Ifpack_ILU::SetParameters | ( | Teuchos::ParameterList & | parameterlist | ) | [virtual] |
int Ifpack_ILU::SetUseTranspose | ( | bool | UseTranspose_in | ) | [inline] |
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 | - (In) If true, multiply by the transpose of operator, otherwise just use operator. |
const Epetra_CrsMatrix& Ifpack_ILU::U | ( | ) | const [inline] |
Returns the address of the L factor associated with this factored matrix.
bool Ifpack_ILU::UseTranspose | ( | ) | const [inline] |
Returns the current UseTranspose setting.