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]

List of all members.



const Epetra_RowMatrixA_
 reference to the matrix to be preconditioned.
const Epetra_CommComm_
 Reference to the communicator object.
Teuchos::RefCountPtr
< Epetra_CrsMatrix
L_
 L factor.
Teuchos::RefCountPtr
< Epetra_CrsMatrix
U_
 U factor.
double Condest_
 Condition number estimate.
double Relax_
 relaxation value
double Athresh_
 Absolute threshold.
double Rthresh_
 Relative threshold.
double LevelOfFill_
 Level-of-fill.
double DropTolerance_
 Discards all elements below this tolerance.
string Label_
 Label for this object.
bool IsInitialized_
 true if this object has been initialized
bool IsComputed_
 true if this object has been computed
bool UseTranspose_
 true if transpose has to be used.
int NumMyRows_
 Number of local rows.
int NumMyNonzeros_
 Number of local nonzeros.
int NumInitialize_
 Contains the number of successful calls to Initialize().
int NumCompute_
 Contains the number of successful call to Compute().
int NumApplyInverse_
 Contains the number of successful call to ApplyInverse().
double InitializeTime_
 Contains the time for all successful calls to Initialize().
double ComputeTime_
 Contains the time for all successful calls to Compute().
double ApplyInverseTime_
 Contains the time for all successful calls to ApplyInverse().
double ComputeFlops_
 Contains the number of flops for Compute().
double ApplyInverseFlops_
 Contain sthe number of flops for ApplyInverse().
Epetra_Time Time_
 Used for timing purposed.
int GlobalNonzeros_
 Global number of nonzeros in L and U factors.
Teuchos::RefCountPtr
< Epetra_SerialComm
SerialComm_
Teuchos::RefCountPtr< Epetra_MapSerialMap_
csrcsrA_
 Containers for the matrix storage and permutation.
csscssS_
csrncsrnN_
 Container for the L and U factor.



 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 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.
int NumMyNonzeros () const
 Returns the number of nonzero entries in the local graph.



 Ifpack_IKLU (const Ifpack_IKLU &RHS)
 Copy constructor (should never be used).
Ifpack_IKLUoperator= (const Ifpack_IKLU &RHS)
 operator= (should never be used)
void Destroy ()
 Releases all allocated memory.

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 ifp_ilu for a general description of the ILU algorithm.

The complete list of supported parameters is reported in page ifp_params.

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

Definition at line 66 of file Ifpack_IKLU.h.


Constructor & Destructor Documentation

Ifpack_IKLU::Ifpack_IKLU ( const Epetra_RowMatrix A  ) 

Ifpack_IKLU constuctor with variable number of indices per row.

Definition at line 52 of file Ifpack_IKLU.cpp.

Ifpack_IKLU::~Ifpack_IKLU (  )  [virtual]

Ifpack_IKLU Destructor.

Definition at line 83 of file Ifpack_IKLU.cpp.

Ifpack_IKLU::Ifpack_IKLU ( const Ifpack_IKLU RHS  )  [inline, private]

Copy constructor (should never be used).

Definition at line 298 of file Ifpack_IKLU.h.


Member Function Documentation

int Ifpack_IKLU::SetParameters ( Teuchos::ParameterList parameterlis  )  [virtual]

Set parameters using a Teuchos::ParameterList object.

Implements Ifpack_Preconditioner.

Definition at line 102 of file Ifpack_IKLU.cpp.

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:
In A - 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 136 of file Ifpack_IKLU.cpp.

bool Ifpack_IKLU::IsInitialized (  )  const [inline, virtual]

Returns true if the preconditioner has been successfully initialized.

Implements Ifpack_Preconditioner.

Definition at line 98 of file Ifpack_IKLU.h.

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 207 of file Ifpack_IKLU.cpp.

bool Ifpack_IKLU::IsComputed (  )  const [inline, virtual]

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

Implements Ifpack_Preconditioner.

Definition at line 115 of file Ifpack_IKLU.h.

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 287 of file Ifpack_IKLU.cpp.

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

Implements Epetra_Operator.

Definition at line 349 of file Ifpack_IKLU.cpp.

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 357 of file Ifpack_IKLU.cpp.

double Ifpack_IKLU::Condest (  )  const [inline, virtual]

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

Implements Ifpack_Preconditioner.

Definition at line 139 of file Ifpack_IKLU.h.

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

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 154 of file Ifpack_IKLU.h.

double Ifpack_IKLU::NormInf (  )  const [inline, virtual]

Returns 0.0 because this class cannot compute Inf-norm.

Implements Epetra_Operator.

Definition at line 157 of file Ifpack_IKLU.h.

bool Ifpack_IKLU::HasNormInf (  )  const [inline, virtual]

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

Implements Epetra_Operator.

Definition at line 160 of file Ifpack_IKLU.h.

bool Ifpack_IKLU::UseTranspose (  )  const [inline, virtual]

Returns the current UseTranspose setting.

Implements Epetra_Operator.

Definition at line 163 of file Ifpack_IKLU.h.

const Epetra_Map& Ifpack_IKLU::OperatorDomainMap (  )  const [inline, virtual]

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

Implements Epetra_Operator.

Definition at line 166 of file Ifpack_IKLU.h.

const Epetra_Map& Ifpack_IKLU::OperatorRangeMap (  )  const [inline, virtual]

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

Implements Epetra_Operator.

Definition at line 169 of file Ifpack_IKLU.h.

const Epetra_Comm& Ifpack_IKLU::Comm (  )  const [inline, virtual]

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

Implements Epetra_Operator.

Definition at line 172 of file Ifpack_IKLU.h.

const Epetra_RowMatrix& Ifpack_IKLU::Matrix (  )  const [inline, virtual]

Returns a reference to the matrix to be preconditioned.

Implements Ifpack_Preconditioner.

Definition at line 175 of file Ifpack_IKLU.h.

const Epetra_CrsMatrix& Ifpack_IKLU::L (  )  const [inline]

Returns a reference to the L factor.

Definition at line 181 of file Ifpack_IKLU.h.

const Epetra_CrsMatrix& Ifpack_IKLU::U (  )  const [inline]

Returns a reference to the U factor.

Definition at line 184 of file Ifpack_IKLU.h.

const char* Ifpack_IKLU::Label (  )  const [inline, virtual]

Returns the label of this object.

Implements Epetra_Operator.

Definition at line 187 of file Ifpack_IKLU.h.

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

Sets the label for this object.

Definition at line 193 of file Ifpack_IKLU.h.

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 373 of file Ifpack_IKLU.cpp.

virtual int Ifpack_IKLU::NumInitialize (  )  const [inline, virtual]

Returns the number of calls to Initialize().

Implements Ifpack_Preconditioner.

Definition at line 203 of file Ifpack_IKLU.h.

virtual int Ifpack_IKLU::NumCompute (  )  const [inline, virtual]

Returns the number of calls to Compute().

Implements Ifpack_Preconditioner.

Definition at line 209 of file Ifpack_IKLU.h.

virtual int Ifpack_IKLU::NumApplyInverse (  )  const [inline, virtual]

Returns the number of calls to ApplyInverse().

Implements Ifpack_Preconditioner.

Definition at line 215 of file Ifpack_IKLU.h.

virtual double Ifpack_IKLU::InitializeTime (  )  const [inline, virtual]

Returns the time spent in Initialize().

Implements Ifpack_Preconditioner.

Definition at line 221 of file Ifpack_IKLU.h.

virtual double Ifpack_IKLU::ComputeTime (  )  const [inline, virtual]

Returns the time spent in Compute().

Implements Ifpack_Preconditioner.

Definition at line 227 of file Ifpack_IKLU.h.

virtual double Ifpack_IKLU::ApplyInverseTime (  )  const [inline, virtual]

Returns the time spent in ApplyInverse().

Implements Ifpack_Preconditioner.

Definition at line 233 of file Ifpack_IKLU.h.

virtual double Ifpack_IKLU::InitializeFlops (  )  const [inline, virtual]

Returns the number of flops in the initialization phase.

Implements Ifpack_Preconditioner.

Definition at line 239 of file Ifpack_IKLU.h.

virtual double Ifpack_IKLU::ComputeFlops (  )  const [inline, virtual]

Returns the number of flops in the computation phase.

Implements Ifpack_Preconditioner.

Definition at line 244 of file Ifpack_IKLU.h.

virtual double Ifpack_IKLU::ApplyInverseFlops (  )  const [inline, virtual]

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

Implements Ifpack_Preconditioner.

Definition at line 249 of file Ifpack_IKLU.h.

double Ifpack_IKLU::LevelOfFill (  )  const [inline]

Definition at line 254 of file Ifpack_IKLU.h.

double Ifpack_IKLU::RelaxValue (  )  const [inline]

Set relative threshold value.

Definition at line 259 of file Ifpack_IKLU.h.

double Ifpack_IKLU::AbsoluteThreshold (  )  const [inline]

Get absolute threshold value.

Definition at line 264 of file Ifpack_IKLU.h.

double Ifpack_IKLU::RelativeThreshold (  )  const [inline]

Get relative threshold value.

Definition at line 270 of file Ifpack_IKLU.h.

double Ifpack_IKLU::DropTolerance (  )  const [inline]

Gets the dropping tolerance.

Definition at line 276 of file Ifpack_IKLU.h.

int Ifpack_IKLU::NumGlobalNonzeros (  )  const [inline]

Returns the number of nonzero entries in the global graph.

Definition at line 282 of file Ifpack_IKLU.h.

int Ifpack_IKLU::NumMyNonzeros (  )  const [inline]

Returns the number of nonzero entries in the local graph.

Definition at line 288 of file Ifpack_IKLU.h.

Ifpack_IKLU& Ifpack_IKLU::operator= ( const Ifpack_IKLU RHS  )  [inline, private]

operator= (should never be used)

Definition at line 305 of file Ifpack_IKLU.h.

void Ifpack_IKLU::Destroy (  )  [private]

Releases all allocated memory.

Definition at line 89 of file Ifpack_IKLU.cpp.


Member Data Documentation

reference to the matrix to be preconditioned.

Definition at line 317 of file Ifpack_IKLU.h.

const Epetra_Comm& Ifpack_IKLU::Comm_ [private]

Reference to the communicator object.

Definition at line 319 of file Ifpack_IKLU.h.

L factor.

Definition at line 321 of file Ifpack_IKLU.h.

U factor.

Definition at line 323 of file Ifpack_IKLU.h.

double Ifpack_IKLU::Condest_ [private]

Condition number estimate.

Definition at line 325 of file Ifpack_IKLU.h.

double Ifpack_IKLU::Relax_ [private]

relaxation value

Definition at line 327 of file Ifpack_IKLU.h.

double Ifpack_IKLU::Athresh_ [private]

Absolute threshold.

Definition at line 329 of file Ifpack_IKLU.h.

double Ifpack_IKLU::Rthresh_ [private]

Relative threshold.

Definition at line 331 of file Ifpack_IKLU.h.

double Ifpack_IKLU::LevelOfFill_ [private]

Level-of-fill.

Definition at line 333 of file Ifpack_IKLU.h.

double Ifpack_IKLU::DropTolerance_ [private]

Discards all elements below this tolerance.

Definition at line 335 of file Ifpack_IKLU.h.

string Ifpack_IKLU::Label_ [private]

Label for this object.

Definition at line 337 of file Ifpack_IKLU.h.

true if this object has been initialized

Definition at line 339 of file Ifpack_IKLU.h.

true if this object has been computed

Definition at line 341 of file Ifpack_IKLU.h.

true if transpose has to be used.

Definition at line 343 of file Ifpack_IKLU.h.

int Ifpack_IKLU::NumMyRows_ [private]

Number of local rows.

Definition at line 345 of file Ifpack_IKLU.h.

Number of local nonzeros.

Definition at line 347 of file Ifpack_IKLU.h.

Contains the number of successful calls to Initialize().

Definition at line 349 of file Ifpack_IKLU.h.

int Ifpack_IKLU::NumCompute_ [private]

Contains the number of successful call to Compute().

Definition at line 351 of file Ifpack_IKLU.h.

int Ifpack_IKLU::NumApplyInverse_ [mutable, private]

Contains the number of successful call to ApplyInverse().

Definition at line 353 of file Ifpack_IKLU.h.

double Ifpack_IKLU::InitializeTime_ [private]

Contains the time for all successful calls to Initialize().

Definition at line 355 of file Ifpack_IKLU.h.

double Ifpack_IKLU::ComputeTime_ [private]

Contains the time for all successful calls to Compute().

Definition at line 357 of file Ifpack_IKLU.h.

double Ifpack_IKLU::ApplyInverseTime_ [mutable, private]

Contains the time for all successful calls to ApplyInverse().

Definition at line 359 of file Ifpack_IKLU.h.

double Ifpack_IKLU::ComputeFlops_ [private]

Contains the number of flops for Compute().

Definition at line 361 of file Ifpack_IKLU.h.

double Ifpack_IKLU::ApplyInverseFlops_ [mutable, private]

Contain sthe number of flops for ApplyInverse().

Definition at line 363 of file Ifpack_IKLU.h.

Epetra_Time Ifpack_IKLU::Time_ [mutable, private]

Used for timing purposed.

Definition at line 365 of file Ifpack_IKLU.h.

Global number of nonzeros in L and U factors.

Definition at line 367 of file Ifpack_IKLU.h.

Definition at line 368 of file Ifpack_IKLU.h.

Definition at line 369 of file Ifpack_IKLU.h.

csr* Ifpack_IKLU::csrA_ [private]

Containers for the matrix storage and permutation.

Definition at line 372 of file Ifpack_IKLU.h.

css* Ifpack_IKLU::cssS_ [private]

Definition at line 373 of file Ifpack_IKLU.h.

Container for the L and U factor.

Definition at line 375 of file Ifpack_IKLU.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 10:05:41 2011 for Ifpack Package Browser (Single Doxygen Collection) by  doxygen 1.6.3