Interface for all Ifpack2 preconditioners. More...

#include <Ifpack2_Preconditioner.hpp>

Inheritance diagram for Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node >:

Public Types
typedef Teuchos::ScalarTraits < Scalar >::magnitudeType	magnitude_type
	The type of the magnitude (absolute value) of a matrix entry. More...

Public Member Functions
virtual	~Preconditioner ()
	Destructor. More...

virtual void	setParameters (const Teuchos::ParameterList &List)=0
	Set this preconditioner's parameters. More...

virtual void	setZeroStartingSolution (bool zeroStartingSolution)
	Set this preconditioner's parameters. More...

virtual void	initialize ()=0
	Set up the graph structure of this preconditioner. More...

virtual bool	isInitialized () const =0
	True if the preconditioner has been successfully initialized, else false. More...

virtual void	compute ()=0
	Set up the numerical values in this preconditioner. More...

virtual bool	isComputed () const =0
	True if the preconditioner has been successfully computed, else false. More...

virtual Teuchos::RCP< const Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	getMatrix () const =0
	The input matrix given to the constructor. More...

virtual int	getNumInitialize () const =0
	The number of calls to initialize(). More...

virtual int	getNumCompute () const =0
	The number of calls to compute(). More...

virtual int	getNumApply () const =0
	The number of calls to apply(). More...

virtual double	getInitializeTime () const =0
	The time (in seconds) spent in initialize(). More...

virtual double	getComputeTime () const =0
	The time (in seconds) spent in compute(). More...

virtual double	getApplyTime () const =0
	The time (in seconds) spent in apply(). More...

Methods implementing Tpetra::Operator.
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > >	getDomainMap () const =0
	The domain Map of this operator. More...

virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > >	getRangeMap () const =0
	The range Map of this operator. More...

virtual 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 =0
	Apply the preconditioner to X, putting the result in Y. More...

Detailed Description

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
class Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Interface for all Ifpack2 preconditioners.

Template Parameters

Scalar	Type of the matrix's entries; same as the first template parameter of Tpetra::RowMatrix
LocalOrdinal	Type of the matrix's local indices; same as the second template parameter of Tpetra::RowMatrix
GlobalOrdinal	Type of the matrix's global indices; same as the third template parameter of Tpetra::RowMatrix
Node	The matrix's Node type; same as the fourth template parameter of Tpetra::RowMatrix

The Preconditioner class defines the interface that all Ifpack2 preconditioners must implement. Preconditioner inherits from Tpetra::Operator. Its apply() method applies the preconditioner.

If you are familiar with the IFPACK package, please be aware that this is different from IFPACK. In IFPACK, the ApplyInverse() method applies or "solves with" the preconditioner $M^{-1}$, and the Apply() method "applies" the preconditioner $M$. In Ifpack2, the apply() method applies or "solves with" the preconditioner $M^{-1}$. Ifpack2 has no method comparable to IFPACK's Apply().

Preconditioner provides the following methods

initialize() performs all operations based on the graph of the matrix (without considering the numerical values)
isInitialized() returns true if the preconditioner has been successfully initialized
compute() computes everything required to apply the preconditioner, using the matrix's values (and assuming that the graph structure of the matrix has not changed)
isComputed() returns true if the preconditioner has been successfully computed, false otherwise.
getMatrix() returns a reference to the matrix to be preconditioned

Implementations of compute() must internally call initialize() if isInitialized() returns false. The preconditioner is applied by apply() (which returns if isComputed() is false). Every time that initialize() is called, the object destroys all the previously allocated information, and reinitializes the preconditioner. Every time compute() is called, the object recomputes the actual values of the preconditioner.

Member Typedef Documentation

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

typedef Teuchos::ScalarTraits<Scalar>::magnitudeType Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node >::magnitude_type

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

Constructor & Destructor Documentation

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

virtual Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~Preconditioner ( )

inlinevirtual

Destructor.

Member Function Documentation

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getDomainMap ( ) const

pure virtual

The domain Map of this operator.

The domain Map describes the distribution of valid input vectors X to the apply() method.

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> > Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getRangeMap ( ) const

pure virtual

The range Map of this operator.

The range Map describes the distribution of valid output vectors Y to the apply() method.

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

virtual void Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node >::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

pure virtual

Apply the preconditioner to X, putting the result in Y.

If the result of applying this preconditioner to a vector X is $F \cdot X$$, then this method computes $\beta Y + \alpha F \cdot X$. The typical case is $\beta = 0$ and $\alpha = 1$.

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

virtual void Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setParameters ( const Teuchos::ParameterList & List )

pure virtual

Set this preconditioner's parameters.

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

virtual void Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setZeroStartingSolution ( bool zeroStartingSolution )

inlinevirtual

Set this preconditioner's parameters.

Reimplemented in Ifpack2::AdditiveSchwarz< MatrixType, LocalInverseType >, Ifpack2::Chebyshev< MatrixType >, Ifpack2::Relaxation< MatrixType >, Ifpack2::BlockRelaxation< MatrixType, ContainerType >, Ifpack2::DatabaseSchwarz< MatrixType >, and Ifpack2::Hiptmair< MatrixType >.

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

virtual void Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node >::initialize ( )

pure virtual

Set up the graph structure of this preconditioner.

If the graph structure of the constructor's input matrix has changed, or if you have not yet called initialize(), you must call initialize() before you may call compute() or apply().

Thus, initialize() corresponds to the "symbolic factorization" step of a sparse factorization, whether or not the specific preconditioner actually does a sparse factorization.

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

virtual bool Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node >::isInitialized ( ) const

pure virtual

True if the preconditioner has been successfully initialized, else false.

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

virtual void Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node >::compute ( )

pure virtual

Set up the numerical values in this preconditioner.

If the values of the constructor's input matrix have changed, or if you have not yet called compute(), you must call compute() before you may call apply().

Thus, compute() corresponds to the "numeric factorization" step of a sparse factorization, whether or not the specific preconditioner actually does a sparse factorization.

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

virtual bool Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node >::isComputed ( ) const

pure virtual

True if the preconditioner has been successfully computed, else false.

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

virtual Teuchos::RCP<const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> > Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getMatrix ( ) const

pure virtual

The input matrix given to the constructor.

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

virtual int Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNumInitialize ( ) const

pure virtual

The number of calls to initialize().

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

virtual int Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNumCompute ( ) const

pure virtual

The number of calls to compute().

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

virtual int Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getNumApply ( ) const

pure virtual

The number of calls to apply().

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

virtual double Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getInitializeTime ( ) const

pure virtual

The time (in seconds) spent in initialize().

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

virtual double Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getComputeTime ( ) const

pure virtual

The time (in seconds) spent in compute().

template<class Scalar = Tpetra::Operator<>::scalar_type, class LocalOrdinal = typename Tpetra::Operator<Scalar>::local_ordinal_type, class GlobalOrdinal = typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type, class Node = typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>

virtual double Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getApplyTime ( ) const

pure virtual

The time (in seconds) spent in apply().

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

Ifpack2_Preconditioner.hpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation