A class for constructing and using an ILUT factorization. More...

#include <Ifpack2_ILUT_decl.hpp>

Inheritance diagram for Ifpack2::ILUT< MatrixType >:

Public Member Functions

	ILUT (const Teuchos::RCP< const Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &A)
	ILUT explicit constuctor with Tpetra::RowMatrix input.
virtual	~ILUT ()
	ILUT Destructor.

void	setParameters (const Teuchos::ParameterList &params)
	Set parameters for the preconditioner.
void	initialize ()
	Initialize ILUT preconditioner object.
bool	isInitialized () const
	Returns `true` if the preconditioner has been successfully initialized.
void	compute ()
	Compute factors L and U using the specified diagonal perturbation thresholds and relaxation parameters.
bool	isComputed () const
	If compute() is completed, this query returns true, otherwise it returns false.
Methods implementing Tpetra::Operator.
void	apply (const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=Teuchos::ScalarTraits< Scalar >::one(), Scalar beta=Teuchos::ScalarTraits< Scalar >::zero()) const
	Returns the result of a ILUT forward/back solve on a Tpetra::MultiVector X in Y.
const Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > &	getDomainMap () const
	Returns the Tpetra::Map object associated with the domain of this operator.
const Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > &	getRangeMap () const
	Returns the Tpetra::Map object associated with the range of this operator.
bool	hasTransposeApply () const
Mathematical functions.
magnitudeType	computeCondEst (CondestType CT=Cheap, LocalOrdinal MaxIters=1550, magnitudeType Tol=1e-9, const Teuchos::Ptr< const Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &Matrix_in=Teuchos::null)
	Computes the estimated condition number and returns the value.
magnitudeType	getCondEst () const
	Returns the computed estimated condition number, or -1.0 if no computed.
const Teuchos::RCP< const Teuchos::Comm< int > > &	getComm () const
	Returns the Tpetra::BlockMap object associated with the range of this matrix operator.
Teuchos::RCP< const Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	getMatrix () const
	Returns a reference to the matrix to be preconditioned.
const Teuchos::RCP< const MatrixType >	getL () const
	Returns a reference to the L factor.
const Teuchos::RCP< const MatrixType >	getU () const
	Returns a reference to the U factor.
int	getNumInitialize () const
	Returns the number of calls to Initialize().
int	getNumCompute () const
	Returns the number of calls to Compute().
int	getNumApply () const
	Returns the number of calls to apply().
double	getInitializeTime () const
	Returns the time spent in Initialize().
double	getComputeTime () const
	Returns the time spent in Compute().
double	getApplyTime () const
	Returns the time spent in apply().
double	getLevelOfFill () const
double	getAbsoluteThreshold () const
	Get absolute threshold value.
double	getRelativeThreshold () const
	Get relative threshold value.
magnitudeType	getRelaxValue () const
	Get the relax value.
magnitudeType	getDropTolerance () const
	Gets the dropping tolerance.
global_size_t	getGlobalNumEntries () const
	Returns the number of nonzero entries in the global graph.
size_t	getNodeNumEntries () const
	Returns the number of nonzero entries in the local graph.
Overridden from Teuchos::Describable
std::string	description () const
	Return a simple one-line description of this object.
void	describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
	Print the object with some verbosity level to an FancyOStream object.

Detailed Description

template<class MatrixType>
class Ifpack2::ILUT< MatrixType >

A class for constructing and using an ILUT factorization.

Ifpack2::ILUT computes an ILUT factorization with specified fill and drop-tolerance, of a given Tpetra::RowMatrix.

For all valid parameters, see the method ILUT::setParameters.

Constructor & Destructor Documentation

template<class MatrixType >

Ifpack2::ILUT< MatrixType >::ILUT ( const Teuchos::RCP< const Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > & A ) [explicit]

ILUT explicit constuctor with Tpetra::RowMatrix input.

template<class MatrixType >

Ifpack2::ILUT< MatrixType >::~ILUT ( ) [virtual]

ILUT Destructor.

Member Function Documentation

template<class MatrixType >

void Ifpack2::ILUT< MatrixType >::setParameters ( const Teuchos::ParameterList & params ) [virtual]

Set parameters for the preconditioner.

"fact: ilut level-of-fill" (int)
"fact: drop tolerance" (magnitude-type)
"fact: absolute threshold" (magnitude-type)
"fact: relative threshold" (magnitude-type)
"fact: relax value" (magnitude-type)

Implements Ifpack2::Preconditioner< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type >.

template<class MatrixType >

void Ifpack2::ILUT< MatrixType >::initialize ( ) [virtual]

Initialize ILUT preconditioner object.

Clear away any previously-allocated L and U objects.

Implements Ifpack2::Preconditioner< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type >.

template<class MatrixType>

bool Ifpack2::ILUT< MatrixType >::isInitialized ( ) const [inline, virtual]

Returns true if the preconditioner has been successfully initialized.

Implements Ifpack2::Preconditioner< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type >.

template<class MatrixType >

void Ifpack2::ILUT< MatrixType >::compute ( ) [virtual]

Compute factors L and U using the specified diagonal perturbation thresholds and relaxation parameters.

This function computes the ILUT factors L and U using the current:

Value for the drop tolerance
Value for the level of fill
Value for the a priori diagonal threshold values.

Implements Ifpack2::Preconditioner< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type >.

template<class MatrixType>

bool Ifpack2::ILUT< MatrixType >::isComputed ( ) const [inline, virtual]

If compute() is completed, this query returns true, otherwise it returns false.

Implements Ifpack2::Preconditioner< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type >.

template<class MatrixType>

void Ifpack2::ILUT< MatrixType >::apply	(	const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	X,
		Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	Y,
		Teuchos::ETransp	mode = `Teuchos::NO_TRANS`,
		Scalar	alpha = `Teuchos::ScalarTraits<Scalar>::one()`,
		Scalar	beta = `Teuchos::ScalarTraits<Scalar>::zero()`
	)		const `[virtual]`

Returns the result of a ILUT forward/back solve on a Tpetra::MultiVector X in Y.

Parameters:

X	- (In) A Tpetra::MultiVector of dimension NumVectors to solve for.
Y	- (Out) A Tpetra::MultiVector of dimension NumVectorscontaining result.

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

Implements Ifpack2::Preconditioner< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type >.

template<class MatrixType >

const Teuchos::RCP< const Tpetra::Map< typename MatrixType::local_ordinal_type, typename MatrixType::global_ordinal_type, typename MatrixType::node_type > > & Ifpack2::ILUT< MatrixType >::getDomainMap ( ) const [virtual]

Returns the Tpetra::Map object associated with the domain of this operator.

Implements Ifpack2::Preconditioner< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type >.

template<class MatrixType >

const Teuchos::RCP< const Tpetra::Map< typename MatrixType::local_ordinal_type, typename MatrixType::global_ordinal_type, typename MatrixType::node_type > > & Ifpack2::ILUT< MatrixType >::getRangeMap ( ) const [virtual]

Returns the Tpetra::Map object associated with the range of this operator.

Implements Ifpack2::Preconditioner< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type >.

template<class MatrixType >

Teuchos::ScalarTraits< typename MatrixType::scalar_type >::magnitudeType Ifpack2::ILUT< MatrixType >::computeCondEst	(	CondestType	CT = `Cheap`,
		LocalOrdinal	MaxIters = `1550`,
		magnitudeType	Tol = `1e-9`,
		const Teuchos::Ptr< const Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &	Matrix_in = `Teuchos::null`
	)		`[virtual]`

Computes the estimated condition number and returns the value.

Implements Ifpack2::Preconditioner< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type >.

template<class MatrixType>

magnitudeType Ifpack2::ILUT< MatrixType >::getCondEst ( ) const [inline, virtual]

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

Implements Ifpack2::Preconditioner< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type >.

template<class MatrixType >

const Teuchos::RCP< const Teuchos::Comm< int > > & Ifpack2::ILUT< MatrixType >::getComm ( ) const

Returns the Tpetra::BlockMap object associated with the range of this matrix operator.

template<class MatrixType >

Teuchos::RCP< const Tpetra::RowMatrix< typename MatrixType::scalar_type, typename MatrixType::local_ordinal_type, typename MatrixType::global_ordinal_type, typename MatrixType::node_type > > Ifpack2::ILUT< MatrixType >::getMatrix ( ) const [virtual]

Returns a reference to the matrix to be preconditioned.

Implements Ifpack2::Preconditioner< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type >.

template<class MatrixType>

const Teuchos::RCP<const MatrixType> Ifpack2::ILUT< MatrixType >::getL ( ) const [inline]

Returns a reference to the L factor.

template<class MatrixType>

const Teuchos::RCP<const MatrixType> Ifpack2::ILUT< MatrixType >::getU ( ) const [inline]

Returns a reference to the U factor.

template<class MatrixType >

int Ifpack2::ILUT< MatrixType >::getNumInitialize ( ) const [virtual]

Returns the number of calls to Initialize().

Implements Ifpack2::Preconditioner< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type >.

template<class MatrixType >

int Ifpack2::ILUT< MatrixType >::getNumCompute ( ) const [virtual]

Returns the number of calls to Compute().

Implements Ifpack2::Preconditioner< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type >.

template<class MatrixType >

int Ifpack2::ILUT< MatrixType >::getNumApply ( ) const [virtual]

Returns the number of calls to apply().

Implements Ifpack2::Preconditioner< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type >.

template<class MatrixType >

double Ifpack2::ILUT< MatrixType >::getInitializeTime ( ) const [virtual]

Returns the time spent in Initialize().

Implements Ifpack2::Preconditioner< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type >.

template<class MatrixType >

double Ifpack2::ILUT< MatrixType >::getComputeTime ( ) const [virtual]

Returns the time spent in Compute().

Implements Ifpack2::Preconditioner< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type >.

template<class MatrixType >

double Ifpack2::ILUT< MatrixType >::getApplyTime ( ) const [virtual]

Returns the time spent in apply().

Implements Ifpack2::Preconditioner< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type >.

template<class MatrixType>

double Ifpack2::ILUT< MatrixType >::getAbsoluteThreshold ( ) const [inline]

Get absolute threshold value.

template<class MatrixType>

double Ifpack2::ILUT< MatrixType >::getRelativeThreshold ( ) const [inline]

Get relative threshold value.

template<class MatrixType>

magnitudeType Ifpack2::ILUT< MatrixType >::getRelaxValue ( ) const [inline]

Get the relax value.

template<class MatrixType>

magnitudeType Ifpack2::ILUT< MatrixType >::getDropTolerance ( ) const [inline]

Gets the dropping tolerance.

template<class MatrixType >

global_size_t Ifpack2::ILUT< MatrixType >::getGlobalNumEntries ( ) const

Returns the number of nonzero entries in the global graph.

template<class MatrixType >

size_t Ifpack2::ILUT< MatrixType >::getNodeNumEntries ( ) const

Returns the number of nonzero entries in the local graph.

template<class MatrixType >

std::string Ifpack2::ILUT< MatrixType >::description ( ) const

Return a simple one-line description of this object.

template<class MatrixType >

void Ifpack2::ILUT< MatrixType >::describe	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verbLevel = `Teuchos::Describable::verbLevel_default`
	)		const

Print the object with some verbosity level to an FancyOStream object.

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

Public Member Functions

Detailed Description

template<class MatrixType> class Ifpack2::ILUT< MatrixType >

Constructor & Destructor Documentation

Member Function Documentation

template<class MatrixType>
class Ifpack2::ILUT< MatrixType >