#include <Ifpack_ICT.h>
Public Member Functions | |
Ifpack_ICT (const Epetra_RowMatrix *A) | |
Ifpack_ICT constuctor with variable number of indices per row. | |
virtual | ~Ifpack_ICT () |
Ifpack_ICT Destructor. | |
int | SetParameters (Teuchos::ParameterList ¶meterlis) |
Set parameters using a Teuchos::ParameterList object. | |
const Epetra_RowMatrix & | Matrix () const |
Returns a reference to the matrix to be preconditioned. | |
bool | IsInitialized () const |
Returns true is the preconditioner has been successfully initialized. | |
int | Initialize () |
Initialize L and U with values from user matrix A. | |
int | Compute () |
Compute IC factor 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 | ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const |
Returns the result of a Ifpack_ICT forward/back solve on a Epetra_MultiVector X in Y. | |
int | Apply (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const |
double | Condest (const Ifpack_CondestType CT=Ifpack_Cheap, const int MaxIters=1550, const double Tol=1e-9, Epetra_RowMatrix *Matrix_in=0) |
Returns the maximum over all the condition number estimate for each local ILU set of factors. | |
double | Condest () const |
Returns the computed condition number estimate, or -1.0 if not computed. | |
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_CrsMatrix & | H () const |
Returns the address of the D factor associated with this factored matrix. | |
const char * | Label () const |
int | SetLabel (const char *Label_in) |
virtual ostream & | Print (std::ostream &os) const |
Prints basic information on iostream. This function is used by operator<<. | |
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 all applications of Compute(). | |
virtual double | ApplyInverseFlops () const |
Returns the number of flops in all applications of ApplyInverse(). | |
double | LevelOfFill () const |
Returns the level-of-fill. | |
double | AbsoluteThreshold () const |
Returns the absolute threshold. | |
double | RelativeThreshold () const |
Returns the relative threshold. | |
double | RelaxValue () const |
Returns the relaxation value. | |
double | DropTolerance () const |
Returns the drop threshold. | |
int | SetUseTranspose (bool UseTranspose_in) |
If set true, transpose of this operator will be applied. | |
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. |
The Ifpack_ICT class computes a threshold based incomplete LDL^T factorization of a given Epetra_RowMatrix. The factorization that is produced is a function of several parameters:
Ifpack_ICT::Ifpack_ICT | ( | const Epetra_RowMatrix * | A | ) |
Ifpack_ICT constuctor with variable number of indices per row.
Creates a Ifpack_ICT object and allocates storage.
In | A - User matrix to be factored. | |
In | Graph - Graph generated by Ifpack_IlukGraph. |
virtual Ifpack_ICT::~Ifpack_ICT | ( | ) | [virtual] |
Ifpack_ICT Destructor.
double Ifpack_ICT::AbsoluteThreshold | ( | ) | const [inline] |
Returns the absolute threshold.
int Ifpack_ICT::Apply | ( | const Epetra_MultiVector & | X, | |
Epetra_MultiVector & | Y | |||
) | const |
int Ifpack_ICT::ApplyInverse | ( | const Epetra_MultiVector & | X, | |
Epetra_MultiVector & | Y | |||
) | const [virtual] |
Returns the result of a Ifpack_ICT 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. |
Implements Ifpack_Preconditioner.
virtual double Ifpack_ICT::ApplyInverseFlops | ( | ) | const [inline, virtual] |
Returns the number of flops in all applications of ApplyInverse().
Implements Ifpack_Preconditioner.
virtual double Ifpack_ICT::ApplyInverseTime | ( | ) | const [inline, virtual] |
const Epetra_Comm& Ifpack_ICT::Comm | ( | ) | const [inline] |
Returns the Epetra_BlockMap object associated with the range of this matrix operator.
int Ifpack_ICT::Compute | ( | ) | [virtual] |
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:
Implements Ifpack_Preconditioner.
virtual double Ifpack_ICT::ComputeFlops | ( | ) | const [inline, virtual] |
virtual double Ifpack_ICT::ComputeTime | ( | ) | const [inline, virtual] |
double Ifpack_ICT::Condest | ( | ) | const [inline, virtual] |
Returns the computed condition number estimate, or -1.0 if not computed.
Implements Ifpack_Preconditioner.
double Ifpack_ICT::Condest | ( | const Ifpack_CondestType | CT = Ifpack_Cheap , |
|
const int | MaxIters = 1550 , |
|||
const double | Tol = 1e-9 , |
|||
Epetra_RowMatrix * | Matrix_in = 0 | |||
) | [virtual] |
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. |
Implements Ifpack_Preconditioner.
double Ifpack_ICT::DropTolerance | ( | ) | const [inline] |
Returns the drop threshold.
const Epetra_CrsMatrix& Ifpack_ICT::H | ( | ) | const [inline] |
Returns the address of the D factor associated with this factored matrix.
bool Ifpack_ICT::HasNormInf | ( | ) | const [inline] |
Returns false because this class cannot compute an Inf-norm.
int Ifpack_ICT::Initialize | ( | ) | [virtual] |
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. |
Implements Ifpack_Preconditioner.
virtual double Ifpack_ICT::InitializeFlops | ( | ) | const [inline, virtual] |
virtual double Ifpack_ICT::InitializeTime | ( | ) | const [inline, virtual] |
bool Ifpack_ICT::IsComputed | ( | ) | const [inline, virtual] |
If factor is completed, this query returns true, otherwise it returns false.
Implements Ifpack_Preconditioner.
bool Ifpack_ICT::IsInitialized | ( | ) | const [inline, virtual] |
Returns true
is the preconditioner has been successfully initialized.
Implements Ifpack_Preconditioner.
const char* Ifpack_ICT::Label | ( | ) | const [inline] |
double Ifpack_ICT::LevelOfFill | ( | ) | const [inline] |
Returns the level-of-fill.
const Epetra_RowMatrix& Ifpack_ICT::Matrix | ( | ) | const [inline, virtual] |
double Ifpack_ICT::NormInf | ( | ) | const [inline] |
Returns 0.0 because this class cannot compute Inf-norm.
virtual int Ifpack_ICT::NumApplyInverse | ( | ) | const [inline, virtual] |
virtual int Ifpack_ICT::NumCompute | ( | ) | const [inline, virtual] |
int Ifpack_ICT::NumGlobalNonzeros | ( | ) | const [inline] |
Returns the number of nonzero entries in the global graph.
virtual int Ifpack_ICT::NumInitialize | ( | ) | const [inline, virtual] |
int Ifpack_ICT::NumMyNonzeros | ( | ) | const [inline] |
Returns the number of nonzero entries in the local graph.
const Epetra_Map& Ifpack_ICT::OperatorDomainMap | ( | ) | const [inline] |
Returns the Epetra_Map object associated with the domain of this operator.
const Epetra_Map& Ifpack_ICT::OperatorRangeMap | ( | ) | const [inline] |
Returns the Epetra_Map object associated with the range of this operator.
virtual ostream& Ifpack_ICT::Print | ( | std::ostream & | os | ) | const [virtual] |
Prints basic information on iostream. This function is used by operator<<.
Implements Ifpack_Preconditioner.
double Ifpack_ICT::RelativeThreshold | ( | ) | const [inline] |
Returns the relative threshold.
double Ifpack_ICT::RelaxValue | ( | ) | const [inline] |
Returns the relaxation value.
int Ifpack_ICT::SetLabel | ( | const char * | Label_in | ) | [inline] |
int Ifpack_ICT::SetParameters | ( | Teuchos::ParameterList & | parameterlis | ) | [virtual] |
int Ifpack_ICT::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.
In | UseTranspose_in -If true, multiply by the transpose of operator, otherwise just use operator. |
bool Ifpack_ICT::UseTranspose | ( | ) | const [inline] |
Returns the current UseTranspose setting.