#include <matrix.hh>

Inheritance diagram for concepts::Matrix< F >:

Public Types
typedef F	value_type

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

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

typedef std::conditional< std::is_same< typenameRealtype< F >::type, F >::value, typenameRealtype< F >::type, typenameCmplxtype< F >::type >::type	d_type
	Data type, depending if F is real or complex.

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

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

typedef F	type
	Type of data, e.g. matrix entries.

Public Member Functions
	Matrix (uint nofRows, uint nofCols)

const uint	nofRows () const
	Number of rows.

const uint	nofCols () const
	Number of columns.

iterator	begin (uint r=0)

iterator	end ()
	Iterator, standing behind last element.

const_iterator	begin (uint r=0) const

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

virtual void	set (const uint i, const uint j, const F value, const bool use_threshold=false, const Real threshold_value=1e-8)

virtual void	add (const uint i, const uint j, const F value, const bool use_threshold=false, const Real threshold_value=1e-8)

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

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

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

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

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

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

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

virtual void	operator() ()

virtual const uint	dimX () const

virtual const uint	dimY () const

virtual void	show_messages ()

Static Public Member Functions
template<class G >
static void	assembly (Matrix< F > &dest, const Space< G > &spc, const BilinearForm< F, G > &bf, const Real threshold=0.0)

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

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

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)

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)

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)

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

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)

Protected Member Functions
virtual std::ostream &	info (std::ostream &os) const
	Returns information in an output stream.

Protected Attributes
uint	dimX_
	Dimension of image space and the source space.

uint	dimY_

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); concepts::ResultsTable Definition resultsTable.hh:23 concepts::makeSet Set< F > makeSet(uint n, const F &first,...) Definition set.hh:320
static void	setTimings (InOutParameters *timings)

static bool	timings ()

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 39 of file matrix.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<typenameRealtype<F>::type,F>::value,typenameRealtype<F>::type,typenameCmplxtype<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.

◆ type

template<class F >

typedef F concepts::Operator< F >::type

inherited

Type of data, e.g. matrix entries.

Definition at line 45 of file compositions.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.

◆ dimX()

template<class F >

virtual const uint concepts::Operator< F >::dimX ( ) const

inlinevirtualinherited

Returns the size of the image space of the operator (number of rows of the corresponding matrix)

Examples: hpFEM2d-simple.cc, hpFEM2d.cc, and matfileTutorial.cc.

Definition at line 93 of file compositions.hh.

◆ dimY()

template<class F >

virtual const uint concepts::Operator< F >::dimY ( ) const

inlinevirtualinherited

Returns the size of the source space of the operator (number of columns of the corresponding matrix)

Examples: matfileTutorial.cc.

Definition at line 98 of file compositions.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.

◆ info()

template<class F >

virtual std::ostream & concepts::Operator< F >::info ( std::ostream & os ) const

protectedvirtualinherited

Returns information in an output stream.

Reimplemented from concepts::OutputOperator.

Reimplemented in concepts::Mumps< F >, concepts::MumpsOverlap< F >, aglowav::C2W< F >, aglowav::W2C< F >, aglowav::C2_tl2< F >, aglowav::C2tl2< F >, aglowav::CGt2< F >, aglowav::ComposeN< F >, aglowav2::Operator00< F >, aglowav2::C2W< F >, aglowav2::W2C< F >, bem::D< F >, bem::D_1< F >, cluster::Operator01< NodeX, NodeY >, cluster::Operator02< NodeX, NodeY >, concepts::ShiftAndInvertOperatorForGEVPs< F >, hp3D::SpaceTransition, concepts::AfterIteration< F >, concepts::BelosSolver< T >, concepts::BiCGStab< F, G >, concepts::CG< F >, concepts::VecOperator< F >, concepts::VecOperator< Cmplx >, concepts::VecOperator< F::d_type >, concepts::VecOperator< Real >, concepts::VecOperator< T >, concepts::Compose< F, H >, concepts::Multiple< F >, concepts::LiCoI< F >, concepts::LiCo< F >, concepts::Constrained, concepts::DenseMatrix< F >, concepts::DiagonalMatrix< F >, concepts::DiagonalSolver< F >, concepts::DDSolver< F, G >, concepts::GMRes< F >, concepts::LapackChol, concepts::NRLSolver, concepts::Pardiso, concepts::Permutation< F >, concepts::Permutation< Real >, concepts::TrivExtendRestrict< F >, concepts::TrivExtendRestrict< Real >, concepts::PETSc, concepts::PETScMat, concepts::SolverConjugate, concepts::SparseMatrix< F >, concepts::SparseMatrix< FX >, concepts::SparseMatrix< Real >, concepts::Spooles, concepts::SubMatrixN< F >, concepts::SuperLU< F >, concepts::Transpose< F >, concepts::Umfpack, sparseqr::Driver, sparseqr::GivensRotations< F >, sparseqr::GivensRotations< Real >, vectorial::BlockOperator< F >, vectorial::BramblePasciak, and vectorial::CGUzawa.

◆ 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/5]

template<class F >

virtual void concepts::Operator< F >::operator() ( )

virtualinherited

Application operator without argument

Reimplemented in concepts::BelosSolver< T >, concepts::VecOperator< F >, concepts::VecOperator< Cmplx >, concepts::VecOperator< F::d_type >, concepts::VecOperator< Real >, and concepts::VecOperator< T >.

◆ operator()() [2/5]

template<class F >

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

pure virtual

Application operator for complex function fncY.

Computes fncX = A(fncY) where A is this operator. fncX becomes complex.

In derived classes its enough to implement the operator() for complex Operator's. If a real counterpart is not implemented, the function fncY is splitted into real and imaginary part and the application operator for real functions is called for each. Then the result is combined.

If in a derived class the operator() for complex Operator's is not implemented, a exception is thrown from here.

Reimplemented from concepts::Operator< F >.

Implemented in concepts::DenseMatrix< F >, concepts::DiagonalMatrix< F >, concepts::Permutation< F >, concepts::Permutation< Real >, concepts::SparseMatrix< F >, concepts::SparseMatrix< FX >, concepts::SparseMatrix< Real >, concepts::SubMatrixN< F >, and concepts::Transpose< F >.

◆ operator()() [3/5]

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.

Reimplemented from concepts::Operator< F >.

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

◆ operator()() [4/5]

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::DenseMatrix< F >, concepts::DiagonalMatrix< F >, concepts::Permutation< F >, concepts::Permutation< Real >, concepts::PETScMat, concepts::SparseMatrix< F >, concepts::SparseMatrix< FX >, concepts::SparseMatrix< Real >, concepts::SubMatrixN< F >, and concepts::Transpose< F >.

◆ operator()() [5/5]

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::DenseMatrix< F >, concepts::DiagonalMatrix< F >, concepts::Permutation< F >, concepts::Permutation< Real >, concepts::PETScMat, concepts::SparseMatrix< F >, concepts::SparseMatrix< FX >, concepts::SparseMatrix< Real >, concepts::SubMatrixN< F >, and concepts::Transpose< 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

◆ show_messages()

template<class F >

virtual void concepts::Operator< F >::show_messages ( )

inlinevirtualinherited

Reimplemented in concepts::MumpsOverlap< F >.

Definition at line 100 of file compositions.hh.

◆ 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 >.

◆ 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::DenseMatrix< F >, concepts::DiagonalMatrix< F >, and concepts::Permutation< F >.

Member Data Documentation

◆ dimX_

template<class F >

uint concepts::Operator< F >::dimX_

protectedinherited

Dimension of image space and the source space.

Definition at line 104 of file compositions.hh.

◆ dimY_

template<class F >

uint concepts::Operator< F >::dimY_

protectedinherited

Definition at line 104 of file compositions.hh.

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

operator/compositions.hh
operator/matrix.hh

Class documentation of Concepts

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Timing Interface

Detailed Description

Member Typedef Documentation

◆ c_type

◆ const_iterator

◆ d_type

◆ iterator

◆ r_type

◆ 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]

◆ dimX()

◆ dimY()

◆ end() [1/2]

◆ end() [2/2]

◆ info()

◆ nofCols()

◆ nofRows()

◆ operator()() [1/5]

◆ operator()() [2/5]

◆ operator()() [3/5]

◆ operator()() [4/5]

◆ operator()() [5/5]

◆ operator==()

◆ set()

◆ setTimings()

◆ show_messages()

◆ timings()

◆ transpMult() [1/2]

◆ transpMult() [2/2]

Member Data Documentation

◆ dimX_

◆ dimY_