Ifpack_CrsIlut Class Reference

Ifpack_CrsIlut: ILUT preconditioner of a given Epetra_RowMatrix. More...

#include <Ifpack_CrsIlut.h>

Inheritance diagram for Ifpack_CrsIlut:

Inheritance graph
[legend]
List of all members.
 Ifpack_CrsIlut (const Ifpack_OverlapGraph *OverlapGraph, double DropTol=1.0E-4, double FillTol=1.0)
 Constructor using Ifpack_OverlapGraph.
 Ifpack_CrsIlut (const Epetra_RowMatrix *UserMatrix, double DropTol=1.0E-4, double FillTol=1.0)
 Constructor using Epetra_RowMatrix.
 Ifpack_CrsIlut (const Ifpack_CrsIlut &Source)
 Copy constructor.
virtual ~Ifpack_CrsIlut ()
 Ifpack_CrsIlut Destructor.
int SetDropTol (double DropTol)
 Set Drop tolerance value as defined by the ILUT algorithm.
int SetFillTol (double FillTol)
 Set fill tolerance value as defined by the ILUT algorithm.
int SetParameters (const Teuchos::ParameterList &parameterlist, bool cerr_warning_if_unused=false)
 Set parameters using a Teuchos::ParameterList object.
double DropTol () const
 Set Drop tolerance value as defined by the ILUT algorithm.
double FillTol () const
 Set fill tolerance value as defined by the ILUT algorithm.
int ProcessOverlapMatrix (const Epetra_RowMatrix &A)
 Processes the overlapped user matrix for computing the ILUT preconditioner.
int DerivedFactor ()
 Compute ILUT factors L and U: WARNING: THIS ROUTINE IS NOT USER CALLABLE, CALL Factor().

Private Attributes

double DropTol_
double FillTol_

Detailed Description

Ifpack_CrsIlut: ILUT preconditioner of a given Epetra_RowMatrix.

Definition at line 51 of file Ifpack_CrsIlut.h.


Constructor & Destructor Documentation

Ifpack_CrsIlut::Ifpack_CrsIlut ( const Ifpack_OverlapGraph OverlapGraph,
double  DropTol = 1.0E-4,
double  FillTol = 1.0 
)

Constructor using Ifpack_OverlapGraph.

Creates an object from the overlap graph.

Parameters:
OverlapGraph (In) - Graph describing the graph that should be used for the factors.
DropTol (In/Default) - Drop tolerance used by ILUT algorithm.
FillTol (In/Default) - Fill tolerance used by ILUT algorithm.

Definition at line 44 of file Ifpack_CrsIlut.cpp.

Ifpack_CrsIlut::Ifpack_CrsIlut ( const Epetra_RowMatrix UserMatrix,
double  DropTol = 1.0E-4,
double  FillTol = 1.0 
)

Constructor using Epetra_RowMatrix.

Creates an Ifpack_Graph object from the user graph implicitly defined by the Epetra_RowMatrix interface.

Parameters:
RowMatrix (In) - An object that has implemented the Epetra_RowMatrix interface.
DropTol (In/Default) - Drop tolerance used by ILUT algorithm.
FillTol (In/Default) - Fill tolerance used by ILUT algorithm.

Definition at line 55 of file Ifpack_CrsIlut.cpp.

Ifpack_CrsIlut::Ifpack_CrsIlut ( const Ifpack_CrsIlut Source  ) 

Copy constructor.

Definition at line 66 of file Ifpack_CrsIlut.cpp.

virtual Ifpack_CrsIlut::~Ifpack_CrsIlut (  )  [virtual]

Ifpack_CrsIlut Destructor.


Member Function Documentation

int Ifpack_CrsIlut::SetDropTol ( double  DropTol  )  [inline]

Set Drop tolerance value as defined by the ILUT algorithm.

Definition at line 87 of file Ifpack_CrsIlut.h.

int Ifpack_CrsIlut::SetFillTol ( double  FillTol  )  [inline]

Set fill tolerance value as defined by the ILUT algorithm.

Definition at line 90 of file Ifpack_CrsIlut.h.

int Ifpack_CrsIlut::SetParameters ( const Teuchos::ParameterList &  parameterlist,
bool  cerr_warning_if_unused = false 
)

Set parameters using a Teuchos::ParameterList object.

Definition at line 77 of file Ifpack_CrsIlut.cpp.

double Ifpack_CrsIlut::DropTol (  )  const [inline]

Set Drop tolerance value as defined by the ILUT algorithm.

Definition at line 105 of file Ifpack_CrsIlut.h.

double Ifpack_CrsIlut::FillTol (  )  const [inline]

Set fill tolerance value as defined by the ILUT algorithm.

Definition at line 108 of file Ifpack_CrsIlut.h.

int Ifpack_CrsIlut::ProcessOverlapMatrix ( const Epetra_RowMatrix A  )  [protected, virtual]

Processes the overlapped user matrix for computing the ILUT preconditioner.

Implements Ifpack_OverlapFactorObject.

Definition at line 93 of file Ifpack_CrsIlut.cpp.

int Ifpack_CrsIlut::DerivedFactor (  )  [protected, virtual]

Compute ILUT factors L and U: WARNING: THIS ROUTINE IS NOT USER CALLABLE, CALL Factor().

Implements Ifpack_OverlapFactorObject.

Definition at line 99 of file Ifpack_CrsIlut.cpp.


Member Data Documentation

double Ifpack_CrsIlut::DropTol_ [private]

Definition at line 122 of file Ifpack_CrsIlut.h.

double Ifpack_CrsIlut::FillTol_ [private]

Definition at line 123 of file Ifpack_CrsIlut.h.


The documentation for this class was generated from the following files:
Generated on Wed May 12 21:30:30 2010 for Ifpack Package Browser (Single Doxygen Collection) by  doxygen 1.4.7