Wrapper for Hiptmair smoothers. More...

#include <Ifpack2_Hiptmair_decl.hpp>

Inheritance diagram for Ifpack2::Hiptmair< MatrixType >:

[legend]

Public Types
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 Node type used by the input MatrixType.

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

typedef Tpetra::RowMatrix< scalar_type, local_ordinal_type, global_ordinal_type, node_type >	row_matrix_type
	Type of the Tpetra::RowMatrix specialization that this class uses.

typedef Ifpack2::Preconditioner< scalar_type, local_ordinal_type, global_ordinal_type, node_type >	prec_type
	Type of the Ifpack2::Preconditioner specialization from which this class inherits.

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
	Hiptmair (const Teuchos::RCP< const row_matrix_type > &A)
	Constructor that takes 1 Tpetra matrix (assumes we'll get the rest off the parameter list)

	Hiptmair (const Teuchos::RCP< const row_matrix_type > &A, const Teuchos::RCP< const row_matrix_type > &PtAP, const Teuchos::RCP< const row_matrix_type > &P, const Teuchos::RCP< const row_matrix_type > &Pt=Teuchos::null)
	Constructor that takes 3 Tpetra matrices.

virtual	~Hiptmair ()
	Destructor.

Methods for setting parameters and initialization
void	setParameters (const Teuchos::ParameterList &params)
	Set the preconditioner's parameters.

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

void	initialize ()
	Do any initialization that depends on the input matrix's structure.

bool	isInitialized () const
	Return `true` if initialize() completed successfully, else `false`.

void	compute ()
	Do any initialization that depends on the input matrix's values.

bool	isComputed () const
	Return `true` if compute() completed successfully, else `false`.

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.

void	updateCachedMultiVectors (const Teuchos::RCP< const Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type > > &map1, const Teuchos::RCP< const Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type > > &map2, size_t numVecs) const
	A service routine for updating the cached MultiVectors.

Teuchos::RCP< const Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type > >	getDomainMap () const
	Tpetra::Map representing the domain of this operator.

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.
Teuchos::RCP< const Teuchos::Comm< int > >	getComm () const
	Returns the operator's communicator.

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.

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

Teuchos::RCP< Ifpack2::Preconditioner< typename MatrixType::scalar_type, typename MatrixType::local_ordinal_type, typename MatrixType::global_ordinal_type, typename MatrixType::node_type > >	getPrec1 ()
	Returns prec 1.

Teuchos::RCP< Ifpack2::Preconditioner< typename MatrixType::scalar_type, typename MatrixType::local_ordinal_type, typename MatrixType::global_ordinal_type, typename MatrixType::node_type > >	getPrec2 ()
	Returns prec 2.

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

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::Hiptmair< MatrixType >

Wrapper for Hiptmair smoothers.

Template Parameters

A	specialization of Tpetra::RowMatrix.

Ifpack2::Hiptmair does smoothing on two spaces; a primary space and an auxiliary space. This situation arises when preconditioning Maxwell's equations discretized by edge elements.

For a list of all run-time parameters that this class accepts, see the documentation of setParameters().

Member Typedef Documentation

◆ scalar_type

template<class MatrixType >

typedef MatrixType::scalar_type Ifpack2::Hiptmair< MatrixType >::scalar_type

The type of the entries of the input MatrixType.

◆ local_ordinal_type

template<class MatrixType >

typedef MatrixType::local_ordinal_type Ifpack2::Hiptmair< MatrixType >::local_ordinal_type

The type of local indices in the input MatrixType.

◆ global_ordinal_type

template<class MatrixType >

typedef MatrixType::global_ordinal_type Ifpack2::Hiptmair< MatrixType >::global_ordinal_type

The type of global indices in the input MatrixType.

◆ node_type

template<class MatrixType >

typedef MatrixType::node_type Ifpack2::Hiptmair< MatrixType >::node_type

The Node type used by the input MatrixType.

◆ magnitude_type

template<class MatrixType >

typedef Teuchos::ScalarTraits<scalar_type>::magnitudeType Ifpack2::Hiptmair< MatrixType >::magnitude_type

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

◆ row_matrix_type

template<class MatrixType >

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

Type of the Tpetra::RowMatrix specialization that this class uses.

◆ prec_type

template<class MatrixType >

typedef Ifpack2::Preconditioner<scalar_type, local_ordinal_type, global_ordinal_type, node_type> Ifpack2::Hiptmair< MatrixType >::prec_type

Type of the Ifpack2::Preconditioner specialization from which this class inherits.

Constructor & Destructor Documentation

◆ Hiptmair() [1/2]

template<class MatrixType >

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

explicit

Constructor that takes 1 Tpetra matrix (assumes we'll get the rest off the parameter list)

◆ Hiptmair() [2/2]

template<class MatrixType >

Ifpack2::Hiptmair< MatrixType >::Hiptmair	(	const Teuchos::RCP< const row_matrix_type > &	A,
		const Teuchos::RCP< const row_matrix_type > &	PtAP,
		const Teuchos::RCP< const row_matrix_type > &	P,
		const Teuchos::RCP< const row_matrix_type > &	Pt = `Teuchos::null`
	)

explicit

Constructor that takes 3 Tpetra matrices.

◆ ~Hiptmair()

template<class MatrixType >

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

virtual

Destructor.

Member Function Documentation

◆ setParameters()

template<class MatrixType >

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

virtual

Set the preconditioner's parameters.

This preconditioner accepts the following parameters:

"hiptmair: smoother type 1" (std::string)
"hiptmair: smoother type 2" (std::string)
"hiptmair: smoother list 1" (Teuchos::ParameterList)
"hiptmair: smoother list 2" (Teuchos::ParameterList)
"hiptmair: pre or post" (std::string)
"hiptmair: zero starting solution" (bool)

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

◆ setZeroStartingSolution()

template<class MatrixType >

void Ifpack2::Hiptmair< MatrixType >::setZeroStartingSolution ( bool zeroStartingSolution )

inlinevirtual

Set this preconditioner's parameters.

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

◆ initialize()

template<class MatrixType >

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

virtual

Do any initialization that depends on the input matrix's structure.

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

◆ isInitialized()

template<class MatrixType >

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

inlinevirtual

Return true if initialize() completed successfully, else false.

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

◆ compute()

template<class MatrixType >

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

virtual

Do any initialization that depends on the input matrix's values.

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

◆ isComputed()

template<class MatrixType >

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

inlinevirtual

Return true if compute() completed successfully, else false.

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

◆ apply()

template<class MatrixType >

void Ifpack2::Hiptmair< 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.

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

◆ updateCachedMultiVectors()

template<class MatrixType >

void Ifpack2::Hiptmair< MatrixType >::updateCachedMultiVectors	(	const Teuchos::RCP< const Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type > > &	map1,
		const Teuchos::RCP< const Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type > > &	map2,
		size_t	numVecs
	)		const

A service routine for updating the cached MultiVectors.

◆ getDomainMap()

template<class MatrixType >

Teuchos::RCP< const Tpetra::Map< typename MatrixType::local_ordinal_type, typename MatrixType::global_ordinal_type, typename MatrixType::node_type > > Ifpack2::Hiptmair< MatrixType >::getDomainMap ( ) const

virtual

Tpetra::Map representing the domain of this operator.

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

◆ getRangeMap()

template<class MatrixType >

Teuchos::RCP< const Tpetra::Map< typename MatrixType::local_ordinal_type, typename MatrixType::global_ordinal_type, typename MatrixType::node_type > > Ifpack2::Hiptmair< MatrixType >::getRangeMap ( ) const

virtual

Tpetra::Map representing the range of this operator.

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

◆ hasTransposeApply()

template<class MatrixType >

bool Ifpack2::Hiptmair< MatrixType >::hasTransposeApply ( ) const

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

◆ getComm()

template<class MatrixType >

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

Returns the operator's communicator.

◆ getMatrix()

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

◆ getNumInitialize()

template<class MatrixType >

int Ifpack2::Hiptmair< 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 >.

◆ getNumCompute()

template<class MatrixType >

int Ifpack2::Hiptmair< 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 >.

◆ getNumApply()

template<class MatrixType >

int Ifpack2::Hiptmair< 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 >.

◆ getInitializeTime()

template<class MatrixType >

double Ifpack2::Hiptmair< 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 >.

◆ getComputeTime()

template<class MatrixType >

double Ifpack2::Hiptmair< 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 >.

◆ getApplyTime()

template<class MatrixType >

double Ifpack2::Hiptmair< 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 >.

◆ getPrec1()

template<class MatrixType >

Teuchos::RCP< Ifpack2::Preconditioner< typename MatrixType::scalar_type, typename MatrixType::local_ordinal_type, typename MatrixType::global_ordinal_type, typename MatrixType::node_type > > Ifpack2::Hiptmair< MatrixType >::getPrec1 ( )

Returns prec 1.

◆ getPrec2()

template<class MatrixType >

Teuchos::RCP< Ifpack2::Preconditioner< typename MatrixType::scalar_type, typename MatrixType::local_ordinal_type, typename MatrixType::global_ordinal_type, typename MatrixType::node_type > > Ifpack2::Hiptmair< MatrixType >::getPrec2 ( )

Returns prec 2.

◆ description()

template<class MatrixType >

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

Return a simple one-line description of this object.

◆ describe()

template<class MatrixType >

void Ifpack2::Hiptmair< 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

Overridden from Teuchos::Describable

Detailed Description

Member Typedef Documentation

◆ scalar_type

◆ local_ordinal_type

◆ global_ordinal_type

◆ node_type

◆ magnitude_type

◆ row_matrix_type

◆ prec_type

Constructor & Destructor Documentation

◆ Hiptmair() [1/2]

◆ Hiptmair() [2/2]

◆ ~Hiptmair()

Member Function Documentation

◆ setParameters()

◆ setZeroStartingSolution()

◆ initialize()

◆ isInitialized()

◆ compute()

◆ isComputed()

◆ apply()

◆ updateCachedMultiVectors()

◆ getDomainMap()

◆ getRangeMap()

◆ hasTransposeApply()

◆ getComm()

◆ getMatrix()

◆ getNumInitialize()

◆ getNumCompute()

◆ getNumApply()

◆ getInitializeTime()

◆ getComputeTime()

◆ getApplyTime()

◆ getPrec1()

◆ getPrec2()

◆ description()

◆ describe()