#include <tmatrix.hh>

Inheritance diagram for concepts::TMatrix< F >:

Classes
struct	Control
	The column header: column index and length of the column data. More...

struct	Data
	The matrix entries: row index and data. More...

Public Member Functions
	TMatrix (TColumn< F > *T)

	TMatrix (const TMatrix< F > &T, Set< uint > *idx=0)

template<class G >
	TMatrix (const TMatrix< G > &T)

void	operator() (const ElementMatrix< F > &A, ElementMatrix< F > &B) const

void	operator() (const ElementMatrix<::std::complex< F > > &A, ElementMatrix<::std::complex< F > > &B) const

void	operator() (const Vector< F > &A, Vector< F > &B) const

void	applyOne (const ElementMatrix< F > &A, ElementMatrix< F > &B) const

virtual uint	index (const uint i) const

void	append (TColumn< F > *T)

const TMatrix::Control *	control (uint i) const

const TMatrix::Data *	data (uint i) const
	Returns the ith entry of the data array.

TColumn< F > *	columns () const

uint	nEntries () const

virtual void	usedIdx (TColumn< bool > &c) const

virtual void	usedIdx (Set< uint > &c) const

virtual void	extract (const concepts::Vector< F > &solution, concepts::Array< F > &coeff) const

virtual void	extract (const concepts::Vector<::std::complex< F > > &solution, concepts::Array<::std::complex< F > > &coeff) const

void	extractOne (const concepts::Vector< F > &solution, concepts::Array< F > &coeff) const

::std::ostream &	outputLocalMap (::std::ostream &os) const

uint	m () const
	Returns the number of rows.

void	setM (uint m)

uint	n () const
	Returns the number of columns.

Protected Member Functions
virtual ::std::ostream &	info (::std::ostream &os) const

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

Protected Attributes
uint	n_
	Number of columns.

uint	m_
	Number of rows.

Detailed Description

template<class F>
class concepts::TMatrix< F >

A T matrix in sparse notation. All non-zero matrix entries are stored in one big array together with their row index. Another array of the same size stores the column indices and the length of each column in the array (not the real length).

The columns of the matrix are TColumn.

See also: TColumn the columns of the matrix.

Definition at line 494 of file tmatrix.hh.

Constructor & Destructor Documentation

◆ TMatrix() [1/3]

template<class F >

concepts::TMatrix< F >::TMatrix ( TColumn< F > * T )

Constructor. The size of the matrix is initially set to 0.

Parameters

T	a linked list of columns (in full notation) to be initially stored.

◆ TMatrix() [2/3]

template<class F >

concepts::TMatrix< F >::TMatrix	(	const TMatrix< F > &	T,
		Set< uint > *	idx = `0`
	)

Copy-Constructor.

Takes only the local indices in idx.

◆ TMatrix() [3/3]

template<class F >

template<class G >

concepts::TMatrix< F >::TMatrix ( const TMatrix< G > & T )

to "upcast" TMatrix<Real> to TMatrix<Cmplx>

Definition at line 645 of file tmatrix.hh.

Member Function Documentation

◆ append()

template<class F >

void concepts::TMatrix< F >::append ( TColumn< F > * T )

Appends the columns to the matrix. n_ is updated to reflect the real size of the matrix. m_ is updated to show the number of columns which are stored. The columns are scanned and the needed space is allocated. Then the new data is stored.

Parameters

T	a linked list of columns (in full notation) to be stored.

◆ control()

template<class F >

const TMatrix::Control * concepts::TMatrix< F >::control ( uint i ) const

inline

Returns the ith entry of the control data array

Parameters

i	a colum index, i.e. i < n()

Definition at line 601 of file tmatrix.hh.

◆ data()

template<class F >

const TMatrix::Data * concepts::TMatrix< F >::data ( uint i ) const

inline

Returns the ith entry of the data array.

Definition at line 604 of file tmatrix.hh.

◆ extract() [1/2]

template<class F >

virtual void concepts::TMatrix< F >::extract	(	const concepts::Vector< F > &	solution,
		concepts::Array< F > &	coeff
	)		const

virtual

Extracts the part of solution belonging to this T matrix into coeff.

coeff is resized and zeroed before filling it with the coefficients.

Parameters

solution	Vector in the global space (input)
coeff	Local coefficients of this T matrix (output)

Implements concepts::TMatrixBase< F >.

Reimplemented in concepts::TMatrixBlock< F >.

◆ extract() [2/2]

template<class F >

virtual void concepts::TMatrix< F >::extract	(	const concepts::Vector<::std::complex< F > > &	solution,
		concepts::Array<::std::complex< F > > &	coeff
	)		const

virtual

Implements concepts::TMatrixBase< F >.

◆ index()

template<class F >

virtual uint concepts::TMatrix< F >::index ( const uint i ) const

inlinevirtual

Mapping of the column index to the global degree of freedom

Remember: the columns represent the global degrees of freedom to which the shape functions of this element contribute.

More technical: the columns of a TMatrix contain the column index in Control::idx and the relevant data in TMatrix::Data but the number of columns stored in TMatrixBase::n_ does not reflect the global number of degrees of freedom. Therefore, there might be empty columns and TMatrixBase::n_ could be lower than the global number of degrees of freedom.

Implements concepts::TMatrixBase< F >.

Definition at line 587 of file tmatrix.hh.

◆ info()

virtual std::ostream & concepts::OutputOperator::info ( std::ostream & os ) const

protectedvirtualinherited

Returns information in an output stream.

◆ m()

template<class F >

uint concepts::TMatrixBase< F >::m ( ) const

inlineinherited

Returns the number of rows.

Definition at line 388 of file tmatrix.hh.

◆ n()

template<class F >

uint concepts::TMatrixBase< F >::n ( ) const

inlineinherited

Returns the number of columns.

Definition at line 393 of file tmatrix.hh.

◆ nEntries()

template<class F >

uint concepts::TMatrix< F >::nEntries ( ) const

inline

number of entries in the data vector

Definition at line 610 of file tmatrix.hh.

◆ operator()() [1/2]

template<class F >

void concepts::TMatrix< F >::operator()	(	const ElementMatrix< F > &	A,
		ElementMatrix< F > &	B
	)		const

virtual

Application operator.

Computes the application of the T matrix on A and returns B: $B = A \cdot T$ . The typical usage is explained in the base class.

More detailed: B is resized to a $n_A \times m_T$ matrix, then $B_{ij} = \sum_k A_{ik} T_{kj}$ where $i=1,\dots,n_A$ and $j=1,\dots,m_T$ and $\sum_k$ means sum over all which are present in the T matrix.