IFPACK Development
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Ifpack_IKLU Class Reference

Ifpack_IKLU: A class for constructing and using an incomplete LU factorization of a given Epetra_RowMatrix. More...

#include <Ifpack_IKLU.h>

Inheritance diagram for Ifpack_IKLU:
Inheritance graph
[legend]
Collaboration diagram for Ifpack_IKLU:
Collaboration graph
[legend]

Public Member Functions

 Ifpack_IKLU (const Epetra_RowMatrix *A)
 Ifpack_IKLU constuctor with variable number of indices per row.
 
virtual ~Ifpack_IKLU ()
 Ifpack_IKLU Destructor.
 
int SetParameters (Teuchos::ParameterList &parameterlis)
 Set parameters using a Teuchos::ParameterList object.
 
int Initialize ()
 Initialize L and U with values from user matrix A.
 
bool IsInitialized () const
 Returns true if the preconditioner has been successfully initialized.
 
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_IKLU 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)
 Computed the estimated condition number and returns the value.
 
double Condest () const
 Returns the computed estimated condition number, or -1.0 if no computed.
 
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_MapOperatorDomainMap () const
 Returns the Epetra_Map object associated with the domain of this operator.
 
const Epetra_MapOperatorRangeMap () const
 Returns the Epetra_Map object associated with the range of this operator.
 
const Epetra_CommComm () const
 Returns the Epetra_BlockMap object associated with the range of this matrix operator.
 
const Epetra_RowMatrixMatrix () const
 Returns a reference to the matrix to be preconditioned.
 
const Epetra_CrsMatrixL () const
 Returns a reference to the L factor.
 
const Epetra_CrsMatrixU () const
 Returns a reference to the U factor.
 
const char * Label () const
 Returns the label of this object.
 
int SetLabel (const char *Label_in)
 Sets the label for this object.
 
virtual std::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 the computation phase.
 
virtual double ApplyInverseFlops () const
 Returns the number of flops in the application of the preconditioner.
 
double LevelOfFill () const
 
double RelaxValue () const
 Set relative threshold value.
 
double AbsoluteThreshold () const
 Get absolute threshold value.
 
double RelativeThreshold () const
 Get relative threshold value.
 
double DropTolerance () const
 Gets the dropping tolerance.
 
int NumGlobalNonzeros () const
 Returns the number of nonzero entries in the global graph.
 
long long NumGlobalNonzeros64 () const
 
int NumMyNonzeros () const
 Returns the number of nonzero entries in the local graph.
 
virtual int SetParameters (Teuchos::ParameterList &List)=0
 Sets all parameters for the preconditioner.
 
virtual int Initialize ()=0
 Computes all it is necessary to initialize the preconditioner.
 
virtual bool IsInitialized () const =0
 Returns true if the preconditioner has been successfully initialized, false otherwise.
 
virtual int Compute ()=0
 Computes all it is necessary to apply the preconditioner.
 
virtual bool IsComputed () const =0
 Returns true if the preconditioner has been successfully computed, false otherwise.
 
virtual double Condest (const Ifpack_CondestType CT=Ifpack_Cheap, const int MaxIters=1550, const double Tol=1e-9, Epetra_RowMatrix *Matrix=0)=0
 Computes the condition number estimate, returns its value.
 
virtual double Condest () const =0
 Returns the computed condition number estimate, or -1.0 if not computed.
 
virtual int ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const =0
 Applies the preconditioner to vector X, returns the result in Y.
 
virtual const Epetra_RowMatrixMatrix () const =0
 Returns a pointer to the matrix to be preconditioned.
 
virtual int NumInitialize () const =0
 Returns the number of calls to Initialize().
 
virtual int NumCompute () const =0
 Returns the number of calls to Compute().
 
virtual int NumApplyInverse () const =0
 Returns the number of calls to ApplyInverse().
 
virtual double InitializeTime () const =0
 Returns the time spent in Initialize().
 
virtual double ComputeTime () const =0
 Returns the time spent in Compute().
 
virtual double ApplyInverseTime () const =0
 Returns the time spent in ApplyInverse().
 
virtual double InitializeFlops () const =0
 Returns the number of flops in the initialization phase.
 
virtual double ComputeFlops () const =0
 Returns the number of flops in the computation phase.
 
virtual double ApplyInverseFlops () const =0
 Returns the number of flops in the application of the preconditioner.
 
virtual std::ostream & Print (std::ostream &os) const =0
 Prints basic information on iostream. This function is used by operator<<.
 
virtual int SetUseTranspose (bool UseTranspose)=0
 
virtual int Apply (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const=0
 
virtual int ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const=0
 
virtual double NormInf () const=0
 
virtual const char * Label () const=0
 
virtual bool UseTranspose () const=0
 
virtual bool HasNormInf () const=0
 
virtual const Epetra_CommComm () const=0
 
virtual const Epetra_MapOperatorDomainMap () const=0
 
virtual const Epetra_MapOperatorRangeMap () const=0
 
virtual int SetUseTranspose (bool UseTranspose)=0
 
virtual int Apply (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const=0
 
virtual int ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const=0
 
virtual double NormInf () const=0
 
virtual const char * Label () const=0
 
virtual bool UseTranspose () const=0
 
virtual bool HasNormInf () const=0
 
virtual const Epetra_CommComm () const=0
 
virtual const Epetra_MapOperatorDomainMap () const=0
 
virtual const Epetra_MapOperatorRangeMap () const=0
 

Detailed Description

Ifpack_IKLU: A class for constructing and using an incomplete LU factorization of a given Epetra_RowMatrix.

The Ifpack_IKLU class computes a "Relaxed" IKLU 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.

Author
Heidi Thornquist, Org. 1437
Date
Last modified on 28-Nov-06.

Definition at line 79 of file Ifpack_IKLU.h.

Constructor & Destructor Documentation

◆ Ifpack_IKLU()

Ifpack_IKLU::Ifpack_IKLU ( const Epetra_RowMatrix A)

Ifpack_IKLU constuctor with variable number of indices per row.

Definition at line 66 of file Ifpack_IKLU.cpp.

◆ ~Ifpack_IKLU()

Ifpack_IKLU::~Ifpack_IKLU ( )
virtual

Ifpack_IKLU Destructor.

Definition at line 97 of file Ifpack_IKLU.cpp.

Member Function Documentation

◆ AbsoluteThreshold()

double Ifpack_IKLU::AbsoluteThreshold ( ) const
inline

Get absolute threshold value.

Definition at line 277 of file Ifpack_IKLU.h.

Referenced by Print(), and SetParameters().

◆ Apply()

int Ifpack_IKLU::Apply ( const Epetra_MultiVector X,
Epetra_MultiVector Y 
) const
virtual

Implements Epetra_Operator.

Definition at line 399 of file Ifpack_IKLU.cpp.

◆ ApplyInverse()

int Ifpack_IKLU::ApplyInverse ( const Epetra_MultiVector X,
Epetra_MultiVector Y 
) const
virtual

Returns the result of a Ifpack_IKLU forward/back solve on a Epetra_MultiVector X in Y.

Parameters
X- (In) A Epetra_MultiVector of dimension NumVectors to solve for.
Y- (Out) A Epetra_MultiVector of dimension NumVectorscontaining result.
Returns
Integer error code, set to 0 if successful.

Implements Ifpack_Preconditioner.

Definition at line 335 of file Ifpack_IKLU.cpp.

References Epetra_Time::ElapsedTime(), IsComputed(), Epetra_DistObject::Map(), Epetra_MultiVector::NumVectors(), Epetra_MultiVector::ReplaceMyValue(), and Epetra_Time::ResetStartTime().

◆ ApplyInverseFlops()

virtual double Ifpack_IKLU::ApplyInverseFlops ( ) const
inlinevirtual

Returns the number of flops in the application of the preconditioner.

Implements Ifpack_Preconditioner.

Definition at line 262 of file Ifpack_IKLU.h.

Referenced by Print().

◆ ApplyInverseTime()

virtual double Ifpack_IKLU::ApplyInverseTime ( ) const
inlinevirtual

Returns the time spent in ApplyInverse().

Implements Ifpack_Preconditioner.

Definition at line 246 of file Ifpack_IKLU.h.

Referenced by Print().

◆ Comm()

const Epetra_Comm & Ifpack_IKLU::Comm ( ) const
inlinevirtual

Returns the Epetra_BlockMap object associated with the range of this matrix operator.

Implements Epetra_Operator.

Definition at line 185 of file Ifpack_IKLU.h.

Referenced by Compute(), Initialize(), and Print().

◆ Compute()

int Ifpack_IKLU::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:

  1. Ifpack_IlukGraph specifying the structure of L and U.
  2. Value for the RILU(k) relaxation parameter.
  3. Value for the a priori diagonal threshold values.

InitValues() must be called before the factorization can proceed.

Implements Ifpack_Preconditioner.

Definition at line 228 of file Ifpack_IKLU.cpp.

References Comm(), Epetra_Time::ElapsedTime(), Epetra_RowMatrix::ExtractMyRowCopy(), Initialize(), IsInitialized(), Epetra_RowMatrix::MaxNumEntries(), Epetra_RowMatrix::NumMyRows(), Epetra_Comm::NumProc(), Epetra_Time::ResetStartTime(), Epetra_RowMatrix::RowMatrixRowMap(), Epetra_Comm::SumAll(), and View.

◆ ComputeFlops()

virtual double Ifpack_IKLU::ComputeFlops ( ) const
inlinevirtual

Returns the number of flops in the computation phase.

Implements Ifpack_Preconditioner.

Definition at line 257 of file Ifpack_IKLU.h.

Referenced by Print().

◆ ComputeTime()

virtual double Ifpack_IKLU::ComputeTime ( ) const
inlinevirtual

Returns the time spent in Compute().

Implements Ifpack_Preconditioner.

Definition at line 240 of file Ifpack_IKLU.h.

Referenced by Print().

◆ Condest() [1/2]

double Ifpack_IKLU::Condest ( ) const
inlinevirtual

Returns the computed estimated condition number, or -1.0 if no computed.

Implements Ifpack_Preconditioner.

Definition at line 152 of file Ifpack_IKLU.h.

Referenced by Print().

◆ Condest() [2/2]

double Ifpack_IKLU::Condest ( const Ifpack_CondestType  CT = Ifpack_Cheap,
const int  MaxIters = 1550,
const double  Tol = 1e-9,
Epetra_RowMatrix Matrix_in = 0 
)
virtual

Computed the estimated condition number and returns the value.

Implements Ifpack_Preconditioner.

Definition at line 407 of file Ifpack_IKLU.cpp.

References IsComputed().

◆ DropTolerance()

double Ifpack_IKLU::DropTolerance ( ) const
inline

Gets the dropping tolerance.

Definition at line 289 of file Ifpack_IKLU.h.

Referenced by SetParameters().

◆ HasNormInf()

bool Ifpack_IKLU::HasNormInf ( ) const
inlinevirtual

Returns false because this class cannot compute an Inf-norm.

Implements Epetra_Operator.

Definition at line 173 of file Ifpack_IKLU.h.

◆ Initialize()

int Ifpack_IKLU::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.

Parameters
InA - User matrix to be factored.
Warning
The graph of A must be identical to the graph passed in to Ifpack_IlukGraph constructor.

Implements Ifpack_Preconditioner.

Definition at line 153 of file Ifpack_IKLU.cpp.

References Comm(), Epetra_Operator::Comm(), Epetra_Time::ElapsedTime(), Epetra_RowMatrix::ExtractMyRowCopy(), Matrix(), Epetra_RowMatrix::MaxNumEntries(), Epetra_RowMatrix::NumMyNonzeros(), Epetra_RowMatrix::NumMyRows(), Epetra_Comm::NumProc(), and Epetra_Time::ResetStartTime().

Referenced by Compute().

◆ InitializeFlops()

virtual double Ifpack_IKLU::InitializeFlops ( ) const
inlinevirtual

Returns the number of flops in the initialization phase.

Implements Ifpack_Preconditioner.

Definition at line 252 of file Ifpack_IKLU.h.

◆ InitializeTime()

virtual double Ifpack_IKLU::InitializeTime ( ) const
inlinevirtual

Returns the time spent in Initialize().

Implements Ifpack_Preconditioner.

Definition at line 234 of file Ifpack_IKLU.h.

Referenced by Print().

◆ IsComputed()

bool Ifpack_IKLU::IsComputed ( ) const
inlinevirtual

If factor is completed, this query returns true, otherwise it returns false.

Implements Ifpack_Preconditioner.

Definition at line 128 of file Ifpack_IKLU.h.

Referenced by ApplyInverse(), and Condest().

◆ IsInitialized()

bool Ifpack_IKLU::IsInitialized ( ) const
inlinevirtual

Returns true if the preconditioner has been successfully initialized.

Implements Ifpack_Preconditioner.

Definition at line 111 of file Ifpack_IKLU.h.

Referenced by Compute().

◆ L()

const Epetra_CrsMatrix & Ifpack_IKLU::L ( ) const
inline

Returns a reference to the L factor.

Definition at line 194 of file Ifpack_IKLU.h.

Referenced by NumGlobalNonzeros(), and NumMyNonzeros().

◆ Label()

const char * Ifpack_IKLU::Label ( ) const
inlinevirtual

Returns the label of this object.

Implements Epetra_Operator.

Definition at line 200 of file Ifpack_IKLU.h.

Referenced by Print().

◆ LevelOfFill()

double Ifpack_IKLU::LevelOfFill ( ) const
inline

Definition at line 267 of file Ifpack_IKLU.h.

◆ Matrix()

const Epetra_RowMatrix & Ifpack_IKLU::Matrix ( ) const
inlinevirtual

Returns a reference to the matrix to be preconditioned.

Implements Ifpack_Preconditioner.

Definition at line 188 of file Ifpack_IKLU.h.

Referenced by Initialize().

◆ NormInf()

double Ifpack_IKLU::NormInf ( ) const
inlinevirtual

Returns 0.0 because this class cannot compute Inf-norm.

Implements Epetra_Operator.

Definition at line 170 of file Ifpack_IKLU.h.

◆ NumApplyInverse()

virtual int Ifpack_IKLU::NumApplyInverse ( ) const
inlinevirtual

Returns the number of calls to ApplyInverse().

Implements Ifpack_Preconditioner.

Definition at line 228 of file Ifpack_IKLU.h.

Referenced by Print().

◆ NumCompute()

virtual int Ifpack_IKLU::NumCompute ( ) const
inlinevirtual

Returns the number of calls to Compute().

Implements Ifpack_Preconditioner.

Definition at line 222 of file Ifpack_IKLU.h.

Referenced by Print().

◆ NumGlobalNonzeros()

int Ifpack_IKLU::NumGlobalNonzeros ( ) const
inline

Returns the number of nonzero entries in the global graph.

Definition at line 296 of file Ifpack_IKLU.h.

References L(), NumGlobalNonzeros(), and U().

Referenced by NumGlobalNonzeros().

◆ NumGlobalNonzeros64()

long long Ifpack_IKLU::NumGlobalNonzeros64 ( ) const
inline

Definition at line 301 of file Ifpack_IKLU.h.

◆ NumInitialize()

virtual int Ifpack_IKLU::NumInitialize ( ) const
inlinevirtual

Returns the number of calls to Initialize().

Implements Ifpack_Preconditioner.

Definition at line 216 of file Ifpack_IKLU.h.

Referenced by Print().

◆ NumMyNonzeros()

int Ifpack_IKLU::NumMyNonzeros ( ) const
inline

Returns the number of nonzero entries in the local graph.

Definition at line 307 of file Ifpack_IKLU.h.

References L(), NumMyNonzeros(), and U().

Referenced by NumMyNonzeros().

◆ OperatorDomainMap()

const Epetra_Map & Ifpack_IKLU::OperatorDomainMap ( ) const
inlinevirtual

Returns the Epetra_Map object associated with the domain of this operator.

Implements Epetra_Operator.

Definition at line 179 of file Ifpack_IKLU.h.

References Epetra_Operator::OperatorDomainMap().

◆ OperatorRangeMap()

const Epetra_Map & Ifpack_IKLU::OperatorRangeMap ( ) const
inlinevirtual

Returns the Epetra_Map object associated with the range of this operator.

Implements Epetra_Operator.

Definition at line 182 of file Ifpack_IKLU.h.

References Epetra_Operator::OperatorRangeMap().

◆ Print()

std::ostream & Ifpack_IKLU::Print ( std::ostream &  os) const
virtual

Prints basic information on iostream. This function is used by operator<<.

Implements Ifpack_Preconditioner.

Definition at line 423 of file Ifpack_IKLU.cpp.

References AbsoluteThreshold(), ApplyInverseFlops(), ApplyInverseTime(), Comm(), ComputeFlops(), ComputeTime(), Condest(), InitializeTime(), Label(), NumApplyInverse(), NumCompute(), NumInitialize(), RelativeThreshold(), and RelaxValue().

◆ RelativeThreshold()

double Ifpack_IKLU::RelativeThreshold ( ) const
inline

Get relative threshold value.

Definition at line 283 of file Ifpack_IKLU.h.

Referenced by Print(), and SetParameters().

◆ RelaxValue()

double Ifpack_IKLU::RelaxValue ( ) const
inline

Set relative threshold value.

Definition at line 272 of file Ifpack_IKLU.h.

Referenced by Print(), and SetParameters().

◆ SetLabel()

int Ifpack_IKLU::SetLabel ( const char *  Label_in)
inline

Sets the label for this object.

Definition at line 206 of file Ifpack_IKLU.h.

◆ SetParameters()

int Ifpack_IKLU::SetParameters ( Teuchos::ParameterList &  parameterlis)
virtual

Set parameters using a Teuchos::ParameterList object.

Implements Ifpack_Preconditioner.

Definition at line 116 of file Ifpack_IKLU.cpp.

References AbsoluteThreshold(), DropTolerance(), RelativeThreshold(), and RelaxValue().

◆ SetUseTranspose()

int Ifpack_IKLU::SetUseTranspose ( bool  UseTranspose_in)
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- (In) If true, multiply by the transpose of operator, otherwise just use operator.
Returns
Always returns 0.

Implements Epetra_Operator.

Definition at line 167 of file Ifpack_IKLU.h.

◆ U()

const Epetra_CrsMatrix & Ifpack_IKLU::U ( ) const
inline

Returns a reference to the U factor.

Definition at line 197 of file Ifpack_IKLU.h.

Referenced by NumGlobalNonzeros(), and NumMyNonzeros().

◆ UseTranspose()

bool Ifpack_IKLU::UseTranspose ( ) const
inlinevirtual

Returns the current UseTranspose setting.

Implements Epetra_Operator.

Definition at line 176 of file Ifpack_IKLU.h.


The documentation for this class was generated from the following files: