Wrapper for sequential matrices to handle them in parallel. More...

#include <parallel_matrix.h>

Inheritance diagram for ug::ParallelMatrix< TMatrix >:

Public Types
enum	{ rows_sorted =TMatrix::rows_sorted }

typedef ParallelMatrix< TMatrix >	this_type
	own type

Public Member Functions
void	add_storage_type (uint type)
	adds a storage type

template<typename TPVector >
bool	apply (TPVector &res, const TPVector &x) const
	calculate res = A x

template<typename TPVector >
bool	apply_transposed (TPVector &res, const TPVector &x) const
	calculate res = A.T x

bool	change_storage_type (ParallelStorageType type)
	changes to the requested storage type if possible

uint	get_storage_mask () const
	returns storage type mask

ParallelStorageType	get_storage_type () const

bool	has_storage_type (uint type) const
	returns if the current storage type has a given representation

ConstSmartPtr< AlgebraLayouts >	layouts () const
	returns the algebra layouts

template<typename TPVector >
bool	matmul_minus (TPVector &res, const TPVector &x) const
	calculate res -= A x

this_type &	operator= (const this_type &M)
	assignment

	ParallelMatrix ()
	Default Constructor.

	ParallelMatrix (SmartPtr< AlgebraLayouts > layouts)
	Constructor setting the layouts.

void	remove_storage_type (uint type)
	removes a storage type

void	set_layouts (ConstSmartPtr< AlgebraLayouts > layouts)
	sets the algebra layouts

void	set_storage_type (uint type)
	sets the storage type

Private Member Functions
	ParallelMatrix (const ParallelMatrix &)

Private Attributes
ConstSmartPtr< AlgebraLayouts >	m_spAlgebraLayouts
	algebra layouts and communicators

uint	m_type
	type of storage (i.e. consistent, additiv, additiv unique)

Detailed Description

template<typename TMatrix>
class ug::ParallelMatrix< TMatrix >

Wrapper for sequential matrices to handle them in parallel.

A ParallelMatrix is a wrapper around a sequential vector to make it usable in parallel. It has all the function a sequential matrix supports, since it is derived from it. Furthermore the ParallelStorageType is remembered. Currently only additive storage type is implemented. In addition some functions of the sequential matrix are overwritten to adapted the functionality to parallel (e.g. set)

Please Note: The Implementation is not yet finished.

Template Parameters

TMatrix Sequential Matrix Type

Member Typedef Documentation

◆ this_type

template<typename TMatrix >

typedef ParallelMatrix<TMatrix> ug::ParallelMatrix< TMatrix >::this_type

own type

Member Enumeration Documentation

◆ anonymous enum

template<typename TMatrix >

anonymous enum

Enumerator
rows_sorted

Constructor & Destructor Documentation

◆ ParallelMatrix() [1/3]

template<typename TMatrix >

ug::ParallelMatrix< TMatrix >::ParallelMatrix ( const ParallelMatrix< TMatrix > & )

private

◆ ParallelMatrix() [2/3]

template<typename TMatrix >

ug::ParallelMatrix< TMatrix >::ParallelMatrix ( )

inline

Default Constructor.

References new().

◆ ParallelMatrix() [3/3]

template<typename TMatrix >

ug::ParallelMatrix< TMatrix >::ParallelMatrix ( SmartPtr< AlgebraLayouts > layouts )

inline

Constructor setting the layouts.

Member Function Documentation

◆ add_storage_type()

template<typename TMatrix >

void ug::ParallelMatrix< TMatrix >::add_storage_type ( uint type )

inline

adds a storage type

type may be any or-combination of constants enumerated in ug::ParallelStorageType.

References ug::ParallelMatrix< TMatrix >::m_type.

◆ apply()

template<typename TMatrix >

template<typename TPVector >

bool ug::ParallelMatrix< TMatrix >::apply	(	TPVector &	res,
		const TPVector &	x
	)		const

calculate res = A x

References PROFILE_FUNC_GROUP, ug::PST_ADDITIVE, ug::PST_CONSISTENT, and UG_THROW.

◆ apply_transposed()

template<typename TMatrix >

template<typename TPVector >

bool ug::ParallelMatrix< TMatrix >::apply_transposed	(	TPVector &	res,
		const TPVector &	x
	)		const

calculate res = A.T x

References PROFILE_FUNC_GROUP, ug::PST_ADDITIVE, ug::PST_CONSISTENT, and UG_THROW.

◆ change_storage_type()

template<typename TMatrix >

bool ug::ParallelMatrix< TMatrix >::change_storage_type ( ParallelStorageType type )

changes to the requested storage type if possible

References ug::PST_UNDEFINED, UG_LOG, and UG_THROW.

◆ get_storage_mask()

template<typename TMatrix >

uint ug::ParallelMatrix< TMatrix >::get_storage_mask ( ) const

inline

returns storage type mask

References ug::ParallelMatrix< TMatrix >::m_type.

Referenced by ug::ParallelMatrix< TMatrix >::operator=(), and ug::SerializeUniquePart().

◆ get_storage_type()

template<typename TMatrix >

ParallelStorageType ug::ParallelMatrix< TMatrix >::get_storage_type ( ) const

inline

References ug::ParallelMatrix< TMatrix >::m_type.

Referenced by ug::GetMultType().

◆ has_storage_type()

template<typename TMatrix >

bool ug::ParallelMatrix< TMatrix >::has_storage_type ( uint type ) const

inline

returns if the current storage type has a given representation

type may be any or-combination of constants enumerated in ug::ParallelStorageType.

References ug::ParallelMatrix< TMatrix >::m_type, and ug::PST_UNDEFINED.

Referenced by ug::GetMultType().

◆ layouts()

template<typename TMatrix >

ConstSmartPtr< AlgebraLayouts > ug::ParallelMatrix< TMatrix >::layouts ( ) const

inline

returns the algebra layouts

References ug::ParallelMatrix< TMatrix >::m_spAlgebraLayouts.

Referenced by ug::CheckDiagonalInvertible(), ug::MakeConsistent(), ug::ParallelMatrix< TMatrix >::operator=(), and ug::ParallelMatrix< TMatrix >::set_layouts().

◆ matmul_minus()

template<typename TMatrix >

template<typename TPVector >

bool ug::ParallelMatrix< TMatrix >::matmul_minus	(	TPVector &	res,
		const TPVector &	x
	)		const

calculate res -= A x

References PROFILE_FUNC_GROUP, ug::PST_ADDITIVE, ug::PST_CONSISTENT, and UG_THROW.

◆ operator=()

template<typename TMatrix >

ParallelMatrix< TMatrix >::this_type & ug::ParallelMatrix< TMatrix >::operator= ( const this_type & M )

assignment

References ug::ParallelMatrix< TMatrix >::get_storage_mask(), and ug::ParallelMatrix< TMatrix >::layouts().

◆ remove_storage_type()

template<typename TMatrix >

void ug::ParallelMatrix< TMatrix >::remove_storage_type ( uint type )

inline

removes a storage type

type may be any or-combination of constants enumerated in ug::ParallelStorageType.

References ug::ParallelMatrix< TMatrix >::m_type.

◆ set_layouts()

template<typename TMatrix >

void ug::ParallelMatrix< TMatrix >::set_layouts ( ConstSmartPtr< AlgebraLayouts > layouts )

inline

sets the algebra layouts

References ug::ParallelMatrix< TMatrix >::layouts(), and ug::ParallelMatrix< TMatrix >::m_spAlgebraLayouts.

Referenced by ug::MakeConsistent(), ug::IExternalSolver< TAlgebra >::mat_preprocess(), and ug::ILUTScalarPreconditioner< TAlgebra >::preprocess().

◆ set_storage_type()

template<typename TMatrix >

void ug::ParallelMatrix< TMatrix >::set_storage_type ( uint type )

inline

sets the storage type

type may be any or-combination of constants enumerated in ug::ParallelStorageType.

References ug::ParallelMatrix< TMatrix >::m_type.

Referenced by ug::DeserializeUniquePart(), ug::IExternalSolver< TAlgebra >::mat_preprocess(), and ug::ILUTScalarPreconditioner< TAlgebra >::preprocess().

Member Data Documentation

◆ m_spAlgebraLayouts

template<typename TMatrix >

ConstSmartPtr<AlgebraLayouts> ug::ParallelMatrix< TMatrix >::m_spAlgebraLayouts

private

algebra layouts and communicators

Referenced by ug::ParallelMatrix< TMatrix >::layouts(), and ug::ParallelMatrix< TMatrix >::set_layouts().

◆ m_type

template<typename TMatrix >

uint ug::ParallelMatrix< TMatrix >::m_type

private

type of storage (i.e. consistent, additiv, additiv unique)

Referenced by ug::ParallelMatrix< TMatrix >::add_storage_type(), ug::ParallelMatrix< TMatrix >::get_storage_mask(), ug::ParallelMatrix< TMatrix >::get_storage_type(), ug::ParallelMatrix< TMatrix >::has_storage_type(), ug::ParallelMatrix< TMatrix >::remove_storage_type(), and ug::ParallelMatrix< TMatrix >::set_storage_type().

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

ugbase/lib_algebra/parallelization/parallel_matrix.h
ugbase/lib_algebra/parallelization/parallel_matrix_impl.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ this_type

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ ParallelMatrix() [1/3]

◆ ParallelMatrix() [2/3]

◆ ParallelMatrix() [3/3]

Member Function Documentation

◆ add_storage_type()

◆ apply()

◆ apply_transposed()

◆ change_storage_type()

◆ get_storage_mask()

◆ get_storage_type()

◆ has_storage_type()

◆ layouts()

◆ matmul_minus()

◆ operator=()

◆ remove_storage_type()

◆ set_layouts()

◆ set_storage_type()

Member Data Documentation

◆ m_spAlgebraLayouts

◆ m_type