#include <Ifpack_CrsIct.h>
Inheritance diagram for Ifpack_CrsIct:
const char * | Label () const |
Returns a character string describing the operator. | |
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 |
Returns the result of a Epetra_Operator applied to a Epetra_MultiVector X in Y. | |
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 | 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. | |
Public Member Functions | |
Ifpack_CrsIct (const Epetra_CrsMatrix &A, double Droptol=1.0E-4, int Lfil=20) | |
Ifpack_CrsIct constuctor with variable number of indices per row. | |
Ifpack_CrsIct (const Ifpack_CrsIct &IctOperator) | |
Copy constructor. | |
virtual | ~Ifpack_CrsIct () |
Ifpack_CrsIct Destructor. | |
void | SetAbsoluteThreshold (double Athresh) |
Set absolute threshold value. | |
void | SetRelativeThreshold (double Rthresh) |
Set relative threshold value. | |
void | SetOverlapMode (Epetra_CombineMode OverlapMode) |
Set overlap mode type. | |
int | SetParameters (const Teuchos::ParameterList ¶meterlist, bool cerr_warning_if_unused=false) |
Set parameters using a Teuchos::ParameterList object. | |
int | InitValues (const Epetra_CrsMatrix &A) |
Initialize L and U with values from user matrix A. | |
bool | ValuesInitialized () const |
If values have been initialized, this query returns true, otherwise it returns false. | |
int | Factor () |
Compute IC factor U using the specified graph, diagonal perturbation thresholds and relaxation parameters. | |
bool | Factored () const |
If factor is completed, this query returns true, otherwise it returns false. | |
int | Solve (bool Trans, const Epetra_MultiVector &X, Epetra_MultiVector &Y) const |
Returns the result of a Ifpack_CrsIct forward/back solve on a Epetra_MultiVector X in Y. | |
int | Multiply (bool Trans, const Epetra_MultiVector &X, Epetra_MultiVector &Y) const |
Returns the result of multiplying U, D and U^T in that order on an Epetra_MultiVector X in Y. | |
int | Condest (bool Trans, double &ConditionNumberEstimate) const |
Returns the maximum over all the condition number estimate for each local ILU set of factors. | |
double | GetAbsoluteThreshold () |
Get absolute threshold value. | |
double | GetRelativeThreshold () |
Get relative threshold value. | |
Epetra_CombineMode | GetOverlapMode () |
Get overlap mode type. | |
int | NumGlobalNonzeros () const |
Returns the number of nonzero entries in the global graph. | |
int | NumMyNonzeros () const |
Returns the number of nonzero entries in the local graph. | |
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 U factor associated with this factored matrix. | |
Protected Member Functions | |
void | SetFactored (bool Flag) |
void | SetValuesInitialized (bool Flag) |
bool | Allocated () const |
int | SetAllocated (bool Flag) |
Private Member Functions | |
int | Allocate () |
Private Attributes | |
const Epetra_CrsMatrix & | A_ |
const Epetra_Comm & | Comm_ |
Teuchos::RefCountPtr< Epetra_CrsMatrix > | U_ |
Teuchos::RefCountPtr< Epetra_Vector > | D_ |
bool | UseTranspose_ |
bool | Allocated_ |
bool | ValuesInitialized_ |
bool | Factored_ |
double | Condest_ |
double | Athresh_ |
double | Rthresh_ |
double | Droptol_ |
int | Lfil_ |
Teuchos::RefCountPtr< Epetra_MultiVector > | OverlapX_ |
Teuchos::RefCountPtr< Epetra_MultiVector > | OverlapY_ |
int | LevelOverlap_ |
Epetra_CombineMode | OverlapMode_ |
void * | Aict_ |
void * | Lict_ |
double * | Ldiag_ |
Friends | |
ostream & | operator<< (ostream &os, const Ifpack_CrsIct &A) |
<< operator will work for Ifpack_CrsIct. |
The Ifpack_CrsIct class computes a threshold based incomplete LDL^T factorization of a given Epetra_CrsMatrix. The factorization that is produced is a function of several parameters:
Estimating Preconditioner Condition Numbers
For ill-conditioned matrices, we often have difficulty computing usable incomplete factorizations. The most common source of problems is that the factorization may encounter a small or zero pivot, in which case the factorization can fail, or even if the factorization succeeds, the factors may be so poorly conditioned that use of them in the iterative phase produces meaningless results. Before we can fix this problem, we must be able to detect it. To this end, we use a simple but effective condition number estimate for .
The condition of a matrix , called , is defined as in some appropriate norm . gives some indication of how many accurate floating point digits can be expected from operations involving the matrix and its inverse. A condition number approaching the accuracy of a given floating point number system, about 15 decimal digits in IEEE double precision, means that any results involving or may be meaningless.
The -norm of a vector is defined as the maximum of the absolute values of the vector entries, and the -norm of a matrix C is defined as . A crude lower bound for the is where . It is a lower bound because .
For our purposes, we want to estimate , where and are our incomplete factors. Edmond in his Ph.D. thesis demonstrates that provides an effective estimate for . Furthermore, since finding such that is a basic kernel for applying the preconditioner, computing this estimate of is performed by setting , calling the solve kernel to compute and then computing .
A priori Diagonal Perturbations
Given the above method to estimate the conditioning of the incomplete factors, if we detect that our factorization is too ill-conditioned we can improve the conditioning by perturbing the matrix diagonal and restarting the factorization using this more diagonally dominant matrix. In order to apply perturbation, prior to starting the factorization, we compute a diagonal perturbation of our matrix and perform the factorization on this perturbed matrix. The overhead cost of perturbing the diagonal is minimal since the first step in computing the incomplete factors is to copy the matrix into the memory space for the incomplete factors. We simply compute the perturbed diagonal at this point.
The actual perturbation values we use are the diagonal values with , , where is the matrix dimension and returns the sign of the diagonal entry. This has the effect of forcing the diagonal values to have minimal magnitude of and to increase each by an amount proportional to , and still keep the sign of the original diagonal entry.
Constructing Ifpack_CrsIct objects
Constructing Ifpack_CrsIct objects is a multi-step process. The basic steps are as follows:
Note that, even after a matrix is constructed, it is possible to update existing matrix entries. It is not possible to create new entries.
Counting Floating Point Operations
Each Ifpack_CrsIct object keep track of the number of serial floating point operations performed using the specified object as the this argument to the function. The Flops() function returns this number as a double precision number. Using this information, in conjunction with the Epetra_Time class, one can get accurate parallel performance numbers. The ResetFlops() function resets the floating point counter.
Definition at line 157 of file Ifpack_CrsIct.h.
Ifpack_CrsIct::Ifpack_CrsIct | ( | const Epetra_CrsMatrix & | A, | |
double | Droptol = 1.0E-4 , |
|||
int | Lfil = 20 | |||
) |
Ifpack_CrsIct constuctor with variable number of indices per row.
Creates a Ifpack_CrsIct object and allocates storage.
In | A - User matrix to be factored. | |
In | Graph - Graph generated by Ifpack_IlukGraph. |
Definition at line 44 of file Ifpack_CrsIct.cpp.
Ifpack_CrsIct::Ifpack_CrsIct | ( | const Ifpack_CrsIct & | IctOperator | ) |
Ifpack_CrsIct::~Ifpack_CrsIct | ( | ) | [virtual] |
void Ifpack_CrsIct::SetAbsoluteThreshold | ( | double | Athresh | ) | [inline] |
void Ifpack_CrsIct::SetRelativeThreshold | ( | double | Rthresh | ) | [inline] |
void Ifpack_CrsIct::SetOverlapMode | ( | Epetra_CombineMode | OverlapMode | ) | [inline] |
int Ifpack_CrsIct::SetParameters | ( | const Teuchos::ParameterList & | parameterlist, | |
bool | cerr_warning_if_unused = false | |||
) |
Set parameters using a Teuchos::ParameterList object.
Definition at line 128 of file Ifpack_CrsIct.cpp.
int Ifpack_CrsIct::InitValues | ( | const Epetra_CrsMatrix & | A | ) |
Initialize L and U with values from user matrix A.
Copies values from the user's matrix into the nonzero pattern of L and U.
In | A - User matrix to be factored. |
Definition at line 150 of file Ifpack_CrsIct.cpp.
bool Ifpack_CrsIct::ValuesInitialized | ( | ) | const [inline] |
If values have been initialized, this query returns true, otherwise it returns false.
Definition at line 210 of file Ifpack_CrsIct.h.
int Ifpack_CrsIct::Factor | ( | ) |
Compute IC factor U using the specified graph, diagonal perturbation thresholds and relaxation parameters.
This function computes the RILU(k) factors L and U using the current:
Definition at line 227 of file Ifpack_CrsIct.cpp.
bool Ifpack_CrsIct::Factored | ( | ) | const [inline] |
If factor is completed, this query returns true, otherwise it returns false.
Definition at line 224 of file Ifpack_CrsIct.h.
int Ifpack_CrsIct::Solve | ( | bool | Trans, | |
const Epetra_MultiVector & | X, | |||
Epetra_MultiVector & | Y | |||
) | const |
Returns the result of a Ifpack_CrsIct forward/back solve on a Epetra_MultiVector X in Y.
In | Trans -If true, solve transpose problem. | |
In | X - A Epetra_MultiVector of dimension NumVectors to solve for. | |
Out | Y -A Epetra_MultiVector of dimension NumVectorscontaining result. |
Definition at line 314 of file Ifpack_CrsIct.cpp.
int Ifpack_CrsIct::Multiply | ( | bool | Trans, | |
const Epetra_MultiVector & | X, | |||
Epetra_MultiVector & | Y | |||
) | const |
Returns the result of multiplying U, D and U^T in that order on an Epetra_MultiVector X in Y.
In | Trans -If true, multiply by L^T, D and U^T in that order. | |
In | X - A Epetra_MultiVector of dimension NumVectors to solve for. | |
Out | Y -A Epetra_MultiVector of dimension NumVectorscontaining result. |
Definition at line 335 of file Ifpack_CrsIct.cpp.
int Ifpack_CrsIct::Condest | ( | bool | Trans, | |
double & | ConditionNumberEstimate | |||
) | const |
Returns the maximum over all the condition number estimate for each local ILU set of factors.
This functions computes a local condition number estimate on each processor and return the maximum over all processor of the estimate.
In | Trans -If true, solve transpose problem. | |
Out | ConditionNumberEstimate - The maximum across all processors of the infinity-norm estimate of the condition number of the inverse of LDU. |
Definition at line 359 of file Ifpack_CrsIct.cpp.
double Ifpack_CrsIct::GetAbsoluteThreshold | ( | ) | [inline] |
double Ifpack_CrsIct::GetRelativeThreshold | ( | ) | [inline] |
Epetra_CombineMode Ifpack_CrsIct::GetOverlapMode | ( | ) | [inline] |
int Ifpack_CrsIct::NumGlobalNonzeros | ( | ) | const [inline] |
Returns the number of nonzero entries in the global graph.
Definition at line 278 of file Ifpack_CrsIct.h.
int Ifpack_CrsIct::NumMyNonzeros | ( | ) | const [inline] |
Returns the number of nonzero entries in the local graph.
Definition at line 281 of file Ifpack_CrsIct.h.
const Epetra_Vector& Ifpack_CrsIct::D | ( | ) | const [inline] |
Returns the address of the D factor associated with this factored matrix.
Definition at line 283 of file Ifpack_CrsIct.h.
const Epetra_CrsMatrix& Ifpack_CrsIct::U | ( | ) | const [inline] |
Returns the address of the U factor associated with this factored matrix.
Definition at line 286 of file Ifpack_CrsIct.h.
const char* Ifpack_CrsIct::Label | ( | ) | const [inline, virtual] |
Returns a character string describing the operator.
Reimplemented from Epetra_Object.
Definition at line 291 of file Ifpack_CrsIct.h.
int Ifpack_CrsIct::SetUseTranspose | ( | bool | UseTranspose_in | ) | [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.
In | UseTranspose_in -If true, multiply by the transpose of operator, otherwise just use operator. |
Implements Epetra_Operator.
Definition at line 303 of file Ifpack_CrsIct.h.
int Ifpack_CrsIct::Apply | ( | const Epetra_MultiVector & | X, | |
Epetra_MultiVector & | Y | |||
) | const [inline, virtual] |
Returns the result of a Epetra_Operator applied to a Epetra_MultiVector X in Y.
Note that this implementation of Apply does NOT perform a forward back solve with the LDU factorization. Instead it applies these operators via multiplication with U, D and L respectively. The ApplyInverse() method performs a solve.
In | X - A Epetra_MultiVector of dimension NumVectors to multiply with matrix. | |
Out | Y -A Epetra_MultiVector of dimension NumVectors containing result. |
Implements Epetra_Operator.
Definition at line 317 of file Ifpack_CrsIct.h.
int Ifpack_CrsIct::ApplyInverse | ( | const Epetra_MultiVector & | X, | |
Epetra_MultiVector & | Y | |||
) | const [inline, 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.
In | X - A Epetra_MultiVector of dimension NumVectors to solve for. | |
Out | Y -A Epetra_MultiVector of dimension NumVectors containing result. |
Implements Epetra_Operator.
Definition at line 334 of file Ifpack_CrsIct.h.
double Ifpack_CrsIct::NormInf | ( | ) | const [inline, virtual] |
Returns 0.0 because this class cannot compute Inf-norm.
Implements Epetra_Operator.
Definition at line 338 of file Ifpack_CrsIct.h.
bool Ifpack_CrsIct::HasNormInf | ( | ) | const [inline, virtual] |
Returns false because this class cannot compute an Inf-norm.
Implements Epetra_Operator.
Definition at line 341 of file Ifpack_CrsIct.h.
bool Ifpack_CrsIct::UseTranspose | ( | ) | const [inline, virtual] |
Returns the current UseTranspose setting.
Implements Epetra_Operator.
Definition at line 344 of file Ifpack_CrsIct.h.
const Epetra_Map& Ifpack_CrsIct::OperatorDomainMap | ( | ) | const [inline, virtual] |
Returns the Epetra_Map object associated with the domain of this operator.
Implements Epetra_Operator.
Definition at line 347 of file Ifpack_CrsIct.h.
const Epetra_Map& Ifpack_CrsIct::OperatorRangeMap | ( | ) | const [inline, virtual] |
Returns the Epetra_Map object associated with the range of this operator.
Implements Epetra_Operator.
Definition at line 350 of file Ifpack_CrsIct.h.
const Epetra_Comm& Ifpack_CrsIct::Comm | ( | ) | const [inline, virtual] |
Returns the Epetra_BlockMap object associated with the range of this matrix operator.
Implements Epetra_Operator.
Definition at line 353 of file Ifpack_CrsIct.h.
void Ifpack_CrsIct::SetFactored | ( | bool | Flag | ) | [inline, protected] |
Definition at line 357 of file Ifpack_CrsIct.h.
void Ifpack_CrsIct::SetValuesInitialized | ( | bool | Flag | ) | [inline, protected] |
Definition at line 358 of file Ifpack_CrsIct.h.
bool Ifpack_CrsIct::Allocated | ( | ) | const [inline, protected] |
Definition at line 359 of file Ifpack_CrsIct.h.
int Ifpack_CrsIct::SetAllocated | ( | bool | Flag | ) | [inline, protected] |
Definition at line 360 of file Ifpack_CrsIct.h.
int Ifpack_CrsIct::Allocate | ( | ) | [private] |
Definition at line 89 of file Ifpack_CrsIct.cpp.
ostream& operator<< | ( | ostream & | os, | |
const Ifpack_CrsIct & | A | |||
) | [friend] |
const Epetra_CrsMatrix& Ifpack_CrsIct::A_ [private] |
Definition at line 367 of file Ifpack_CrsIct.h.
const Epetra_Comm& Ifpack_CrsIct::Comm_ [private] |
Definition at line 368 of file Ifpack_CrsIct.h.
Definition at line 369 of file Ifpack_CrsIct.h.
Teuchos::RefCountPtr<Epetra_Vector> Ifpack_CrsIct::D_ [private] |
Definition at line 370 of file Ifpack_CrsIct.h.
bool Ifpack_CrsIct::UseTranspose_ [private] |
Definition at line 371 of file Ifpack_CrsIct.h.
bool Ifpack_CrsIct::Allocated_ [private] |
Definition at line 374 of file Ifpack_CrsIct.h.
bool Ifpack_CrsIct::ValuesInitialized_ [private] |
Definition at line 375 of file Ifpack_CrsIct.h.
bool Ifpack_CrsIct::Factored_ [private] |
Definition at line 376 of file Ifpack_CrsIct.h.
double Ifpack_CrsIct::Condest_ [mutable, private] |
Definition at line 377 of file Ifpack_CrsIct.h.
double Ifpack_CrsIct::Athresh_ [private] |
Definition at line 378 of file Ifpack_CrsIct.h.
double Ifpack_CrsIct::Rthresh_ [private] |
Definition at line 379 of file Ifpack_CrsIct.h.
double Ifpack_CrsIct::Droptol_ [private] |
Definition at line 380 of file Ifpack_CrsIct.h.
int Ifpack_CrsIct::Lfil_ [private] |
Definition at line 381 of file Ifpack_CrsIct.h.
Teuchos::RefCountPtr<Epetra_MultiVector> Ifpack_CrsIct::OverlapX_ [mutable, private] |
Definition at line 383 of file Ifpack_CrsIct.h.
Teuchos::RefCountPtr<Epetra_MultiVector> Ifpack_CrsIct::OverlapY_ [mutable, private] |
Definition at line 384 of file Ifpack_CrsIct.h.
int Ifpack_CrsIct::LevelOverlap_ [private] |
Definition at line 385 of file Ifpack_CrsIct.h.
Definition at line 386 of file Ifpack_CrsIct.h.
void* Ifpack_CrsIct::Aict_ [private] |
Definition at line 388 of file Ifpack_CrsIct.h.
void* Ifpack_CrsIct::Lict_ [private] |
Definition at line 389 of file Ifpack_CrsIct.h.
double* Ifpack_CrsIct::Ldiag_ [private] |
Definition at line 390 of file Ifpack_CrsIct.h.