A wrapper to SuperLU 4.0's supernodal ILUT w/ partial pivoting. More...

#include <Ifpack_SILU.h>

Inheritance diagram for Ifpack_SILU:

Collaboration diagram for Ifpack_SILU:

Public Member Functions
Constructors and destructors.
	Ifpack_SILU (Epetra_RowMatrix *A)
	Constructor.

	~Ifpack_SILU ()
	Destructor.

Construction methods
int	Initialize ()
	Initialize the preconditioner, does not touch matrix values.

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

int	Compute ()
	Compute ILU factors L and 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	SetParameters (Teuchos::ParameterList &parameterlist)
	Set parameters using a Teuchos::ParameterList object.

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

Mathematical functions.
int	Apply (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const

int	Multiply (bool Trans, const Epetra_MultiVector &X, Epetra_MultiVector &Y) const

int	ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
	Returns the result of a Epetra_Operator inverse applied to an Epetra_MultiVector X in Y. More...

double	Condest (const Ifpack_CondestType CT=Ifpack_Cheap, const int MaxIters=1550, const double Tol=1e-9, Epetra_RowMatrix *Matrix_in=0)
	Computes the estimated condition number and returns the value.

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

Query methods
const char *	Label () const
	Returns a character string describing the operator.

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

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.

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

virtual std::ostream &	Print (std::ostream &os) const
	Prints on stream basic information about `this` object.

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.

Detailed Description

A wrapper to SuperLU 4.0's supernodal ILUT w/ partial pivoting.

The Ifpack_SILU class is a wrapper to SuperLU 4.0's supernodal ILUT w/ partial pivoting.

Author: Chris Siefert, SNL 1431

Date: Last modified on 07-Apr-10

Definition at line 89 of file Ifpack_SILU.h.

Member Function Documentation

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

virtual

Returns the result of a Epetra_Operator inverse applied to an Epetra_MultiVector X in Y.

In this implementation, we use several existing attributes to determine how virtual method ApplyInverse() should call the concrete method Solve(). We pass in the UpperTriangular(), the Epetra_CrsMatrix::UseTranspose(), and NoDiagonal() methods. The most notable warning is that if a matrix has no diagonal values we assume that there is an implicit unit diagonal that should be accounted for when doing a triangular solve.

Parameters

X	- (In) A Epetra_MultiVector of dimension NumVectors to solve for.
Out	Y - (Out) A Epetra_MultiVector of dimension NumVectors containing result.

Returns: Integer error code, set to 0 if successful.

Implements Ifpack_Preconditioner.

Definition at line 358 of file Ifpack_SILU.cpp.

References Epetra_Time::ElapsedTime(), IsComputed(), Epetra_Time::ResetStartTime(), and UseTranspose().

int Ifpack_SILU::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 145 of file Ifpack_SILU.h.

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

Public Member Functions

Detailed Description

Member Function Documentation