Abstract class for an operator. More...

#include <compositions.hh>

Inheritance diagram for concepts::Matrix< F >:

Public Types
typedef Cmplxtype< F >::type	c_type
	Complex type of data type. More...

typedef _Matrix_iterator< F, const F &, const F * >	const_iterator

typedef std::conditional< std::is_same< typename Realtype< F >::type, F >::value, typename Realtype< F >::type, typename Cmplxtype< F >::type >::type	d_type
	Data type, depending if F is real or complex. More...

typedef _Matrix_iterator< F, F &, F * >	iterator

typedef Realtype< F >::type	r_type
	Real type of data type. More...

typedef F	value_type

Public Member Functions
virtual void	add (const uint i, const uint j, const F value, const bool use_threshold=false, const Real threshold_value=1e-8)
	Addition operator Add the value to the entry (i,j) if not zero (for `use_threshold` = false), or if the absolute avlue is bigger than the `threshold_value` (for `use_threshold` = true) More...

iterator	begin (uint r=0)
	Iterator over the elements, standing at position (r,0). More...

const_iterator	begin (uint r=0) const
	Constant iterator over the elements, standing at position (r,0) More...

iterator	end ()
	Iterator, standing behind last element. More...

const_iterator	end () const
	Constant iterator, standing behind last element. More...

	Matrix (uint nofRows, uint nofCols)

const uint	nofCols () const
	Number of columns. More...

const uint	nofRows () const
	Number of rows. More...

virtual void	operator() (const Function< c_type > &fncY, Function< c_type > &fncX)=0

virtual void	operator() (const Function< r_type > &fncY, Function< F > &fncX)=0
	Computes `fncX` = A(`fncY`) where A is this matrix. More...

virtual F	operator() (const uint i, const uint j) const =0
	Returns entry with indices `i` and `j`. More...

virtual F &	operator() (const uint i, const uint j)=0
	Returns and allows access to entry with indices `i` and `j`. More...

virtual bool	operator== (const Matrix< F > &otherMat) const

virtual void	set (const uint i, const uint j, const F value, const bool use_threshold=false, const Real threshold_value=1e-8)
	Affectation operator Affet the value to the entry (i,j) if not zero (for `use_threshold` = false), or if the absolute value is bigger than the `threshold_value` (for `use_threshold` = true) More...

virtual void	transpMult (const Vector< c_type > &fncY, Vector< c_type > &fncX)=0

virtual void	transpMult (const Vector< r_type > &fncY, Vector< F > &fncX)=0
	Computes `fncX` = A^T `fncY` where A is this matrix. More...

Static Public Member Functions
template<class G >
static void	assembly (Matrix< F > &dest, const BilinearForm< F, G > &bf, const ElementPairList< G > &pairs)
	Assembly operator for `dest` using the bilinear form `bf`. More...

template<class G >
static void	assembly (Matrix< F > &dest, const Sequence< ElementWithCell< G > * > seq, const BilinearForm< F, G > &bf, const Real threshold=0.0)
	Assembly operator for `dest` using the bilinear form `bf`. More...

template<class G >
static void	assembly (Matrix< F > &dest, const Sequence< ElementWithCell< G > * > seqX, const Space< G > &spcY, const BilinearForm< F, G > &bf, const Real threshold=0.0)
	Assembly operator for `dest` using the bilinear form `bf`. More...

template<class G >
static void	assembly (Matrix< F > &dest, const Space< G > &spc, const BilinearForm< F, G > &bf, const Real threshold=0.0)
	Assembly operator for `dest` using the bilinear form `bf`. More...

template<class G >
static void	assembly (Matrix< F > &dest, const Space< G > &spc, const Sequence< bool > &seq, const BilinearForm< F, G > &bf, const Real threshold=0.0)
	Assembly operator for `dest` using the bilinear form `bf` on space `spc`. More...

template<class G >
static void	assembly (Matrix< F > &dest, const Space< G > &spcX, const Space< G > &spcY, const BilinearForm< F, G > &bf, const Real threshold=0.0, const bool single=false)
	Assembly operator for `dest` using the bilinear form `bf`. More...

template<class G >
static void	assembly (Matrix< F > &dest, const Space< G > &spcX, const Space< G > &spcY, const Sequence< bool > &seq, const BilinearForm< F, G > &bf, const Real threshold=0.0, const bool single=false)
	Assembly operator for `dest` using the bilinear form `bf`. More...

template<class G >
static void	assembly (Matrix< F > &dest, Scan< Element< G > > *sc, const BilinearForm< F, G > &bf, const Real threshold=0.0)
	Assembly operator for `dest` using the bilinear form `bf`. More...

Timing Interface
These functions are used to get timings from class internal computations. The values are stored in a user defined concepts::InOutParameters structure in different arrays (see `setTimings`). These arrays can be grouped into a table for easier postprocessing with concepts::ResultsTable table; table.addMap(concepts::ResultsTable::DOUBLE, "jacobian", output); table.addMap(concepts::ResultsTable::DOUBLE, "whole_sumfact", output); std::ofstream ofs("table.gnuplot"); ofs << std::setprecision(20); table.print<concepts::ResultsTable::GNUPLOT>(ofs);
static InOutParameters *	timings_
	Place to store timing values. More...

static uint	timeCntr_
	Counter for timing table. More...

static void	setTimings (InOutParameters *timings)
	Sets the class to store the timing values in. More...

static bool	timings ()
	Returns true if the class is able to do timings. More...

Detailed Description

template<class F>
class concepts::Matrix< F >

Abstract class for an operator.

This class is equiped with an interface to get timings of internal computations if compiled accordingly (see bilinearForm.cc file), see setTimings() and timings().

Author: Philipp Frauenfelder, 2002

Definition at line 31 of file compositions.hh.

Member Typedef Documentation

◆ c_type

template<class F >

typedef Cmplxtype<F>::type concepts::Matrix< F >::c_type

Complex type of data type.

Definition at line 45 of file matrix.hh.

◆ const_iterator

template<class F >

typedef _Matrix_iterator<F, const F&, const F*> concepts::Matrix< F >::const_iterator

Definition at line 51 of file matrix.hh.

◆ d_type

template<class F >

typedef std::conditional<std::is_same<typename Realtype<F>::type, F>::value , typename Realtype<F>::type, typename Cmplxtype<F>::type >::type concepts::Matrix< F >::d_type

Data type, depending if F is real or complex.

Definition at line 48 of file matrix.hh.

◆ iterator

template<class F >

typedef _Matrix_iterator<F, F&, F*> concepts::Matrix< F >::iterator

Definition at line 50 of file matrix.hh.

◆ r_type

template<class F >

typedef Realtype<F>::type concepts::Matrix< F >::r_type

Real type of data type.

Definition at line 43 of file matrix.hh.

◆ value_type

template<class F >

typedef F concepts::Matrix< F >::value_type

Definition at line 41 of file matrix.hh.

Constructor & Destructor Documentation

◆ Matrix()

template<class F >

concepts::Matrix< F >::Matrix	(	uint	nofRows,
		uint	nofCols
	)

inline

Definition at line 53 of file matrix.hh.

Member Function Documentation

◆ add()

template<class F >

virtual void concepts::Matrix< F >::add	(	const uint	i,
		const uint	j,
		const F	value,
		const bool	use_threshold = `false`,
		const Real	threshold_value = `1e-8`
	)

virtual

Addition operator Add the value to the entry (i,j) if not zero (for use_threshold = false), or if the absolute avlue is bigger than the threshold_value (for use_threshold = true)

◆ assembly() [1/8]

template<class F >

template<class G >

static void concepts::Matrix< F >::assembly	(	Matrix< F > &	dest,
		const BilinearForm< F, G > &	bf,
		const ElementPairList< G > &	pairs
	)

static

Assembly operator for dest using the bilinear form bf.

This assembly operator uses the element pairs taken from pairs. For every two elements found in a ElementPair in pairs, the bilinear form is evaluated and the result assembled into dest.

◆ assembly() [2/8]

template<class F >

template<class G >

static void concepts::Matrix< F >::assembly	(	Matrix< F > &	dest,
		const Sequence< ElementWithCell< G > * >	seq,
		const BilinearForm< F, G > &	bf,
		const Real	threshold = `0.0`
	)

static

Assembly operator for dest using the bilinear form bf.

This assembly operator does not compute element matrices for two different elements. The elements are taken from the element sequence seq.

◆ assembly() [3/8]

template<class F >

template<class G >

static void concepts::Matrix< F >::assembly	(	Matrix< F > &	dest,
		const Sequence< ElementWithCell< G > * >	seqX,
		const Space< G > &	spcY,
		const BilinearForm< F, G > &	bf,
		const Real	threshold = `0.0`
	)

static

Assembly operator for dest using the bilinear form bf.

This assembly operator computes also the element matrices for two different elements. The elements are taken from the element sequence seqX for the test space, and the trial space spcY is fully taken into account.

◆ assembly() [4/8]

template<class F >

template<class G >

static void concepts::Matrix< F >::assembly	(	Matrix< F > &	dest,
		const Space< G > &	spc,
		const BilinearForm< F, G > &	bf,
		const Real	threshold = `0.0`
	)

static

Assembly operator for dest using the bilinear form bf.

This assembly operator does not compute element matrices for two different elements. The elements are taken from the space spc.

Examples: linearDG1d.cc.

◆ assembly() [5/8]

template<class F >

template<class G >

static void concepts::Matrix< F >::assembly	(	Matrix< F > &	dest,
		const Space< G > &	spc,
		const Sequence< bool > &	seq,
		const BilinearForm< F, G > &	bf,
		const Real	threshold = `0.0`
	)

static

Assembly operator for dest using the bilinear form bf on space spc.

This assembly operator does not compute element matrices for two different elements. The elements are computing on the cells that are flagged by seq.

◆ assembly() [6/8]

template<class F >

template<class G >

static void concepts::Matrix< F >::assembly	(	Matrix< F > &	dest,
		const Space< G > &	spcX,
		const Space< G > &	spcY,
		const BilinearForm< F, G > &	bf,
		const Real	threshold = `0.0`,
		const bool	single = `false`
	)

static

Assembly operator for dest using the bilinear form bf.

This assembly operator computes also the element matrices for two different elements (coming from test space spcX and trial space spcY).

◆ assembly() [7/8]

template<class F >

template<class G >

static void concepts::Matrix< F >::assembly	(	Matrix< F > &	dest,
		const Space< G > &	spcX,
		const Space< G > &	spcY,
		const Sequence< bool > &	seq,
		const BilinearForm< F, G > &	bf,
		const Real	threshold = `0.0`,
		const bool	single = `false`
	)

static

Assembly operator for dest using the bilinear form bf.

This assembly operator computes also the element matrices for two different elements (coming from test space spcX and trial space spcY). The elements are computing on the cells that are flagged by seq.

◆ assembly() [8/8]

template<class F >

template<class G >

static void concepts::Matrix< F >::assembly	(	Matrix< F > &	dest,
		Scan< Element< G > > *	sc,
		const BilinearForm< F, G > &	bf,
		const Real	threshold = `0.0`
	)

static

Assembly operator for dest using the bilinear form bf.

This assembly operator does not compute element matrices for two different elements. The elements are taken from the space scanner sc.

◆ begin() [1/2]

template<class F >

iterator concepts::Matrix< F >::begin ( uint r = 0 )

inline

Iterator over the elements, standing at position (r,0).

Might be implemented differently for derived classes.

Definition at line 64 of file matrix.hh.

◆ begin() [2/2]

template<class F >

const_iterator concepts::Matrix< F >::begin ( uint r = 0 ) const

inline

Constant iterator over the elements, standing at position (r,0)

Might be implemented differently for derived classes.

Definition at line 71 of file matrix.hh.

◆ end() [1/2]

template<class F >

iterator concepts::Matrix< F >::end ( )

inline

Iterator, standing behind last element.

Definition at line 66 of file matrix.hh.

◆ end() [2/2]

template<class F >

const_iterator concepts::Matrix< F >::end ( ) const

inline

Constant iterator, standing behind last element.

Definition at line 73 of file matrix.hh.

◆ nofCols()

template<class F >

const uint concepts::Matrix< F >::nofCols ( ) const

inline

Number of columns.

Definition at line 58 of file matrix.hh.

◆ nofRows()

template<class F >

const uint concepts::Matrix< F >::nofRows ( ) const

inline

Number of rows.

Definition at line 56 of file matrix.hh.

◆ operator()() [1/4]

template<class F >

virtual void concepts::Matrix< F >::operator()	(	const Function< c_type > &	fncY,
		Function< c_type > &	fncX
	)

pure virtual

Implemented in concepts::Transpose< F >, concepts::Permutation< F >, concepts::Permutation< Real >, and concepts::DiagonalMatrix< F >.

◆ operator()() [2/4]

template<class F >

virtual void concepts::Matrix< F >::operator()	(	const Function< r_type > &	fncY,
		Function< F > &	fncX
	)

pure virtual

Computes fncX = A(fncY) where A is this matrix.

Implemented in concepts::Permutation< Real >, concepts::Transpose< F >, concepts::Permutation< F >, and concepts::DiagonalMatrix< F >.

◆ operator()() [3/4]

template<class F >

virtual F concepts::Matrix< F >::operator()	(	const uint	i,
		const uint	j
	)		const

pure virtual

Returns entry with indices i and j.

Implemented in concepts::Transpose< F >, concepts::PETScMat, concepts::Permutation< F >, concepts::Permutation< Real >, and concepts::DiagonalMatrix< F >.

◆ operator()() [4/4]

template<class F >

virtual F& concepts::Matrix< F >::operator()	(	const uint	i,
		const uint	j
	)

pure virtual

Returns and allows access to entry with indices i and j.

Implemented in concepts::Transpose< F >, concepts::PETScMat, concepts::Permutation< F >, concepts::Permutation< Real >, and concepts::DiagonalMatrix< F >.

◆ operator==()

template<class F >

virtual bool concepts::Matrix< F >::operator== ( const Matrix< F > & otherMat ) const

inlinevirtual

Definition at line 179 of file matrix.hh.

◆ set()

template<class F >

virtual void concepts::Matrix< F >::set	(	const uint	i,
		const uint	j,
		const F	value,
		const bool	use_threshold = `false`,
		const Real	threshold_value = `1e-8`
	)

virtual

Affectation operator Affet the value to the entry (i,j) if not zero (for use_threshold = false), or if the absolute value is bigger than the threshold_value (for use_threshold = true)

◆ setTimings()

template<class F >

static void concepts::Matrix< F >::setTimings ( InOutParameters * timings )

static

Sets the class to store the timing values in.

Additionally, the timeCntr_ is reset to 0. This counter is used to fill in the values into the arrays listed below in subsequent calls. The following timings are taken and stored in timings:

evaluation of bilinear form in bilinear_form
application of T matrix in tmatrix_apply
assembling into global matrix in global_assembly

◆ timings()

template<class F >

static bool concepts::Matrix< F >::timings ( )

static

Returns true if the class is able to do timings.

The ability to do timings depends on a compiler switch in matrix.cc file.

◆ transpMult() [1/2]

template<class F >

virtual void concepts::Matrix< F >::transpMult	(	const Vector< c_type > &	fncY,
		Vector< c_type > &	fncX
	)

pure virtual

Implemented in concepts::Transpose< F >, concepts::Permutation< F >, concepts::Permutation< Real >, and concepts::DiagonalMatrix< F >.

◆ transpMult() [2/2]

template<class F >

virtual void concepts::Matrix< F >::transpMult	(	const Vector< r_type > &	fncY,
		Vector< F > &	fncX
	)

pure virtual

Computes fncX = A^T fncY where A is this matrix.

Implemented in concepts::Permutation< Real >, concepts::Transpose< F >, concepts::Permutation< F >, and concepts::DiagonalMatrix< F >.

Member Data Documentation

◆ timeCntr_

template<class F >

uint concepts::Matrix< F >::timeCntr_

staticprivate

Counter for timing table.

Definition at line 236 of file matrix.hh.

◆ timings_

template<class F >

InOutParameters* concepts::Matrix< F >::timings_

staticprivate

Place to store timing values.

Definition at line 234 of file matrix.hh.

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

operator/compositions.hh
operator/matrix.hh

concepts::Matrix< F > Class Template ReferenceabstractBilinear and Linear Forms &ndash; Matrices and Vectors

Public Types

Public Member Functions

Static Public Member Functions

Timing Interface

Detailed Description

template<class F> class concepts::Matrix< F >

Member Typedef Documentation

◆ c_type

◆ const_iterator

◆ d_type

◆ iterator

◆ r_type

◆ value_type

Constructor & Destructor Documentation

◆ Matrix()

Member Function Documentation

◆ add()

◆ assembly() [1/8]

◆ assembly() [2/8]

◆ assembly() [3/8]

◆ assembly() [4/8]

◆ assembly() [5/8]

◆ assembly() [6/8]

◆ assembly() [7/8]

◆ assembly() [8/8]

◆ begin() [1/2]

◆ begin() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ nofCols()

◆ nofRows()

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ operator==()

◆ set()

◆ setTimings()

◆ timings()

◆ transpMult() [1/2]

◆ transpMult() [2/2]

Member Data Documentation

◆ timeCntr_

◆ timings_

concepts::Matrix< F > Class Template Referenceabstract
Bilinear and Linear Forms – Matrices and Vectors

template<class F>
class concepts::Matrix< F >