RangeType class for matrix valued functions - derived from FieldMatrix but has representation as vector. More...

#include <dune/fem/space/common/functionspace.hh>

Public Types
enum	{ rows = BaseType::rows , cols = BaseType::cols , dimension = BaseType::rows*BaseType::cols }

typedef Traits::derived_type	derived_type
	type of derived matrix class

typedef Traits::value_type	value_type
	export the type representing the field

typedef Traits::value_type	field_type
	export the type representing the field

typedef Traits::value_type	block_type
	export the type representing the components

typedef DenseIterator< DenseMatrix, row_type, row_reference >	Iterator
	Iterator class for sequential access.

typedef Iterator	iterator
	typedef for stl compliant access

typedef Iterator	RowIterator
	rename the iterators for easier access

typedef std::remove_reference< row_reference >::type::Iterator	ColIterator
	rename the iterators for easier access

typedef DenseIterator< const DenseMatrix, const row_type, const_row_reference >	ConstIterator
	Iterator class for sequential access.

typedef ConstIterator	const_iterator
	typedef for stl compliant access

typedef ConstIterator	ConstRowIterator
	rename the iterators for easier access

typedef std::remove_reference< const_row_reference >::type::ConstIterator	ConstColIterator
	rename the iterators for easier access

Public Member Functions
	RangeMatrix ()
	Default constructor.

	RangeMatrix (const K &k)
	Constructor initializing the whole matrix with a scalar.

K &	operator() (int r, int c)
	access element in row r and column c More...

const K	operator() (int r, int c) const
	access element in row r and column c More...

const RowType &	row (int r) const
	access to row r More...

RowType &	row (int r)
	access to row r More...

K &	operator[] (int i)
	access i element where row = i/col and column = icol More...

const K	operator[] (int i) const
	access i element where row = i/col and column = icol More...

K	operator* (const BaseType &y)
	scalar product More...

RangeMatrix &	axpy (const K &a, const BaseType &y)
	vector space axpy operation More...

constexpr size_type	rows () const
	number of rows

constexpr size_type	cols () const
	number of columns

FieldMatrix< K, COLS, ROWS >	transposed () const
	Return transposed of the matrix as FieldMatrix.

derived_type	operator- () const
	Matrix negation.

FieldMatrix< K, l, cols >	leftmultiplyany (const FieldMatrix< K, l, rows > &M) const
	Multiplies M from the left to this matrix, this matrix is not modified.

FieldMatrix &	rightmultiply (const FieldMatrix< K, r, c > &M)
	Multiplies M from the right to this matrix.

FieldMatrix< K, ROWS, COLS > &	rightmultiply (const DenseMatrix< M2 > &M)
	Multiplies M from the right to this matrix.

FieldMatrix< K, rows, l >	rightmultiplyany (const FieldMatrix< K, cols, l > &M) const
	Multiplies M from the right to this matrix, this matrix is not modified.

row_reference	operator[] (size_type i)
	random access

size_type	size () const
	size method (number of rows)

Iterator	begin ()
	begin iterator

ConstIterator	begin () const
	begin iterator

Iterator	end ()
	end iterator

ConstIterator	end () const
	end iterator

Iterator	beforeEnd ()

ConstIterator	beforeEnd () const

Iterator	beforeBegin ()

ConstIterator	beforeBegin () const

derived_type &	operator+= (const DenseMatrix< Other > &x)
	vector space addition

derived_type &	operator-= (const DenseMatrix< Other > &x)
	vector space subtraction

derived_type &	*operator=** (const field_type &k)
	vector space multiplication with scalar

derived_type &	operator/= (const field_type &k)
	vector space division by scalar

derived_type &	axpy (const field_type &a, const DenseMatrix< Other > &x)
	vector space axpy operation (*this += a x)

bool	operator== (const DenseMatrix< Other > &x) const
	Binary matrix comparison.

bool	operator!= (const DenseMatrix< Other > &x) const
	Binary matrix incomparison.

void	mv (const X &x, Y &y) const
	y = A x

void	mtv (const X &x, Y &y) const
	y = A^T x

void	umv (const X &x, Y &y) const
	y += A x

void	umtv (const X &x, Y &y) const
	y += A^T x

void	umhv (const X &x, Y &y) const
	y += A^H x

void	mmv (const X &x, Y &y) const
	y -= A x

void	mmtv (const X &x, Y &y) const
	y -= A^T x

void	mmhv (const X &x, Y &y) const
	y -= A^H x

void	usmv (const typename FieldTraits< Y >::field_type &alpha, const X &x, Y &y) const
	y += alpha A x

void	usmtv (const typename FieldTraits< Y >::field_type &alpha, const X &x, Y &y) const
	y += alpha A^T x

void	usmhv (const typename FieldTraits< Y >::field_type &alpha, const X &x, Y &y) const
	y += alpha A^H x

FieldTraits< value_type >::real_type	frobenius_norm () const
	frobenius norm: sqrt(sum over squared values of entries)

FieldTraits< value_type >::real_type	frobenius_norm2 () const
	square of frobenius norm, need for block recursion

FieldTraits< vt >::real_type	infinity_norm () const
	infinity norm (row sum norm, how to generalize for blocks?)

FieldTraits< vt >::real_type	infinity_norm () const
	infinity norm (row sum norm, how to generalize for blocks?)

FieldTraits< vt >::real_type	infinity_norm_real () const
	simplified infinity norm (uses Manhattan norm for complex values)

FieldTraits< vt >::real_type	infinity_norm_real () const
	simplified infinity norm (uses Manhattan norm for complex values)

void	solve (V1 &x, const V2 &b, bool doPivoting=true) const
	Solve system A x = b. More...

void	invert (bool doPivoting=true)
	Compute inverse. More...

field_type	determinant (bool doPivoting=true) const
	calculates the determinant of this matrix

FieldMatrix< K, ROWS, COLS > &	leftmultiply (const DenseMatrix< M2 > &M)
	Multiplies M from the left to this matrix.

constexpr size_type	N () const
	number of rows

constexpr size_type	M () const
	number of columns

bool	exists (size_type i, size_type j) const
	return true when (i,j) is in pattern

Static Public Attributes
static constexpr int	blocklevel
	The number of block levels we contain. This is the leaf, that is, 1.

Static Protected Member Functions
static void	luDecomposition (DenseMatrix< FieldMatrix< K, ROWS, COLS > > &A, Func func, Mask &nonsingularLanes, bool throwEarly, bool doPivoting)
	do an LU-Decomposition on matrix A More...

Detailed Description

template<typename K, int n, int m>
class Dune::Fem::RangeMatrix< K, n, m >

RangeType class for matrix valued functions - derived from FieldMatrix but has representation as vector.

Member Enumeration Documentation

◆ anonymous enum

template<typename K , int n, int m>

anonymous enum

Enumerator
rows	The number of rows.
cols	The number of columns.
dimension	The total dimension of the matrix space.

Member Function Documentation

◆ axpy()

template<typename K , int n, int m>

RangeMatrix & Dune::Fem::RangeMatrix< K, n, m >::axpy	(	const K &	a,
		const BaseType &	y
	)

inline

vector space axpy operation

Parameters

a	scalar factor
y	RangeMatrix to multiply with

Returns: reference to this is returned (i.e. *this)

References Dune::DenseMatrix< MAT >::axpy().

◆ beforeBegin() [1/2]

Iterator Dune::DenseMatrix< FieldMatrix< K, ROWS, COLS > >::beforeBegin ( )

inlineinherited

Returns: an iterator that is positioned before the first entry of the vector.

◆ beforeBegin() [2/2]

ConstIterator Dune::DenseMatrix< FieldMatrix< K, ROWS, COLS > >::beforeBegin ( ) const

inlineinherited

Returns: an iterator that is positioned before the first entry of the vector.

◆ beforeEnd() [1/2]

Iterator Dune::DenseMatrix< FieldMatrix< K, ROWS, COLS > >::beforeEnd ( )

inlineinherited

Returns: an iterator that is positioned before the end iterator of the vector, i.e. at the last entry.

◆ beforeEnd() [2/2]

ConstIterator Dune::DenseMatrix< FieldMatrix< K, ROWS, COLS > >::beforeEnd ( ) const

inlineinherited

Returns: an iterator that is positioned before the end iterator of the vector. i.e. at the last element

◆ invert()

void Dune::DenseMatrix< FieldMatrix< K, ROWS, COLS > >::invert ( bool doPivoting = true )

inherited

Compute inverse.

Exceptions

FMatrixError if the matrix is singular

◆ luDecomposition()

static void Dune::DenseMatrix< FieldMatrix< K, ROWS, COLS > >::luDecomposition	(	DenseMatrix< FieldMatrix< K, ROWS, COLS > > &	A,
		Func	func,
		Mask &	nonsingularLanes,
		bool	throwEarly,
		bool	doPivoting
	)

staticprotectedinherited

do an LU-Decomposition on matrix A

Parameters

A	The matrix to decompose, and to store the result in.
func	Functor used for swapping lanes and to conduct the elimination. Depending on the functor, `luDecomposition()` can be used for solving, for inverting, or to compute the determinant.
nonsingularLanes	SimdMask of lanes that are nonsingular.
throwEarly	Whether to throw an `FMatrixError` immediately as soon as one lane is discovered to be singular. If `false`, do not throw, instead continue until finished or all lanes are singular, and exit via return in both cases.
doPivoting	Enable pivoting.

There are two modes of operation:

Terminate as soon as one lane is discovered to be singular. Early termination is done by throwing an FMatrixError. On entry, Simd::allTrue(nonsingularLanes) and throwEarly==true should hold. After early termination, the contents of A should be considered bogus, and nonsingularLanes has the lane(s) that triggered the early termination unset. There may be more singular lanes than the one reported in nonsingularLanes, which just haven't been discovered yet; so the value of nonsingularLanes is mostly useful for diagnostics.
Terminate only when all lanes are discovered to be singular. Use this when you want to apply special postprocessing in singular lines (e.g. setting the determinant of singular lanes to 0 in determinant()). On entry, nonsingularLanes may have any value and throwEarly==false should hold. The function will not throw an exception if some lanes are discovered to be singular, instead it will continue running until all lanes are singular or until finished, and terminate only via normal return. On exit, nonsingularLanes contains the map of lanes that are valid in A.

◆ operator()() [1/2]

template<typename K , int n, int m>

K & Dune::Fem::RangeMatrix< K, n, m >::operator()	(	int	r,
		int	c
	)

inline

access element in row r and column c

Parameters

[in]	r	row
[in]	c	column

Returns: reference to element in row r and column c

◆ operator()() [2/2]

template<typename K , int n, int m>

const K Dune::Fem::RangeMatrix< K, n, m >::operator()	(	int	r,
		int	c
	)		const

inline

access element in row r and column c

Parameters

[in]	r	row
[in]	c	column

Returns: reference to element in row r and column c

◆ operator*()

template<typename K , int n, int m>

K Dune::Fem::RangeMatrix< K, n, m >::operator* ( const BaseType & y )

inline

scalar product

Parameters

y	RangeMatrix to scalar multiply with

Returns: K scalar product

◆ operator[]() [1/2]

template<typename K , int n, int m>

K & Dune::Fem::RangeMatrix< K, n, m >::operator[] ( int i )

inline

access i element where row = i/col and column = icol

Parameters

[in] i element number ot access

Returns: reference to element in row i/col and column icol

References Dune::Fem::RangeMatrix< K, n, m >::cols.

◆ operator[]() [2/2]

template<typename K , int n, int m>

const K Dune::Fem::RangeMatrix< K, n, m >::operator[] ( int i ) const

inline

access i element where row = i/col and column = icol

Parameters

[in] i element number ot access

Returns: reference to element in row i/col and column icol

References Dune::Fem::RangeMatrix< K, n, m >::cols.

◆ row() [1/2]

template<typename K , int n, int m>

RowType & Dune::Fem::RangeMatrix< K, n, m >::row ( int r )

inline

access to row r

Parameters

[in] r row

Returns: reference to row r

◆ row() [2/2]

template<typename K , int n, int m>

const RowType & Dune::Fem::RangeMatrix< K, n, m >::row ( int r ) const

inline

access to row r

Parameters

[in] r row

Returns: reference to row r

◆ solve()

void Dune::DenseMatrix< FieldMatrix< K, ROWS, COLS > >::solve	(	V1 &	x,
		const V2 &	b,
		bool	doPivoting = `true`
	)		const

inherited

Solve system A x = b.

Exceptions

FMatrixError if the matrix is singular

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

dune/fem/space/common/functionspace.hh

DUNE Distributed and Unified Numerics Environment

DUNE-FEM (unstable)

Public Types

Public Member Functions

Static Public Attributes

Static Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Member Function Documentation

◆ axpy()

◆ beforeBegin() [1/2]

◆ beforeBegin() [2/2]

◆ beforeEnd() [1/2]

◆ beforeEnd() [2/2]

◆ invert()

◆ luDecomposition()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator*()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ row() [1/2]

◆ row() [2/2]

◆ solve()