Wrapper for Hiptmair smoothers. More...

#include <Ifpack2_Hiptmair_decl.hpp>

Inheritance diagram for Ifpack2::Hiptmair< MatrixType >:

Public Member Functions

	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)
	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	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	applyHiptmairSmoother (const Tpetra::MultiVector< typename MatrixType::scalar_type, typename MatrixType::local_ordinal_type, typename MatrixType::global_ordinal_type, typename MatrixType::node_type > &X, Tpetra::MultiVector< typename MatrixType::scalar_type, typename MatrixType::local_ordinal_type, typename MatrixType::global_ordinal_type, typename MatrixType::node_type > &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.
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).
virtual magnitude_type TEUCHOS_DEPRECATED	getCondEst () const
	Return the computed condition number estimate, or -1 if not computed.
Mathematical functions.
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.
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().
virtual magnitude_type TEUCHOS_DEPRECATED	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)
	Compute the condition number estimate and return its value.
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.
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.
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::Hiptmair< MatrixType >

Wrapper for Hiptmair smoothers.

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

template<class MatrixType>

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

The type of the entries of the input MatrixType.

template<class MatrixType>

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

The type of local indices in the input MatrixType.

template<class MatrixType>

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

The type of global indices in the input MatrixType.

template<class MatrixType>

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

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

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.

Reimplemented from Ifpack2::Preconditioner< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_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.

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

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
	)		`[explicit]`

Constructor that takes 3 Tpetra matrices.

template<class MatrixType >

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

Destructor.

Member Function Documentation

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

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

template<class MatrixType>

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

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

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

template<class MatrixType>

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

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

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

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

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

template<class MatrixType >

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

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

template<class MatrixType>

virtual magnitude_type TEUCHOS_DEPRECATED Ifpack2::Hiptmair< MatrixType >::getCondEst ( ) const [inline, virtual]

Return the computed condition number estimate, or -1 if not computed.

Warning:: This method is DEPRECATED. See warning for computeCondEst().

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

template<class MatrixType >

Teuchos::RCP< const Teuchos::Comm< int > > Ifpack2::Hiptmair< 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::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 >.

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

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

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

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

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

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

template<class MatrixType>

Hiptmair< MatrixType >::magnitude_type Ifpack2::Hiptmair< 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]`

Compute the condition number estimate and return its value.

Warning:: This method is DEPRECATED. It was inherited from Ifpack, and Ifpack never clearly stated what this method computes. Furthermore, Ifpack's method just estimates the condition number of the matrix A, and ignores the preconditioner -- which is probably not what users thought it did. If there is sufficient interest, we might reintroduce this method with a different meaning and a better algorithm.

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

template<class MatrixType >

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

Return a simple one-line description of this object.

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.

Member Data Documentation

template<class MatrixType>

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

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

template<class MatrixType>

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

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

template<class MatrixType>

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

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

template<class MatrixType>

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

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

template<class MatrixType>

TEUCHOS_DEPRECATED typedef Teuchos::ScalarTraits<scalar_type>::magnitudeType Ifpack2::Hiptmair< 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:

Public Member Functions

Detailed Description

template<class MatrixType> class Ifpack2::Hiptmair< MatrixType >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class MatrixType>
class Ifpack2::Hiptmair< MatrixType >