Partial specialization for stub=false (the default). More...

#include <Ifpack2_Details_DenseSolver_decl.hpp>

Inheritance diagram for Ifpack2::Details::DenseSolver< MatrixType, false >:

[legend]

Public Types
Public typedefs
typedef MatrixType	matrix_type
	The first template parameter of this class.
typedef MatrixType::scalar_type	scalar_type
	The type of entries in the input (global) matrix.
typedef MatrixType::local_ordinal_type	local_ordinal_type
	The type of local indices in the input (global) matrix.
typedef MatrixType::global_ordinal_type	global_ordinal_type
	The type of global indices in the input (global) matrix.
typedef MatrixType::node_type	node_type
	The Node type of the input (global) matrix.
typedef Teuchos::ScalarTraits< scalar_type >::magnitudeType	magnitude_type
	The type of the absolute value (magnitude) of a `scalar_type`.
typedef Tpetra::RowMatrix< scalar_type, local_ordinal_type, global_ordinal_type, node_type >	row_matrix_type
	Specialization of Tpetra::RowMatrix used by this class.
typedef Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type >	map_type
	Specialization of Tpetra::Map 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
Constructor and destructor
	DenseSolver (const Teuchos::RCP< const row_matrix_type > &matrix)
	Constructor.
virtual	~DenseSolver ()
	Destructor (declared virtual for memory safety of derived classes).
Teuchos::RCP< const map_type >	getDomainMap () const
	Implementation of Tpetra::Operator.
Teuchos::RCP< const map_type >	getRangeMap () const
	The range Map of this 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	setParameters (const Teuchos::ParameterList &params)
	Set the solvers's parameters.
void	initialize ()
	Set up the graph structure of this preconditioner.
bool	isInitialized () const
	True if the preconditioner has been successfully initialized, else false.
void	compute ()
	Set up the numerical values in this preconditioner.
bool	isComputed () const
	True if the preconditioner has been successfully computed, else false.
Teuchos::RCP< const row_matrix_type >	getMatrix () const
	The input matrix given to the constructor.
void	setMatrix (const Teuchos::RCP< const row_matrix_type > &A)
	Change the matrix to precondition.
int	getNumInitialize () const
	The number of calls to initialize().
int	getNumCompute () const
	The number of calls to compute().
int	getNumApply () const
	The number of calls to apply().
double	getInitializeTime () const
	The total time (in seconds) spent in initialize().
double	getComputeTime () const
	The total time (in seconds) spent in compute().
double	getApplyTime () const
	The total time (in seconds) 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	apply (const Tpetra::MultiVector< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type > &X, Tpetra::MultiVector< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, MatrixType::scalar_type alpha=Teuchos::ScalarTraits< MatrixType::scalar_type >::one(), MatrixType::scalar_type beta=Teuchos::ScalarTraits< MatrixType::scalar_type >::zero()) const=0
	Apply the preconditioner to X, putting the result in Y.
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
	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 the given FancyOStream.

Detailed Description

template<class MatrixType>
class Ifpack2::Details::DenseSolver< MatrixType, false >

Partial specialization for stub=false (the default).

Member Typedef Documentation

◆ matrix_type

template<class MatrixType>

typedef MatrixType Ifpack2::Details::DenseSolver< MatrixType, false >::matrix_type

The first template parameter of this class.

This must be a Tpetra::RowMatrix specialization.

◆ scalar_type

template<class MatrixType>

typedef MatrixType::scalar_type Ifpack2::Details::DenseSolver< MatrixType, false >::scalar_type

The type of entries in the input (global) matrix.

◆ local_ordinal_type

template<class MatrixType>

typedef MatrixType::local_ordinal_type Ifpack2::Details::DenseSolver< MatrixType, false >::local_ordinal_type

The type of local indices in the input (global) matrix.

◆ global_ordinal_type

template<class MatrixType>

typedef MatrixType::global_ordinal_type Ifpack2::Details::DenseSolver< MatrixType, false >::global_ordinal_type

The type of global indices in the input (global) matrix.

◆ node_type

template<class MatrixType>

typedef MatrixType::node_type Ifpack2::Details::DenseSolver< MatrixType, false >::node_type

The Node type of the input (global) matrix.

◆ magnitude_type

template<class MatrixType>

typedef Teuchos::ScalarTraits<scalar_type>::magnitudeType Ifpack2::Details::DenseSolver< MatrixType, false >::magnitude_type

The type of the absolute value (magnitude) of a scalar_type.

◆ row_matrix_type

template<class MatrixType>

typedef Tpetra::RowMatrix<scalar_type, local_ordinal_type, global_ordinal_type, node_type> Ifpack2::Details::DenseSolver< MatrixType, false >::row_matrix_type

Specialization of Tpetra::RowMatrix used by this class.

◆ map_type

template<class MatrixType>

typedef Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> Ifpack2::Details::DenseSolver< MatrixType, false >::map_type

Specialization of Tpetra::Map used by this class.

Constructor & Destructor Documentation

◆ DenseSolver()

template<class MatrixType>

Ifpack2::Details::DenseSolver< MatrixType, false >::DenseSolver ( const Teuchos::RCP< const row_matrix_type > & matrix )

Constructor.

Parameters

matrix [in] The original input matrix.

◆ ~DenseSolver()

template<class MatrixType>

Ifpack2::Details::DenseSolver< MatrixType, false >::~DenseSolver ( )

virtual

Destructor (declared virtual for memory safety of derived classes).

Member Function Documentation

◆ getDomainMap()

template<class MatrixType>

Teuchos::RCP< const typename DenseSolver< MatrixType, false >::map_type > Ifpack2::Details::DenseSolver< MatrixType, false >::getDomainMap ( ) const

virtual

Implementation of Tpetra::Operator.

The domain Map of this operator.

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

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 DenseSolver< MatrixType, false >::map_type > Ifpack2::Details::DenseSolver< MatrixType, false >::getRangeMap ( ) const

virtual

The range Map of this operator.

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

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

◆ apply()

template<class MatrixType>

void Ifpack2::Details::DenseSolver< MatrixType, false >::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.

If the result of applying this preconditioner to a vector X is \(M^{-1} \cdot X\), then this method computes \(\beta Y + \alpha M^{-1} \cdot X\). The typical case is \(\beta = 0\) and \(\alpha = 1\).

◆ setParameters()

template<class MatrixType>

void Ifpack2::Details::DenseSolver< MatrixType, false >::setParameters ( const Teuchos::ParameterList & params )

virtual

Set the solvers's parameters.

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

◆ initialize()

template<class MatrixType>

void Ifpack2::Details::DenseSolver< MatrixType, false >::initialize ( )

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.

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

◆ isInitialized()

template<class MatrixType>

bool Ifpack2::Details::DenseSolver< MatrixType, false >::isInitialized ( ) const

virtual

True if the preconditioner has been successfully initialized, 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::Details::DenseSolver< MatrixType, false >::compute ( )

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.

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

◆ isComputed()

template<class MatrixType>

bool Ifpack2::Details::DenseSolver< MatrixType, false >::isComputed ( ) const

virtual

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

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

◆ getMatrix()

template<class MatrixType>

Teuchos::RCP< const typename DenseSolver< MatrixType, false >::row_matrix_type > Ifpack2::Details::DenseSolver< MatrixType, false >::getMatrix ( ) const

virtual

The input matrix given to the constructor.

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

◆ setMatrix()

template<class MatrixType>

void Ifpack2::Details::DenseSolver< MatrixType, false >::setMatrix ( const Teuchos::RCP< const row_matrix_type > & A )

Change the matrix to precondition.

◆ getNumInitialize()

template<class MatrixType>

int Ifpack2::Details::DenseSolver< MatrixType, false >::getNumInitialize ( ) const

virtual

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::Details::DenseSolver< MatrixType, false >::getNumCompute ( ) const

virtual

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::Details::DenseSolver< MatrixType, false >::getNumApply ( ) const

virtual

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::Details::DenseSolver< MatrixType, false >::getInitializeTime ( ) const

virtual

The total time (in seconds) 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::Details::DenseSolver< MatrixType, false >::getComputeTime ( ) const

virtual

The total time (in seconds) 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::Details::DenseSolver< MatrixType, false >::getApplyTime ( ) const

virtual

The total time (in seconds) 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::Details::DenseSolver< MatrixType, false >::description ( ) const

A one-line description of this object.

◆ describe()

template<class MatrixType>

void Ifpack2::Details::DenseSolver< MatrixType, false >::describe	(	Teuchos::FancyOStream &	out,
		const Teuchos::EVerbosityLevel	verbLevel = Teuchos::Describable::verbLevel_default ) const

Print the object with some verbosity level to the given FancyOStream.

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

◆ matrix_type

◆ scalar_type

◆ local_ordinal_type

◆ global_ordinal_type

◆ node_type

◆ magnitude_type

◆ row_matrix_type

◆ map_type

Constructor & Destructor Documentation

◆ DenseSolver()

◆ ~DenseSolver()

Member Function Documentation

◆ getDomainMap()

◆ getRangeMap()

◆ apply()

◆ setParameters()

◆ initialize()

◆ isInitialized()

◆ compute()

◆ isComputed()

◆ getMatrix()

◆ setMatrix()

◆ getNumInitialize()

◆ getNumCompute()

◆ getNumApply()

◆ getInitializeTime()

◆ getComputeTime()

◆ getApplyTime()

◆ description()

◆ describe()