Matrix and Vector classes that support a block recursive structure capable of representing the natural structure from Finite Element discretisations. More...

Modules
	Block Recursive Iterative Kernels

	IO for matrices and vectors.
	Provides methods for reading and writing matrices and vectors in various formats.

	Dense Matrix and Vector Template Library
	Type traits to retrieve the field and the real type of classes.

Files
file	matrixmatrix.hh
	provides functions for sparse matrix matrix multiplication.

file	matrixutils.hh
	Some handy generic functions for ISTL matrices.

Classes
struct	Dune::CompressionStatistics< size_type >
	Statistics about compression achieved in implicit mode. More...

class	Dune::ImplicitMatrixBuilder< M_ >
	A wrapper for uniform access to the BCRSMatrix during and after the build stage in implicit build mode. More...

class	Dune::BCRSMatrix< B, A >
	A sparse block matrix with compressed row storage. More...

class	Dune::BDMatrix< B, A >
	A block-diagonal matrix. More...

class	Dune::BTDMatrix< B, A >
	A block-tridiagonal matrix. More...

class	Dune::BlockVector< B, A >
	A vector of blocks with memory management. More...

class	Dune::Matrix< T, A >
	A generic dynamic dense matrix. More...

struct	Dune::MatMultMatResult< M1, M2 >
	Helper TMP to get the result type of a sparse matrix matrix multiplication ( \(C=A*B\)) More...

struct	Dune::TransposedMatMultMatResult< M1, M2 >
	Helper TMP to get the result type of a sparse matrix matrix multiplication ( \(C=A*B\)) More...

struct	Dune::CheckIfDiagonalPresent< Matrix, blocklevel, l >
	Check whether the a matrix has diagonal values on blocklevel recursion levels. More...

class	Dune::MultiTypeBlockMatrix< FirstRow, Args >
	A Matrix class to support different block types. More...

class	Dune::MultiTypeBlockMatrix_Solver_Col< I, crow, ccol, remain_col >
	part of solvers for MultiTypeBlockVector & MultiTypeBlockMatrix types More...

class	Dune::MultiTypeBlockMatrix_Solver< I, crow, remain_row >
	solver for MultiTypeBlockVector & MultiTypeBlockMatrix types More...

class	Dune::MultiTypeBlockVector< Args >
	A Vector class to support different block types. More...

class	Dune::VariableBlockVector< B, A >
	A Vector of blocks with different blocksizes. More...

Typedefs
typedef MultiTypeBlockMatrix< FirstRow, Args... >	Dune::MultiTypeBlockMatrix< FirstRow, Args >::type

typedef MultiTypeBlockVector< Args... >	Dune::MultiTypeBlockVector< Args >::type

typedef double	Dune::MultiTypeBlockVector< Args >::field_type
	The type used for scalars. More...

Functions
template<class T , class A , class A1 , class A2 , int n, int m, int k>
void	Dune::matMultTransposeMat (BCRSMatrix< FieldMatrix< T, n, k >, A > &res, const BCRSMatrix< FieldMatrix< T, n, m >, A1 > &mat, const BCRSMatrix< FieldMatrix< T, k, m >, A2 > &matt, bool tryHard=false)
	Calculate product of a sparse matrix with a transposed sparse matrices ( \(C=A*B^T\)). More...

template<class T , class A , class A1 , class A2 , int n, int m, int k>
void	Dune::matMultMat (BCRSMatrix< FieldMatrix< T, n, m >, A > &res, const BCRSMatrix< FieldMatrix< T, n, k >, A1 > &mat, const BCRSMatrix< FieldMatrix< T, k, m >, A2 > &matt, bool tryHard=false)
	Calculate product of two sparse matrices ( \(C=A*B\)). More...

template<class T , class A , class A1 , class A2 , int n, int m, int k>
void	Dune::transposeMatMultMat (BCRSMatrix< FieldMatrix< T, n, m >, A > &res, const BCRSMatrix< FieldMatrix< T, k, n >, A1 > &mat, const BCRSMatrix< FieldMatrix< T, k, m >, A2 > &matt, bool tryHard=false)
	Calculate product of a transposed sparse matrix with another sparse matrices ( \(C=A^T*B\)). More...

template<class M >
int	Dune::countNonZeros (const M &matrix)
	Get the number of nonzero fields in the matrix. More...

static constexpr std::size_t	Dune::MultiTypeBlockMatrix< FirstRow, Args >::N ()
	Return the number of matrix rows.

static constexpr std::size_t	Dune::MultiTypeBlockMatrix< FirstRow, Args >::size ()
	Return the number of matrix rows.

static constexpr std::size_t	Dune::MultiTypeBlockMatrix< FirstRow, Args >::M ()
	Return the number of matrix columns.

template<std::size_t index>
auto	Dune::MultiTypeBlockMatrix< FirstRow, Args >::operator[] (const std::integral_constant< std::size_t, index > indexVariable) -> decltype(std::get< index >(*this))
	Random-access operator. More...

template<std::size_t index>
auto	Dune::MultiTypeBlockMatrix< FirstRow, Args >::operator[] (const std::integral_constant< std::size_t, index > indexVariable) const -> decltype(std::get< index >(*this))
	Const random-access operator. More...

template<typename T >
void	Dune::MultiTypeBlockMatrix< FirstRow, Args >::operator= (const T &newval)

template<typename X , typename Y >
void	Dune::MultiTypeBlockMatrix< FirstRow, Args >::mv (const X &x, Y &y) const
	y = A x

template<typename X , typename Y >
void	Dune::MultiTypeBlockMatrix< FirstRow, Args >::umv (const X &x, Y &y) const
	y += A x

template<typename X , typename Y >
void	Dune::MultiTypeBlockMatrix< FirstRow, Args >::mmv (const X &x, Y &y) const
	y -= A x

template<typename AlphaType , typename X , typename Y >
void	Dune::MultiTypeBlockMatrix< FirstRow, Args >::usmv (const AlphaType &alpha, const X &x, Y &y) const
	y += alpha A x

template<typename T1 , typename... Args>
std::ostream &	Dune::operator<< (std::ostream &s, const MultiTypeBlockMatrix< T1, Args... > &m)
	<< operator for a MultiTypeBlockMatrix More...

template<typename Trhs , typename TVector , typename TMatrix , typename K >
static void	Dune::MultiTypeBlockMatrix_Solver_Col< I, crow, ccol, remain_col >::calc_rhs (const TMatrix &A, TVector &x, TVector &v, Trhs &b, const K &w)

template<typename TVector , typename TMatrix , typename K >
static void	Dune::MultiTypeBlockMatrix_Solver< I, crow, remain_row >::dbgs (const TMatrix &A, TVector &x, const TVector &b, const K &w)

template<typename TVector , typename TMatrix , typename K >
static void	Dune::MultiTypeBlockMatrix_Solver< I, crow, remain_row >::bsorf (const TMatrix &A, TVector &x, const TVector &b, const K &w)

template<typename TVector , typename TMatrix , typename K >
static void	Dune::MultiTypeBlockMatrix_Solver< I, crow, remain_row >::bsorb (const TMatrix &A, TVector &x, const TVector &b, const K &w)

template<typename TVector , typename TMatrix , typename K >
static void	Dune::MultiTypeBlockMatrix_Solver< I, crow, remain_row >::dbjac (const TMatrix &A, TVector &x, const TVector &b, const K &w)

static constexpr std::size_t	Dune::MultiTypeBlockVector< Args >::size ()
	Return the number of vector entries.

int	Dune::MultiTypeBlockVector< Args >::count ()

template<std::size_t index>
std::tuple_element< index, tupleType >::type &	Dune::MultiTypeBlockVector< Args >::operator[] (const std::integral_constant< std::size_t, index > indexVariable)
	Random-access operator. More...

template<std::size_t index>
const std::tuple_element< index, tupleType >::type &	Dune::MultiTypeBlockVector< Args >::operator[] (const std::integral_constant< std::size_t, index > indexVariable) const
	Const random-access operator. More...

template<typename T >
void	Dune::MultiTypeBlockVector< Args >::operator= (const T &newval)
	Assignment operator.

void	Dune::MultiTypeBlockVector< Args >::operator+= (const type &newv)

void	Dune::MultiTypeBlockVector< Args >::operator-= (const type &newv)

FieldTraits< field_type >::real_type	Dune::MultiTypeBlockVector< Args >::two_norm2 () const
	Compute the squared Euclidean norm.

FieldTraits< field_type >::real_type	Dune::MultiTypeBlockVector< Args >::two_norm () const
	Compute the Euclidean norm.

FieldTraits< field_type >::real_type	Dune::MultiTypeBlockVector< Args >::infinity_norm () const
	Compute the maximum norm.

template<typename Ta >
void	Dune::MultiTypeBlockVector< Args >::axpy (const Ta &a, const type &y)
	Axpy operation on this vector (this += a y) More...

template<typename... Args>
std::ostream &	Dune::operator<< (std::ostream &s, const MultiTypeBlockVector< Args... > &v)
	Send MultiTypeBlockVector to an outstream.

Detailed Description

Matrix and Vector classes that support a block recursive structure capable of representing the natural structure from Finite Element discretisations.

The interface of our matrices is designed according to what they represent from a mathematical point of view. The vector classes are representations of vector spaces:

FieldVector represents a vector space \(V=K^n\) where the field \(K\) is represented by a numeric type (e.g. double, float, complex). \(n\) is known at compile time.
BlockVector represents a vector space \(V=W\times W \times W \times\cdots\times W\) where W is itself a vector space.
VariableBlockVector represents a vector space having a two-level block structure of the form \(V=B^{n_1}\times B^{n_2}\times\ldots \times B^{n_m}\), i.e. it is constructed from \(m\) vector spaces, \(i=1,\ldots,m\).

The matrix classes represent linear maps \(A: V \mapsto W\) from vector space \(V\) to vector space \(W\) the recursive block structure of the matrix rows and columns immediately follows from the recursive block structure of the vectors representing the domain and range of the mapping, respectively:

FieldMatrix represents a linear map \(M: V_1 \to V_2\) where \(V_1=K^n\) and \(V_2=K^m\) are vector spaces over the same field represented by a numerix type.
BCRSMatrix represents a linear map \(M: V_1 \to V_2\) where \(V_1=W\times W \times W \times\cdots\times W\) and \(V_2=W\times W \times W \times\cdots\times W\) where W is itself a vector space.
VariableBCRSMatrix is not yet implemented.

Typedef Documentation

◆ field_type

template<typename... Args>

typedef double Dune::MultiTypeBlockVector< Args >::field_type

The type used for scalars.

The current code hardwires it to 'double', which is far from nice. On the other hand, it is not clear what the correct type is. If the MultiTypeBlockVector class is instantiated with several vectors of different field_types, what should the resulting field_type be?

◆ type [1/2]

template<typename FirstRow , typename... Args>

typedef MultiTypeBlockMatrix<FirstRow, Args...> Dune::MultiTypeBlockMatrix< FirstRow, Args >::type

own class' type

◆ type [2/2]

template<typename... Args>

typedef MultiTypeBlockVector<Args...> Dune::MultiTypeBlockVector< Args >::type

own class' type

Function Documentation

◆ axpy()

template<typename... Args>

template<typename Ta >

void Dune::MultiTypeBlockVector< Args >::axpy	(	const Ta &	a,
		const type &	y
	)

inline

Axpy operation on this vector (*this += a * y)

Template Parameters

Ta	Type of the scalar 'a'

References Dune::Hybrid::forEach(), and Dune::Hybrid::integralRange().

◆ bsorb()

template<int I, int crow, int remain_row>

template<typename TVector , typename TMatrix , typename K >

static void Dune::MultiTypeBlockMatrix_Solver< I, crow, remain_row >::bsorb	(	const TMatrix &	A,
		TVector &	x,
		const TVector &	b,
		const K &	w
	)

inlinestatic

bsorb for MultiTypeBlockMatrix & MultiTypeBlockVector types

◆ bsorf()

template<int I, int crow, int remain_row>

template<typename TVector , typename TMatrix , typename K >

static void Dune::MultiTypeBlockMatrix_Solver< I, crow, remain_row >::bsorf	(	const TMatrix &	A,
		TVector &	x,
		const TVector &	b,
		const K &	w
	)

inlinestatic

bsorf for MultiTypeBlockMatrix & MultiTypeBlockVector types

◆ calc_rhs()

template<int I, int crow, int ccol, int remain_col>

template<typename Trhs , typename TVector , typename TMatrix , typename K >

static void Dune::MultiTypeBlockMatrix_Solver_Col< I, crow, ccol, remain_col >::calc_rhs	(	const TMatrix &	A,
		TVector &	x,
		TVector &	v,
		Trhs &	b,
		const K &	w
	)

inlinestatic

iterating over one row in MultiTypeBlockMatrix to calculate right side b-A[i][j]*x[j]

◆ count()

template<typename... Args>

int Dune::MultiTypeBlockVector< Args >::count ( )

inline

number of elements

◆ countNonZeros()

template<class M >

int Dune::countNonZeros ( const M & matrix )

inline

Get the number of nonzero fields in the matrix.

This is not the number of nonzero blocks, but the number of non zero scalar entries (on blocklevel 1) if the matrix is viewed as a flat matrix.

For FieldMatrix this is simply the number of columns times the number of rows, for a BCRSMatrix<FieldMatrix<K,n,m>> this is the number of nonzero blocks time n*m.

Referenced by Dune::Amg::MatrixHierarchy< M, PI, A >::build().

◆ dbgs()

template<int I, int crow, int remain_row>

template<typename TVector , typename TMatrix , typename K >

static void Dune::MultiTypeBlockMatrix_Solver< I, crow, remain_row >::dbgs	(	const TMatrix &	A,
		TVector &	x,
		const TVector &	b,
		const K &	w
	)

inlinestatic

Gauss-Seidel solver for MultiTypeBlockMatrix & MultiTypeBlockVector types

◆ dbjac()

template<int I, int crow, int remain_row>

template<typename TVector , typename TMatrix , typename K >

static void Dune::MultiTypeBlockMatrix_Solver< I, crow, remain_row >::dbjac	(	const TMatrix &	A,
		TVector &	x,
		const TVector &	b,
		const K &	w
	)

inlinestatic

Jacobi solver for MultiTypeBlockMatrix & MultiTypeBlockVector types

◆ matMultMat()

template<class T , class A , class A1 , class A2 , int n, int m, int k>

void Dune::matMultMat	(	BCRSMatrix< FieldMatrix< T, n, m >, A > &	res,
		const BCRSMatrix< FieldMatrix< T, n, k >, A1 > &	mat,
		const BCRSMatrix< FieldMatrix< T, k, m >, A2 > &	matt,
		bool	tryHard = `false`
	)

Calculate product of two sparse matrices ( \(C=A*B\)).

Parameters

res	Matrix for the result of the computation.
mat	Matrix A.
matt	Matrix B.
tryHard	ignored

◆ matMultTransposeMat()

template<class T , class A , class A1 , class A2 , int n, int m, int k>

void Dune::matMultTransposeMat	(	BCRSMatrix< FieldMatrix< T, n, k >, A > &	res,
		const BCRSMatrix< FieldMatrix< T, n, m >, A1 > &	mat,
		const BCRSMatrix< FieldMatrix< T, k, m >, A2 > &	matt,
		bool	tryHard = `false`
	)

Calculate product of a sparse matrix with a transposed sparse matrices ( \(C=A*B^T\)).

Parameters

res	Matrix for the result of the computation.
mat	Matrix A.
matt	Matrix B, which will be transposed before the multiplication.
tryHard	ignored

◆ operator+=()

template<typename... Args>

void Dune::MultiTypeBlockVector< Args >::operator+= ( const type & newv )

inline

operator for MultiTypeBlockVector += MultiTypeBlockVector operations

References Dune::Hybrid::forEach(), and Dune::Hybrid::integralRange().

◆ operator-=()

template<typename... Args>

void Dune::MultiTypeBlockVector< Args >::operator-= ( const type & newv )

inline

operator for MultiTypeBlockVector -= MultiTypeBlockVector operations

References Dune::Hybrid::forEach(), and Dune::Hybrid::integralRange().

◆ operator<<()

template<typename T1 , typename... Args>

std::ostream & Dune::operator<<	(	std::ostream &	s,
		const MultiTypeBlockMatrix< T1, Args... > &	m
	)

<< operator for a MultiTypeBlockMatrix

operator<< for printing out a MultiTypeBlockMatrix

References Dune::Hybrid::forEach(), and Dune::Hybrid::integralRange().

◆ operator=()

template<typename FirstRow , typename... Args>

template<typename T >

void Dune::MultiTypeBlockMatrix< FirstRow, Args >::operator= ( const T & newval )

inline

assignment operator

References Dune::Hybrid::forEach(), Dune::Hybrid::integralRange(), and Dune::MultiTypeBlockMatrix< FirstRow, Args >::size().

◆ operator[]() [1/4]

template<typename... Args>

template<std::size_t index>

std::tuple_element< index, tupleType >::type & Dune::MultiTypeBlockVector< Args >::operator[] ( const std::integral_constant< std::size_t, index > indexVariable )

inline

Random-access operator.

This method mimicks the behavior of normal vector access with square brackets like, e.g., v[5] = 1. The problem is that the return type is different for each value of the argument in the brackets. Therefore we implement a trick using std::integral_constant. To access the first entry of a MultiTypeBlockVector named v write

MultiTypeBlockVector<A,B,C,D> v;
std::integral_constant<std::size_t,0> _0;
v[_0] = ...

The name '_0' used here as a static replacement of the integer number zero is arbitrary. Any other variable name can be used. If you don't like the separate variable, you can writee

MultiTypeBlockVector<A,B,C,D> v;

v[std::integral_constant<std::size_t,0>()] = ...

References DUNE_UNUSED_PARAMETER.

◆ operator[]() [2/4]

template<typename FirstRow , typename... Args>

template<std::size_t index>

auto Dune::MultiTypeBlockMatrix< FirstRow, Args >::operator[] ( const std::integral_constant< std::size_t, index > indexVariable ) -> decltype(std::get<index>(*this))

inline

Random-access operator.

This method mimicks the behavior of normal vector access with square brackets like, e.g., m[5] = .... The problem is that the return type is different for each value of the argument in the brackets. Therefore we implement a trick using std::integral_constant. To access the first row of a MultiTypeBlockMatrix named m write

std::integral_constant<std::size_t,0> _0;

m[_0] = ...

The name '_0' used here as a static replacement of the integer number zero is arbitrary. Any other variable name can be used. If you don't like the separate variable, you can write

m[std::integral_constant<std::size_t,0>()] = ...

References DUNE_UNUSED_PARAMETER.

◆ operator[]() [3/4]

template<typename... Args>

template<std::size_t index>

const std::tuple_element< index, tupleType >::type & Dune::MultiTypeBlockVector< Args >::operator[] ( const std::integral_constant< std::size_t, index > indexVariable ) const

inline

Const random-access operator.

This is the const version of the random-access operator. See the non-const version for a full explanation of how to use it.

References DUNE_UNUSED_PARAMETER.

◆ operator[]() [4/4]

template<typename FirstRow , typename... Args>

template<std::size_t index>

auto Dune::MultiTypeBlockMatrix< FirstRow, Args >::operator[] ( const std::integral_constant< std::size_t, index > indexVariable ) const -> decltype(std::get<index>(*this))

inline

Const random-access operator.

This is the const version of the random-access operator. See the non-const version for a full explanation of how to use it.

References DUNE_UNUSED_PARAMETER.

◆ transposeMatMultMat()

template<class T , class A , class A1 , class A2 , int n, int m, int k>

void Dune::transposeMatMultMat	(	BCRSMatrix< FieldMatrix< T, n, m >, A > &	res,
		const BCRSMatrix< FieldMatrix< T, k, n >, A1 > &	mat,
		const BCRSMatrix< FieldMatrix< T, k, m >, A2 > &	matt,
		bool	tryHard = `false`
	)

Calculate product of a transposed sparse matrix with another sparse matrices ( \(C=A^T*B\)).

Parameters

res	Matrix for the result of the computation.
mat	Matrix A, which will be transposed before the multiplication.
matt	Matrix B.
tryHard	ignored

Referenced by MatrixInfo< BCRSMatrix >::computeNonSymCond2().

DUNE Distributed and Unified Numerics Environment

Dune Core Modules (2.5.0)

Modules

Files

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ field_type

◆ type [1/2]

◆ type [2/2]

Function Documentation

◆ axpy()

◆ bsorb()

◆ bsorf()

◆ calc_rhs()

◆ count()

◆ countNonZeros()

◆ dbgs()

◆ dbjac()

◆ matMultMat()

◆ matMultTransposeMat()

◆ operator+=()

◆ operator-=()

◆ operator<<()

◆ operator=()

◆ operator[]() [1/4]

◆ operator[]() [2/4]

◆ operator[]() [3/4]

◆ operator[]() [4/4]

◆ transposeMatMultMat()