#include <Ifpack2_Diagonal_decl.hpp>

Inheritance diagram for Ifpack2::Diagonal< MatrixType >:

[legend]

Public Types
typedef Tpetra::RowMatrix< scalar_type, local_ordinal_type, global_ordinal_type, node_type >	row_matrix_type
	Tpetra::RowMatrix specialization used by this class.

typedef Tpetra::CrsMatrix< scalar_type, local_ordinal_type, global_ordinal_type, node_type >	crs_matrix_type
	Tpetra::CrsMatrix specialization used by this class.

typedef Tpetra::Vector< scalar_type, local_ordinal_type, global_ordinal_type, node_type >	vector_type
	Tpetra::Vector specialization used by this class.

typedef Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type >	map_type
	Tpetra::Map specialization used by this class.

Public Types inherited from Ifpack2::Preconditioner< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type >
typedef Teuchos::ScalarTraits< MatrixType::scalar_type >::magnitudeType	magnitude_type
	The type of the magnitude (absolute value) of a matrix entry.

Public Member Functions
	Diagonal (const Teuchos::RCP< const row_matrix_type > &A)
	Constructor that takes a Tpetra::RowMatrix.

	Diagonal (const Teuchos::RCP< const crs_matrix_type > &A_in)
	Constructor that takes a Tpetra::CrsMatrix.

	Diagonal (const Teuchos::RCP< const vector_type > &diag)
	Constructor that accepts a Tpetra::Vector of inverse diagonal entries.

virtual	~Diagonal ()
	Destructor.

void	setParameters (const Teuchos::ParameterList &params)
	Sets parameters on this object.

void	initialize ()
	Initialize.

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

void	compute ()
	Compute the preconditioner.

bool	isComputed () const
	Return true if compute() has been called.

Implementation of Ifpack2::Details::CanChangeMatrix
virtual void	setMatrix (const Teuchos::RCP< const row_matrix_type > &A)
	Change the matrix to be preconditioned.

Implementation of 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
	Apply the preconditioner to X, putting the result in Y.

Teuchos::RCP< const map_type >	getDomainMap () const
	The Tpetra::Map representing this operator's domain.

Teuchos::RCP< const map_type >	getRangeMap () const
	The Tpetra::Map representing this operator's range.

Attribute accessor methods
Teuchos::RCP< const row_matrix_type >	getMatrix () const
	Return the communicator associated with this matrix operator.

double	getComputeFlops () const
	Return the number of flops in the computation phase.

double	getApplyFlops () const
	Return the number of flops for the application of the preconditioner.

int	getNumInitialize () const
	Return the number of calls to initialize().

int	getNumCompute () const
	Return the number of calls to compute().

int	getNumApply () const
	Return the number of calls to apply().

double	getInitializeTime () const
	Return the time spent in initialize().

double	getComputeTime () const
	Return the time spent in compute().

double	getApplyTime () const
	Return the time spent in apply().

Public Member Functions inherited from Ifpack2::Preconditioner< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type >
virtual	~Preconditioner ()
	Destructor.

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

Public Member Functions inherited from Ifpack2::Details::CanChangeMatrix< Tpetra::RowMatrix< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type > >
virtual void	setMatrix (const Teuchos::RCP< const Tpetra::RowMatrix< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type > > &A)=0
	Set the new matrix.

virtual	~CanChangeMatrix ()
	Destructor.

Implementation of Teuchos::Describable
std::string	description () const
	Return a 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::Diagonal< MatrixType >

Diagonal preconditioner.

Template Parameters

MatrixType A specialization of Tpetra::RowMatrix.

This class wraps a Tpetra::Vector as a diagonal preconditioner. The preconditioner is defined as

\[ z_i = D_i r_i, \]

where \(r\) is the Vector to be preconditioned, \(z\) is the Vector result of applying the preconditioner to \(r\), and \(D_i\) is the i-th element of the scaling vector.

When Diagonal is constructed with a matrix, \(D\) contains the inverted diagonal elements from the matrix. When Diagonal is constructed with a Tpetra::Vector, \(D\) is the caller-supplied vector.

Member Typedef Documentation

◆ row_matrix_type

template<class MatrixType >

typedef Tpetra::RowMatrix<scalar_type, local_ordinal_type, global_ordinal_type, node_type> Ifpack2::Diagonal< MatrixType >::row_matrix_type

Tpetra::RowMatrix specialization used by this class.

◆ crs_matrix_type

template<class MatrixType >

typedef Tpetra::CrsMatrix<scalar_type, local_ordinal_type, global_ordinal_type, node_type> Ifpack2::Diagonal< MatrixType >::crs_matrix_type

Tpetra::CrsMatrix specialization used by this class.

◆ vector_type

template<class MatrixType >

typedef Tpetra::Vector<scalar_type, local_ordinal_type, global_ordinal_type, node_type> Ifpack2::Diagonal< MatrixType >::vector_type

Tpetra::Vector specialization used by this class.

◆ map_type

template<class MatrixType >

typedef Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> Ifpack2::Diagonal< MatrixType >::map_type

Tpetra::Map specialization used by this class.

Constructor & Destructor Documentation

◆ Diagonal() [1/3]

template<class MatrixType >

Ifpack2::Diagonal< MatrixType >::Diagonal ( const Teuchos::RCP< const row_matrix_type > & A )

Constructor that takes a Tpetra::RowMatrix.

Parameters

A_in	[in] The input matrix.

◆ Diagonal() [2/3]

template<class MatrixType >

Ifpack2::Diagonal< MatrixType >::Diagonal ( const Teuchos::RCP< const crs_matrix_type > & A_in )

Constructor that takes a Tpetra::CrsMatrix.

This constructor exists to avoid "ambiguous constructor" warnings. It does the same thing as the constructor that takes a Tpetra::RowMatrix.

Parameters

A_in	[in] The input matrix.

◆ Diagonal() [3/3]

template<class MatrixType >

Ifpack2::Diagonal< MatrixType >::Diagonal ( const Teuchos::RCP< const vector_type > & diag )

Constructor that accepts a Tpetra::Vector of inverse diagonal entries.

Parameters

diag	[in] Vector of inverse diagonal entries.

If your compiler complains about this constructor being ambigous with the other constructor overload, instead call the free-standing function Ifpack2::createDiagonalPreconditioner which is located at the bottom of this header file. (This issue may arise if this constructor is called with a Teuchos::RCP<Tpetra::Vector> that isn't const-qualified exactly as declared here.)

◆ ~Diagonal()

template<class MatrixType >

Ifpack2::Diagonal< MatrixType >::~Diagonal ( )

virtual

Destructor.

Member Function Documentation

◆ setParameters()

template<class MatrixType >

void Ifpack2::Diagonal< MatrixType >::setParameters ( const Teuchos::ParameterList & params )

virtual

Sets parameters on this object.

Currently doesn't need any parameters.

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

◆ initialize()

template<class MatrixType >

void Ifpack2::Diagonal< MatrixType >::initialize ( )

virtual

Initialize.

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

◆ isInitialized()

template<class MatrixType >

bool Ifpack2::Diagonal< MatrixType >::isInitialized ( ) const

inlinevirtual

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

◆ compute()

template<class MatrixType >

void Ifpack2::Diagonal< MatrixType >::compute ( )

virtual

Compute the preconditioner.

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

◆ isComputed()

template<class MatrixType >

bool Ifpack2::Diagonal< MatrixType >::isComputed ( ) const

inlinevirtual

Return true if compute() has been called.

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

◆ setMatrix()

template<class MatrixType >

void Ifpack2::Diagonal< MatrixType >::setMatrix ( const Teuchos::RCP< const row_matrix_type > & A )

virtual

Change the matrix to be preconditioned.

Parameters

A	[in] The new matrix.

Postcondition: ! isInitialized (); ! isComputed ()

Calling this method with a matrix different than the current matrix resets the preconditioner's state. After calling this method with a nonnull input, you must first call initialize() and compute() (in that order) before you may call apply().

You may call this method with a null input. If A is null, then you may not call initialize() or compute() until you first call this method again with a nonnull input. This method invalidates any previous factorization whether or not A is null, so calling setMatrix() with a null input is one way to clear the preconditioner's state (and free any memory that it may be using).

The new matrix A need not necessarily have the same Maps or even the same communicator as the original matrix.

◆ apply()

template<class MatrixType >

void Ifpack2::Diagonal< 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::ScalarTraits<scalar_type>::one()`,
		scalar_type	beta = `Teuchos::ScalarTraits<scalar_type>::zero()`
	)		const

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\).

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

◆ getDomainMap()

template<class MatrixType >

Teuchos::RCP< const typename Diagonal< MatrixType >::map_type > Ifpack2::Diagonal< MatrixType >::getDomainMap ( ) const

virtual

The Tpetra::Map representing this operator's domain.

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

◆ getRangeMap()

template<class MatrixType >

Teuchos::RCP< const typename Diagonal< MatrixType >::map_type > Ifpack2::Diagonal< MatrixType >::getRangeMap ( ) const

virtual

The Tpetra::Map representing this operator's range.

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

◆ getMatrix()

template<class MatrixType >

Teuchos::RCP< const row_matrix_type > Ifpack2::Diagonal< MatrixType >::getMatrix ( ) const

inlinevirtual

Return the communicator associated with this matrix operator.

The original input matrix to be preconditioned.

This could be null, for example if the user created this object using the constructor that takes a Tpetra::Vector, or if the user called setMatrix() with a null input.

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

◆ getComputeFlops()

template<class MatrixType >

double Ifpack2::Diagonal< MatrixType >::getComputeFlops ( ) const

Return the number of flops in the computation phase.

◆ getApplyFlops()

template<class MatrixType >

double Ifpack2::Diagonal< MatrixType >::getApplyFlops ( ) const

Return the number of flops for the application of the preconditioner.

◆ getNumInitialize()

template<class MatrixType >

int Ifpack2::Diagonal< MatrixType >::getNumInitialize ( ) const

virtual

Return the number of calls to initialize().

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

◆ getNumCompute()

template<class MatrixType >

int Ifpack2::Diagonal< MatrixType >::getNumCompute ( ) const

virtual

Return the number of calls to compute().

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

◆ getNumApply()

template<class MatrixType >

int Ifpack2::Diagonal< MatrixType >::getNumApply ( ) const

virtual

Return the number of calls to apply().

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

◆ getInitializeTime()

template<class MatrixType >

double Ifpack2::Diagonal< MatrixType >::getInitializeTime ( ) const

virtual

Return the time spent in initialize().

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

◆ getComputeTime()

template<class MatrixType >

double Ifpack2::Diagonal< MatrixType >::getComputeTime ( ) const

virtual

Return the time spent in compute().

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

◆ getApplyTime()

template<class MatrixType >

double Ifpack2::Diagonal< MatrixType >::getApplyTime ( ) const

virtual

Return the time spent in apply().

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

◆ description()

template<class MatrixType >

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

Return a one-line description of this object.

◆ describe()

template<class MatrixType >

void Ifpack2::Diagonal< 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 Types

Public Member Functions

Implementation of Teuchos::Describable

Detailed Description

Member Typedef Documentation

◆ row_matrix_type

◆ crs_matrix_type

◆ vector_type

◆ map_type

Constructor & Destructor Documentation

◆ Diagonal() [1/3]

◆ Diagonal() [2/3]

◆ Diagonal() [3/3]

◆ ~Diagonal()

Member Function Documentation

◆ setParameters()

◆ initialize()

◆ isInitialized()

◆ compute()

◆ isComputed()

◆ setMatrix()

◆ apply()

◆ getDomainMap()

◆ getRangeMap()

◆ getMatrix()

◆ getComputeFlops()

◆ getApplyFlops()

◆ getNumInitialize()

◆ getNumCompute()

◆ getNumApply()

◆ getInitializeTime()

◆ getComputeTime()

◆ getApplyTime()

◆ description()

◆ describe()