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

#include <Ifpack_ILUT.h>

Inheritance diagram for Ifpack_ILUT:

	Ifpack_ILUT (const Epetra_RowMatrix *A)
	Ifpack_ILUT constuctor with variable number of indices per row. More...

virtual	~Ifpack_ILUT ()
	Ifpack_ILUT Destructor. More...

int	SetParameters (Teuchos::ParameterList &parameterlis)
	Set parameters using a Teuchos::ParameterList object. More...

int	Initialize ()
	Initialize L and U with values from user matrix A. More...

bool	IsInitialized () const
	Returns `true` if the preconditioner has been successfully initialized. More...

int	Compute ()
	Compute IC factor U using the specified graph, diagonal perturbation thresholds and relaxation parameters. More...

bool	IsComputed () const
	If factor is completed, this query returns true, otherwise it returns false. More...

int	ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
	Returns the result of a Ifpack_ILUT forward/back solve on a Epetra_MultiVector X in Y. More...

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. More...

double	Condest () const
	Returns the computed estimated condition number, or -1.0 if no computed. More...

int	SetUseTranspose (bool UseTranspose_in)
	If set true, transpose of this operator will be applied. More...

double	NormInf () const
	Returns 0.0 because this class cannot compute Inf-norm. More...

bool	HasNormInf () const
	Returns false because this class cannot compute an Inf-norm. More...

bool	UseTranspose () const
	Returns the current UseTranspose setting. More...

const Epetra_Map &	OperatorDomainMap () const
	Returns the Epetra_Map object associated with the domain of this operator. More...

const Epetra_Map &	OperatorRangeMap () const
	Returns the Epetra_Map object associated with the range of this operator. More...

const Epetra_Comm &	Comm () const
	Returns the Epetra_BlockMap object associated with the range of this matrix operator. More...

const Epetra_RowMatrix &	Matrix () const
	Returns a reference to the matrix to be preconditioned. More...

const Epetra_CrsMatrix &	L () const
	Returns a reference to the L factor. More...

const Epetra_CrsMatrix &	U () const
	Returns a reference to the U factor. More...

const char *	Label () const
	Returns the label of `this` object. More...

int	SetLabel (const char *Label_in)
	Sets the label for `this` object. More...

virtual std::ostream &	Print (std::ostream &os) const
	Prints basic information on iostream. This function is used by operator<<. More...

virtual int	NumInitialize () const
	Returns the number of calls to Initialize(). More...

virtual int	NumCompute () const
	Returns the number of calls to Compute(). More...

virtual int	NumApplyInverse () const
	Returns the number of calls to ApplyInverse(). More...

virtual double	InitializeTime () const
	Returns the time spent in Initialize(). More...

virtual double	ComputeTime () const
	Returns the time spent in Compute(). More...

virtual double	ApplyInverseTime () const
	Returns the time spent in ApplyInverse(). More...

virtual double	InitializeFlops () const
	Returns the number of flops in the initialization phase. More...

virtual double	ComputeFlops () const
	Returns the number of flops in the computation phase. More...

virtual double	ApplyInverseFlops () const
	Returns the number of flops in the application of the preconditioner. More...

double	LevelOfFill () const

double	RelaxValue () const
	Set relative threshold value. More...

double	AbsoluteThreshold () const
	Get absolute threshold value. More...

double	RelativeThreshold () const
	Get relative threshold value. More...

double	DropTolerance () const
	Gets the dropping tolerance. More...

int	NumGlobalNonzeros () const
	Returns the number of nonzero entries in the global graph. More...

long long	NumGlobalNonzeros64 () const

int	NumMyNonzeros () const
	Returns the number of nonzero entries in the local graph. More...

	Ifpack_ILUT (const Ifpack_ILUT &RHS)
	Copy constructor (should never be used) More...

Ifpack_ILUT &	operator= (const Ifpack_ILUT &)
	operator= (should never be used) More...

template<typename int_type >
int	TCompute ()

void	Destroy ()
	Releases all allocated memory. More...

const Epetra_RowMatrix &	A_
	reference to the matrix to be preconditioned. More...

const Epetra_Comm &	Comm_
	Reference to the communicator object. More...

Teuchos::RefCountPtr < Epetra_CrsMatrix >	L_
	L factor. More...

Teuchos::RefCountPtr < Epetra_CrsMatrix >	U_
	U factor. More...

double	Condest_
	Condition number estimate. More...

double	Relax_
	relaxation value More...

double	Athresh_
	Absolute threshold. More...

double	Rthresh_
	Relative threshold. More...

double	LevelOfFill_
	Level-of-fill. More...

double	DropTolerance_
	Discards all elements below this tolerance. More...

std::string	Label_
	Label for `this` object. More...

bool	IsInitialized_
	`true` if `this` object has been initialized More...

bool	IsComputed_
	`true` if `this` object has been computed More...

bool	UseTranspose_
	`true` if transpose has to be used. More...

int	NumMyRows_
	Number of local rows. More...

int	NumInitialize_
	Contains the number of successful calls to Initialize(). More...

int	NumCompute_
	Contains the number of successful call to Compute(). More...

int	NumApplyInverse_
	Contains the number of successful call to ApplyInverse(). More...

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

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

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

double	ComputeFlops_
	Contains the number of flops for Compute(). More...

double	ApplyInverseFlops_
	Contain sthe number of flops for ApplyInverse(). More...

Epetra_Time	Time_
	Used for timing purposed. More...

long long	GlobalNonzeros_
	Global number of nonzeros in L and U factors. More...

Teuchos::RefCountPtr < Epetra_SerialComm >	SerialComm_

Teuchos::RefCountPtr< Epetra_Map >	SerialMap_

Additional Inherited Members

Detailed Description

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

The Ifpack_ILUT class computes a "Relaxed" ILUT factorization with dual threshold dropping of small elements of a given Epetra_RowMatrix.

This implementation does not use the algorithm that is described in ifp_ilu. The algorithm drops entries in a row (i) of matrix A that are smaller than drop_tolerance even before the factorization of row i then computes the factorization for that row. This is different than the usual algorithm where the drop tolerance is applied to the factored rows.

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

Author: Marzio Sala, SNL 9214.

Date: Last modified on 22-Jan-05.

Definition at line 81 of file Ifpack_ILUT.h.

Constructor & Destructor Documentation

Ifpack_ILUT::Ifpack_ILUT ( const Epetra_RowMatrix * A )

Ifpack_ILUT constuctor with variable number of indices per row.

Definition at line 66 of file Ifpack_ILUT.cpp.

Ifpack_ILUT::~Ifpack_ILUT ( )

virtual

Ifpack_ILUT Destructor.

Definition at line 94 of file Ifpack_ILUT.cpp.

Ifpack_ILUT::Ifpack_ILUT ( const Ifpack_ILUT & RHS )

inlineprivate

Copy constructor (should never be used)

Definition at line 318 of file Ifpack_ILUT.h.

Member Function Documentation

int Ifpack_ILUT::SetParameters ( Teuchos::ParameterList & parameterlis )

virtual

Set parameters using a Teuchos::ParameterList object.

Implements Ifpack_Preconditioner.

Definition at line 107 of file Ifpack_ILUT.cpp.

int Ifpack_ILUT::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 144 of file Ifpack_ILUT.cpp.

bool Ifpack_ILUT::IsInitialized ( ) const

inlinevirtual

Returns true if the preconditioner has been successfully initialized.

Implements Ifpack_Preconditioner.

Definition at line 113 of file Ifpack_ILUT.h.

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

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

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

Implements Ifpack_Preconditioner.

Definition at line 495 of file Ifpack_ILUT.cpp.

bool Ifpack_ILUT::IsComputed ( ) const

inlinevirtual

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

Implements Ifpack_Preconditioner.

Definition at line 130 of file Ifpack_ILUT.h.

int Ifpack_ILUT::ApplyInverse	(	const Epetra_MultiVector &	X,
		Epetra_MultiVector &	Y
	)		const

virtual

Returns the result of a Ifpack_ILUT 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 537 of file Ifpack_ILUT.cpp.

int Ifpack_ILUT::Apply	(	const Epetra_MultiVector &	X,
		Epetra_MultiVector &	Y
	)		const

virtual

Implements Epetra_Operator.

Definition at line 584 of file Ifpack_ILUT.cpp.

double Ifpack_ILUT::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 591 of file Ifpack_ILUT.cpp.

double Ifpack_ILUT::Condest ( ) const

inlinevirtual

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

Implements Ifpack_Preconditioner.

Definition at line 154 of file Ifpack_ILUT.h.

int Ifpack_ILUT::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 168 of file Ifpack_ILUT.h.

double Ifpack_ILUT::NormInf ( ) const

inlinevirtual

Returns 0.0 because this class cannot compute Inf-norm.

Implements Epetra_Operator.

Definition at line 171 of file Ifpack_ILUT.h.

bool Ifpack_ILUT::HasNormInf ( ) const

inlinevirtual

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

Implements Epetra_Operator.

Definition at line 174 of file Ifpack_ILUT.h.

bool Ifpack_ILUT::UseTranspose ( ) const

inlinevirtual

Returns the current UseTranspose setting.

Implements Epetra_Operator.

Definition at line 177 of file Ifpack_ILUT.h.

const Epetra_Map& Ifpack_ILUT::OperatorDomainMap ( ) const

inlinevirtual

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

Implements Epetra_Operator.

Definition at line 180 of file Ifpack_ILUT.h.

const Epetra_Map& Ifpack_ILUT::OperatorRangeMap ( ) const

inlinevirtual

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

Implements Epetra_Operator.

Definition at line 183 of file Ifpack_ILUT.h.

const Epetra_Comm& Ifpack_ILUT::Comm ( ) const

inlinevirtual

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

Implements Epetra_Operator.

Definition at line 186 of file Ifpack_ILUT.h.

const Epetra_RowMatrix& Ifpack_ILUT::Matrix ( ) const

inlinevirtual

Returns a reference to the matrix to be preconditioned.

Implements Ifpack_Preconditioner.

Definition at line 189 of file Ifpack_ILUT.h.

const Epetra_CrsMatrix& Ifpack_ILUT::L ( ) const

inline

Returns a reference to the L factor.

Definition at line 195 of file Ifpack_ILUT.h.

const Epetra_CrsMatrix& Ifpack_ILUT::U ( ) const

inline

Returns a reference to the U factor.

Definition at line 198 of file Ifpack_ILUT.h.

const char* Ifpack_ILUT::Label ( ) const

inlinevirtual

Returns the label of this object.

Implements Epetra_Operator.

Definition at line 201 of file Ifpack_ILUT.h.

int Ifpack_ILUT::SetLabel ( const char * Label_in )

inline

Sets the label for this object.

Definition at line 207 of file Ifpack_ILUT.h.

std::ostream & Ifpack_ILUT::Print ( std::ostream & os ) const

virtual

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

Implements Ifpack_Preconditioner.

Definition at line 607 of file Ifpack_ILUT.cpp.

virtual int Ifpack_ILUT::NumInitialize ( ) const

inlinevirtual

Returns the number of calls to Initialize().

Implements Ifpack_Preconditioner.

Definition at line 217 of file Ifpack_ILUT.h.

virtual int Ifpack_ILUT::NumCompute ( ) const

inlinevirtual

Returns the number of calls to Compute().

Implements Ifpack_Preconditioner.

Definition at line 223 of file Ifpack_ILUT.h.

virtual int Ifpack_ILUT::NumApplyInverse ( ) const

inlinevirtual

Returns the number of calls to ApplyInverse().

Implements Ifpack_Preconditioner.

Definition at line 229 of file Ifpack_ILUT.h.

virtual double Ifpack_ILUT::InitializeTime ( ) const

inlinevirtual

Returns the time spent in Initialize().

Implements Ifpack_Preconditioner.

Definition at line 235 of file Ifpack_ILUT.h.

virtual double Ifpack_ILUT::ComputeTime ( ) const

inlinevirtual

Returns the time spent in Compute().

Implements Ifpack_Preconditioner.

Definition at line 241 of file Ifpack_ILUT.h.

virtual double Ifpack_ILUT::ApplyInverseTime ( ) const

inlinevirtual

Returns the time spent in ApplyInverse().

Implements Ifpack_Preconditioner.

Definition at line 247 of file Ifpack_ILUT.h.

virtual double Ifpack_ILUT::InitializeFlops ( ) const

inlinevirtual

Returns the number of flops in the initialization phase.

Implements Ifpack_Preconditioner.

Definition at line 253 of file Ifpack_ILUT.h.

virtual double Ifpack_ILUT::ComputeFlops ( ) const

inlinevirtual

Returns the number of flops in the computation phase.

Implements Ifpack_Preconditioner.

Definition at line 258 of file Ifpack_ILUT.h.

virtual double Ifpack_ILUT::ApplyInverseFlops ( ) const

inlinevirtual

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

Implements Ifpack_Preconditioner.

Definition at line 263 of file Ifpack_ILUT.h.

double Ifpack_ILUT::LevelOfFill ( ) const

inline

Definition at line 268 of file Ifpack_ILUT.h.

double Ifpack_ILUT::RelaxValue ( ) const

inline

Set relative threshold value.

Definition at line 273 of file Ifpack_ILUT.h.

double Ifpack_ILUT::AbsoluteThreshold ( ) const

inline

Get absolute threshold value.

Definition at line 278 of file Ifpack_ILUT.h.

double Ifpack_ILUT::RelativeThreshold ( ) const

inline

Get relative threshold value.

Definition at line 284 of file Ifpack_ILUT.h.

double Ifpack_ILUT::DropTolerance ( ) const

inline

Gets the dropping tolerance.

Definition at line 290 of file Ifpack_ILUT.h.

int Ifpack_ILUT::NumGlobalNonzeros ( ) const

inline

Returns the number of nonzero entries in the global graph.

Definition at line 297 of file Ifpack_ILUT.h.

long long Ifpack_ILUT::NumGlobalNonzeros64 ( ) const

inline

Definition at line 302 of file Ifpack_ILUT.h.

int Ifpack_ILUT::NumMyNonzeros ( ) const

inline

Returns the number of nonzero entries in the local graph.

Definition at line 308 of file Ifpack_ILUT.h.

Ifpack_ILUT& Ifpack_ILUT::operator= ( const Ifpack_ILUT & )

inlineprivate

operator= (should never be used)

Definition at line 325 of file Ifpack_ILUT.h.

template<typename int_type >

int Ifpack_ILUT::TCompute ( )

private

Definition at line 180 of file Ifpack_ILUT.cpp.

void Ifpack_ILUT::Destroy ( )

private

Releases all allocated memory.

Definition at line 100 of file Ifpack_ILUT.cpp.

Member Data Documentation

const Epetra_RowMatrix& Ifpack_ILUT::A_

private

reference to the matrix to be preconditioned.

Definition at line 340 of file Ifpack_ILUT.h.

const Epetra_Comm& Ifpack_ILUT::Comm_

private

Reference to the communicator object.

Definition at line 342 of file Ifpack_ILUT.h.

Teuchos::RefCountPtr<Epetra_CrsMatrix> Ifpack_ILUT::L_

private

L factor.

Definition at line 344 of file Ifpack_ILUT.h.

Teuchos::RefCountPtr<Epetra_CrsMatrix> Ifpack_ILUT::U_

private

U factor.

Definition at line 346 of file Ifpack_ILUT.h.

double Ifpack_ILUT::Condest_

private

Condition number estimate.

Definition at line 348 of file Ifpack_ILUT.h.

double Ifpack_ILUT::Relax_

private

relaxation value

Definition at line 350 of file Ifpack_ILUT.h.

double Ifpack_ILUT::Athresh_

private

Absolute threshold.

Definition at line 352 of file Ifpack_ILUT.h.

double Ifpack_ILUT::Rthresh_

private

Relative threshold.

Definition at line 354 of file Ifpack_ILUT.h.

double Ifpack_ILUT::LevelOfFill_

private

Level-of-fill.

Definition at line 356 of file Ifpack_ILUT.h.

double Ifpack_ILUT::DropTolerance_

private

Discards all elements below this tolerance.

Definition at line 358 of file Ifpack_ILUT.h.

std::string Ifpack_ILUT::Label_

private

Label for this object.

Definition at line 360 of file Ifpack_ILUT.h.

bool Ifpack_ILUT::IsInitialized_

private

true if this object has been initialized

Definition at line 362 of file Ifpack_ILUT.h.

bool Ifpack_ILUT::IsComputed_

private

true if this object has been computed

Definition at line 364 of file Ifpack_ILUT.h.

bool Ifpack_ILUT::UseTranspose_

private

true if transpose has to be used.

Definition at line 366 of file Ifpack_ILUT.h.

int Ifpack_ILUT::NumMyRows_

private

Number of local rows.

Definition at line 368 of file Ifpack_ILUT.h.

int Ifpack_ILUT::NumInitialize_

private

Contains the number of successful calls to Initialize().

Definition at line 370 of file Ifpack_ILUT.h.

int Ifpack_ILUT::NumCompute_

private

Contains the number of successful call to Compute().

Definition at line 372 of file Ifpack_ILUT.h.

int Ifpack_ILUT::NumApplyInverse_

mutableprivate

Contains the number of successful call to ApplyInverse().

Definition at line 374 of file Ifpack_ILUT.h.

double Ifpack_ILUT::InitializeTime_

private

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

Definition at line 376 of file Ifpack_ILUT.h.

double Ifpack_ILUT::ComputeTime_

private

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

Definition at line 378 of file Ifpack_ILUT.h.

double Ifpack_ILUT::ApplyInverseTime_

mutableprivate

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

Definition at line 380 of file Ifpack_ILUT.h.

double Ifpack_ILUT::ComputeFlops_

private

Contains the number of flops for Compute().

Definition at line 382 of file Ifpack_ILUT.h.

double Ifpack_ILUT::ApplyInverseFlops_

mutableprivate

Contain sthe number of flops for ApplyInverse().

Definition at line 384 of file Ifpack_ILUT.h.

Epetra_Time Ifpack_ILUT::Time_

mutableprivate

Used for timing purposed.

Definition at line 386 of file Ifpack_ILUT.h.

long long Ifpack_ILUT::GlobalNonzeros_

private

Global number of nonzeros in L and U factors.

Definition at line 388 of file Ifpack_ILUT.h.

Teuchos::RefCountPtr<Epetra_SerialComm> Ifpack_ILUT::SerialComm_

private

Definition at line 389 of file Ifpack_ILUT.h.

Teuchos::RefCountPtr<Epetra_Map> Ifpack_ILUT::SerialMap_

private

Definition at line 390 of file Ifpack_ILUT.h.

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