A static "factory" that provides a way to register and construct arbitrary Ifpack2::Container subclasses using string keys. More...

#include <Ifpack2_ContainerFactory_decl.hpp>

Typedefs
typedef MatrixType::scalar_type	scalar_type
	The type of the entries of the input MatrixType. More...

typedef MatrixType::local_ordinal_type	local_ordinal_type
	The local_ordinal_type from the input MatrixType. More...

typedef MatrixType::global_ordinal_type	global_ordinal_type
	The global_ordinal_type from the input MatrixType. More...

typedef MatrixType::node_type	node_type
	The node_type from the input MatrixType. More...

typedef Tpetra::RowMatrix< scalar_type, local_ordinal_type, global_ordinal_type, node_type >	row_matrix_type
	Tpetra::RowMatrix specialization (superclass of MatrixType) More...

typedef Tpetra::Import< local_ordinal_type, global_ordinal_type, node_type >	import_type
	Tpetra::Importer specialization for use with `MatrixType` and compatible MultiVectors. More...

typedef Ifpack2::Container< MatrixType >	BaseContainer

template<typename ContainerType >
static void	registerContainer (std::string containerType)
	Registers a specialization of Ifpack2::Container by binding a key (string) to it. More...

static Teuchos::RCP< BaseContainer >	build (std::string containerType, const Teuchos::RCP< const MatrixType > &A, const Teuchos::Array< Teuchos::Array< local_ordinal_type >> &localRows, const Teuchos::RCP< const import_type > importer, int OverlapLevel, scalar_type DampingFactor)
	Build a specialization of Ifpack2::Container given a key that has been registered. More...

static void	deregisterContainer (std::string containerType)
	Registers a specialization of Ifpack2::Container by binding a key (string) to it. More...

Detailed Description

template<typename MatrixType>
class Ifpack2::ContainerFactory< MatrixType >

A static "factory" that provides a way to register and construct arbitrary Ifpack2::Container subclasses using string keys.

Template Parameters

MatrixType A specialization of Tpetra::RowMatrix.

Member Typedef Documentation

◆ scalar_type

template<typename MatrixType >

typedef MatrixType::scalar_type Ifpack2::ContainerFactory< MatrixType >::scalar_type

The type of the entries of the input MatrixType.

◆ local_ordinal_type

template<typename MatrixType >

typedef MatrixType::local_ordinal_type Ifpack2::ContainerFactory< MatrixType >::local_ordinal_type

The local_ordinal_type from the input MatrixType.

◆ global_ordinal_type

template<typename MatrixType >

typedef MatrixType::global_ordinal_type Ifpack2::ContainerFactory< MatrixType >::global_ordinal_type

The global_ordinal_type from the input MatrixType.

◆ node_type

template<typename MatrixType >

typedef MatrixType::node_type Ifpack2::ContainerFactory< MatrixType >::node_type

The node_type from the input MatrixType.

◆ row_matrix_type

template<typename MatrixType >

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

Tpetra::RowMatrix specialization (superclass of MatrixType)

◆ import_type

template<typename MatrixType >

typedef Tpetra::Import<local_ordinal_type, global_ordinal_type, node_type> Ifpack2::ContainerFactory< MatrixType >::import_type

Tpetra::Importer specialization for use with MatrixType and compatible MultiVectors.

Member Function Documentation

◆ registerContainer()

template<typename MatrixType >

template<typename ContainerType >

void Ifpack2::ContainerFactory< MatrixType >::registerContainer ( std::string containerType )

static

Registers a specialization of Ifpack2::Container by binding a key (string) to it.

Template Parameters

ContainerType The Container specialization to register.

Parameters

containerType The key to pair with ContainerType. After registering, the key can be used to construct a ContainerType.

◆ build()

template<typename MatrixType >

Teuchos::RCP< typename ContainerFactory< MatrixType >::BaseContainer > Ifpack2::ContainerFactory< MatrixType >::build	(	std::string	containerType,
		const Teuchos::RCP< const MatrixType > &	A,
		const Teuchos::Array< Teuchos::Array< local_ordinal_type >> &	localRows,
		const Teuchos::RCP< const import_type >	importer,
		int	OverlapLevel,
		scalar_type	DampingFactor
	)

static

Build a specialization of Ifpack2::Container given a key that has been registered.

Parameters

containerType	The key for looking up the Container specialization. If this key hasn't been registered, an exception is thrown.
A	The problem matrix.
localRows	The rows that correspond to each block. The outer list contains blocks, and the inner list contains rows. In BlockRelaxation, this is retrieved from a Partitioner.
importer	The importer that is used to import off-process rows (used by overlapping BlockRelaxation).
OverlapLevel	In BlockRelaxation the overlap level is retrieved from the parameter list.
DampingFactor	In BlockRelaxation the damping factor is retrieved from the parameter list.

◆ deregisterContainer()

template<typename MatrixType >

void Ifpack2::ContainerFactory< MatrixType >::deregisterContainer ( std::string containerType )

static

Registers a specialization of Ifpack2::Container by binding a key (string) to it.

Parameters

containerType The key to deregister. If it wasn't registered before, the call has no effect.

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

Typedefs

Detailed Description

template<typename MatrixType> class Ifpack2::ContainerFactory< MatrixType >

Member Typedef Documentation

◆ scalar_type

◆ local_ordinal_type

◆ global_ordinal_type

◆ node_type

◆ row_matrix_type

◆ import_type

Member Function Documentation

◆ registerContainer()

◆ build()

◆ deregisterContainer()

template<typename MatrixType>
class Ifpack2::ContainerFactory< MatrixType >