Ifpack2 Templated Preconditioning Package Version 1.0
Ifpack2::ILUT< MatrixType > Class Template Reference

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

#include <Ifpack2_ILUT_decl.hpp>

Inheritance diagram for Ifpack2::ILUT< MatrixType >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 ILUT (const Teuchos::RCP< const Tpetra::RowMatrix< scalar_type, local_ordinal_type, global_ordinal_type, node_type > > &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_type, local_ordinal_type, global_ordinal_type, node_type > &X, Tpetra::MultiVector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, scalar_type alpha=Teuchos::ScalarTraits< scalar_type >::one(), scalar_type beta=Teuchos::ScalarTraits< scalar_type >::zero()) const
 Returns the result of a ILUT forward/back solve on a Tpetra::MultiVector X in Y.
const Teuchos::RCP< const
Tpetra::Map
< local_ordinal_type,
global_ordinal_type, node_type > > & 
getDomainMap () const
 Tpetra::Map representing the domain of this operator.
const Teuchos::RCP< const
Tpetra::Map
< local_ordinal_type,
global_ordinal_type, node_type > > & 
getRangeMap () const
 Tpetra::Map representing the range of this operator.
bool hasTransposeApply () const
 Whether this object's apply() method can apply the transpose (or conjugate transpose, if applicable).
Mathematical functions.
magnitude_type computeCondEst (CondestType CT=Cheap, local_ordinal_type MaxIters=1550, magnitude_type Tol=1e-9, const Teuchos::Ptr< const Tpetra::RowMatrix< scalar_type, local_ordinal_type, global_ordinal_type, node_type > > &Matrix_in=Teuchos::null)
 Computes the estimated condition number and returns the value.
magnitude_type 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_type,
local_ordinal_type,
global_ordinal_type, node_type > > 
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().
magnitude_type getLevelOfFill () const
 The level of fill.
magnitude_type getAbsoluteThreshold () const
 Get absolute threshold value.
magnitude_type getRelativeThreshold () const
 Get relative threshold value.
magnitude_type getRelaxValue () const
 Get the relax value.
magnitude_type 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.
typedef MatrixType::scalar_type scalar_type
 The type of the entries of the input MatrixType.
typedef
MatrixType::local_ordinal_type 
local_ordinal_type
 The type of local indices in the input MatrixType.
typedef
MatrixType::global_ordinal_type 
global_ordinal_type
 The type of global indices in the input MatrixType.
typedef MatrixType::node_type node_type
 The type of the Kokkos Node used by the input MatrixType.
typedef Teuchos::ScalarTraits
< scalar_type >::magnitudeType 
magnitude_type
 The type of the magnitude (absolute value) of a matrix entry.
TEUCHOS_DEPRECATED typedef
MatrixType::scalar_type 
Scalar
 Preserved only for backwards compatibility. Please use "scalar_type".
TEUCHOS_DEPRECATED typedef
MatrixType::local_ordinal_type 
LocalOrdinal
 Preserved only for backwards compatibility. Please use "local_ordinal_type".
TEUCHOS_DEPRECATED typedef
MatrixType::global_ordinal_type 
GlobalOrdinal
 Preserved only for backwards compatibility. Please use "global_ordinal_type".
TEUCHOS_DEPRECATED typedef
MatrixType::node_type 
Node
 Preserved only for backwards compatibility. Please use "node_type".
TEUCHOS_DEPRECATED typedef
Teuchos::ScalarTraits
< scalar_type >::magnitudeType 
magnitudeType
 Preserved only for backwards compatibility. Please use "magnitude_type".

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.


Member Typedef Documentation

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

The type of the entries of the input MatrixType.

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

The type of local indices in the input MatrixType.

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

The type of global indices in the input MatrixType.

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

The type of the Kokkos Node used by the input MatrixType.

template<class MatrixType>
typedef Teuchos::ScalarTraits<scalar_type>::magnitudeType Ifpack2::ILUT< MatrixType >::magnitude_type

The type of the magnitude (absolute value) of a matrix entry.


Constructor & Destructor Documentation

template<class MatrixType >
Ifpack2::ILUT< MatrixType >::ILUT ( const Teuchos::RCP< const Tpetra::RowMatrix< scalar_type, local_ordinal_type, global_ordinal_type, node_type > > &  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]
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:

  1. Value for the drop tolerance
  2. Value for the level of fill
  3. 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]
template<class MatrixType>
void Ifpack2::ILUT< MatrixType >::apply ( const Tpetra::MultiVector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &  X,
Tpetra::MultiVector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &  Y,
Teuchos::ETransp  mode = Teuchos::NO_TRANS,
scalar_type  alpha = Teuchos::ScalarTraitsscalar_type >::one(),
scalar_type  beta = Teuchos::ScalarTraitsscalar_type >::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 NumVectors containing result.

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]
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]
template<class MatrixType >
bool Ifpack2::ILUT< MatrixType >::hasTransposeApply ( ) const

Whether this object's apply() method can apply the transpose (or conjugate transpose, if applicable).

template<class MatrixType >
ILUT< MatrixType >::magnitude_type Ifpack2::ILUT< MatrixType >::computeCondEst ( CondestType  CT = Cheap,
local_ordinal_type  MaxIters = 1550,
magnitude_type  Tol = 1e-9,
const Teuchos::Ptr< const Tpetra::RowMatrix< scalar_type, local_ordinal_type, global_ordinal_type, node_type > > &  Matrix_in = Teuchos::null 
) [virtual]
template<class MatrixType>
magnitude_type Ifpack2::ILUT< MatrixType >::getCondEst ( ) const [inline, virtual]
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]
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]
template<class MatrixType >
int Ifpack2::ILUT< MatrixType >::getNumCompute ( ) const [virtual]
template<class MatrixType >
int Ifpack2::ILUT< MatrixType >::getNumApply ( ) const [virtual]
template<class MatrixType >
double Ifpack2::ILUT< MatrixType >::getInitializeTime ( ) const [virtual]
template<class MatrixType >
double Ifpack2::ILUT< MatrixType >::getComputeTime ( ) const [virtual]
template<class MatrixType >
double Ifpack2::ILUT< MatrixType >::getApplyTime ( ) const [virtual]
template<class MatrixType>
magnitude_type Ifpack2::ILUT< MatrixType >::getLevelOfFill ( ) const [inline]

The level of fill.

template<class MatrixType>
magnitude_type Ifpack2::ILUT< MatrixType >::getAbsoluteThreshold ( ) const [inline]

Get absolute threshold value.

template<class MatrixType>
magnitude_type Ifpack2::ILUT< MatrixType >::getRelativeThreshold ( ) const [inline]

Get relative threshold value.

template<class MatrixType>
magnitude_type Ifpack2::ILUT< MatrixType >::getRelaxValue ( ) const [inline]

Get the relax value.

template<class MatrixType>
magnitude_type 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.


Member Data Documentation

template<class MatrixType>
TEUCHOS_DEPRECATED typedef MatrixType::scalar_type Ifpack2::ILUT< MatrixType >::Scalar

Preserved only for backwards compatibility. Please use "scalar_type".

template<class MatrixType>
TEUCHOS_DEPRECATED typedef MatrixType::local_ordinal_type Ifpack2::ILUT< MatrixType >::LocalOrdinal

Preserved only for backwards compatibility. Please use "local_ordinal_type".

template<class MatrixType>
TEUCHOS_DEPRECATED typedef MatrixType::global_ordinal_type Ifpack2::ILUT< MatrixType >::GlobalOrdinal

Preserved only for backwards compatibility. Please use "global_ordinal_type".

template<class MatrixType>
TEUCHOS_DEPRECATED typedef MatrixType::node_type Ifpack2::ILUT< MatrixType >::Node

Preserved only for backwards compatibility. Please use "node_type".

template<class MatrixType>
TEUCHOS_DEPRECATED typedef Teuchos::ScalarTraits<scalar_type>::magnitudeType Ifpack2::ILUT< MatrixType >::magnitudeType

Preserved only for backwards compatibility. Please use "magnitude_type".

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


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends