Default implementation for local matrix classes. More...

#include <dune/fem/operator/common/localmatrix.hh>

Public Types
typedef ThisType	LocalMatrixInterfaceType
	type of this interface

typedef Traits::LocalMatrixType	LocalMatrixType
	type of local matrix implementation

typedef Traits::RangeFieldType	RangeFieldType
	type of range field

typedef Traits::LittleBlockType	LittleBlockType

Public Member Functions
void	init (const DomainEntityType &domainEntity, const RangeEntityType &rangeEntity)
	initialize the local matrix to entities More...

void	bind (const DomainEntityType &domainEntity, const RangeEntityType &rangeEntity)
	initialize the local matrix to entities More...

void	unbind ()
	clear local matrix from entities More...

void	resort ()
	resort ordering in global matrix (if possible) More...

void	finalize ()
	finalize local matrix setup and possibly add values to real matrix More...

int	rows () const
	get number of rows within the matrix More...

int	columns () const
	get number of columns within the matrix More...

const DomainSpaceType &	domainSpace () const
	access to the domain space More...

const RangeSpaceType &	rangeSpace () const
	access to the range space More...

const DomainBasisFunctionSetType &	domainBasisFunctionSet () const
	access to the base function set within the domain space More...

const RangeBasisFunctionSetType &	rangeBasisFunctionSet () const
	access to the base function set within the range space More...

template<class DomainLocalFunctionType , class RangeLocalFunctionType >
void	multiplyAdd (const DomainLocalFunctionType &lhs, RangeLocalFunctionType &rhs) const
	multiply left hand side with local matrix and add to right hand side rhs += Matrix * lhs More...

void	clearRow (const int localRow)
	set row to zero values More...

void	clearCol (const int localCol)
	ser column entries to zero More...

void	add (const int localRow, const int localCol, const RangeFieldType &value)
	add value to matrix entry (row,col) where row and col are local row and local column More...

void	set (const int localRow, const int localCol, const RangeFieldType &value)
	set value of matrix entry (row,col) where row and col are local row and local column More...

const RangeFieldType	get (const int localRow, const int localCol) const
	get value of matrix entry (row,col) where row and col are local row and local column More...

void	scale (const RangeFieldType &scalar)
	scale matrix with scalar value More...

void	clear ()
	set all entries of local matrix to zero

MatrixColumnType	column (const unsigned int col)
	return column object for local matrix which contains axpy methods for convenience More...

Detailed Description

template<class LocalMatrixTraits>
class Dune::Fem::LocalMatrixDefault< LocalMatrixTraits >

Default implementation for local matrix classes.

Member Typedef Documentation

◆ LittleBlockType

template<class LocalMatrixTraits >

typedef Traits::LittleBlockType Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::LittleBlockType

inherited

type of block (i.e. FieldMatrix for BlockMatrices

Member Function Documentation

◆ add()

template<class LocalMatrixTraits >

void Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::add	(	const int	localRow,
		const int	localCol,
		const RangeFieldType &	value
	)

inlineinherited

add value to matrix entry (row,col) where row and col are local row and local column

Parameters

[in]	localRow	local row
[in]	localCol	local column
[in]	value	value to add

References Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::add(), and CHECK_AND_CALL_INTERFACE_IMPLEMENTATION.

Referenced by Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::add().

◆ bind()

template<class LocalMatrixTraits >

void Dune::Fem::LocalMatrixDefault< LocalMatrixTraits >::bind	(	const DomainEntityType &	domainEntity,
		const RangeEntityType &	rangeEntity
	)

inline

initialize the local matrix to entities

Parameters

[in]	domainEntity	entity within grid of domain space,
[in]	rangeEntity	entity within grid of range space

Referenced by Dune::Fem::TemporaryLocalMatrix< DomainSpaceImp, RangeSpaceImp >::bind(), and Dune::Fem::LocalMatrixDefault< LocalMatrixTraits >::init().

◆ clearCol()

template<class LocalMatrixTraits >

void Dune::Fem::LocalMatrixDefault< LocalMatrixTraits >::clearCol ( const int localCol )

inline

ser column entries to zero

Parameters

[in] localCol local column that is set to zero

◆ clearRow()

template<class LocalMatrixTraits >

void Dune::Fem::LocalMatrixDefault< LocalMatrixTraits >::clearRow ( const int localRow )

inline

set row to zero values

Parameters

[in] localRow local row that is set to zero

◆ column()

template<class LocalMatrixTraits >

MatrixColumnType Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::column ( const unsigned int col )

inlineinherited

return column object for local matrix which contains axpy methods for convenience

Parameters

col	local column number

Returns: object of type MatrixColumnObject

◆ columns()

template<class LocalMatrixTraits >

int Dune::Fem::LocalMatrixDefault< LocalMatrixTraits >::columns ( ) const

inline

get number of columns within the matrix

◆ domainBasisFunctionSet()

template<class LocalMatrixTraits >

const DomainBasisFunctionSetType & Dune::Fem::LocalMatrixDefault< LocalMatrixTraits >::domainBasisFunctionSet ( ) const

inline

access to the base function set within the domain space

◆ domainSpace()

template<class LocalMatrixTraits >

const DomainSpaceType & Dune::Fem::LocalMatrixDefault< LocalMatrixTraits >::domainSpace ( ) const

inline

access to the domain space

Referenced by DifferentiableEllipticOperator< JacobianOperator, Model >::assemble().

◆ finalize()

template<class LocalMatrixTraits >

void Dune::Fem::LocalMatrixDefault< LocalMatrixTraits >::finalize ( )

inline

finalize local matrix setup and possibly add values to real matrix

◆ get()

template<class LocalMatrixTraits >

const RangeFieldType Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::get	(	const int	localRow,
		const int	localCol
	)		const

inlineinherited

get value of matrix entry (row,col) where row and col are local row and local column

Parameters

[in]	localRow	local row
[in]	localCol	local column

Returns: value of matrix entry

◆ init()

template<class LocalMatrixTraits >

void Dune::Fem::LocalMatrixDefault< LocalMatrixTraits >::init	(	const DomainEntityType &	domainEntity,
		const RangeEntityType &	rangeEntity
	)

inline

initialize the local matrix to entities

Parameters

[in]	domainEntity	entity within grid of domain space,
[in]	rangeEntity	entity within grid of range space

References Dune::Fem::LocalMatrixDefault< LocalMatrixTraits >::bind().

◆ multiplyAdd()

template<class LocalMatrixTraits >

template<class DomainLocalFunctionType , class RangeLocalFunctionType >

void Dune::Fem::LocalMatrixDefault< LocalMatrixTraits >::multiplyAdd	(	const DomainLocalFunctionType &	lhs,
		RangeLocalFunctionType &	rhs
	)		const

inline

multiply left hand side with local matrix and add to right hand side rhs += Matrix * lhs

Parameters

[in]	lhs	left hand side
[out]	rhs	right hand side

◆ rangeBasisFunctionSet()

template<class LocalMatrixTraits >

const RangeBasisFunctionSetType & Dune::Fem::LocalMatrixDefault< LocalMatrixTraits >::rangeBasisFunctionSet ( ) const

inline

access to the base function set within the range space

◆ rangeSpace()

template<class LocalMatrixTraits >

const RangeSpaceType & Dune::Fem::LocalMatrixDefault< LocalMatrixTraits >::rangeSpace ( ) const

inline

access to the range space

◆ resort()

template<class LocalMatrixTraits >

void Dune::Fem::LocalMatrixDefault< LocalMatrixTraits >::resort ( )

inline

resort ordering in global matrix (if possible)

◆ rows()

template<class LocalMatrixTraits >

int Dune::Fem::LocalMatrixDefault< LocalMatrixTraits >::rows ( ) const

inline

get number of rows within the matrix

◆ scale()

template<class LocalMatrixTraits >

void Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::scale ( const RangeFieldType & scalar )

inlineinherited

scale matrix with scalar value

Parameters

[in] scalar scalar value that scales the matrix

References CHECK_AND_CALL_INTERFACE_IMPLEMENTATION, and Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::scale().

Referenced by Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::scale().

◆ set()

template<class LocalMatrixTraits >

void Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::set	(	const int	localRow,
		const int	localCol,
		const RangeFieldType &	value
	)

inlineinherited

set value of matrix entry (row,col) where row and col are local row and local column

Parameters

[in]	localRow	local row
[in]	localCol	local column
[in]	value	value to set

References CHECK_AND_CALL_INTERFACE_IMPLEMENTATION, and Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::set().

Referenced by Dune::Fem::LocalMatrixInterface< LocalMatrixTraits >::set().

◆ unbind()

template<class LocalMatrixTraits >

void Dune::Fem::LocalMatrixDefault< LocalMatrixTraits >::unbind ( )

inline

clear local matrix from entities

Referenced by Dune::Fem::TemporaryLocalMatrix< DomainSpaceImp, RangeSpaceImp >::unbind().

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

dune/fem/operator/common/localmatrix.hh

DUNE Distributed and Unified Numerics Environment

DUNE-FEM (unstable)

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ LittleBlockType

Member Function Documentation

◆ add()

◆ bind()

◆ clearCol()

◆ clearRow()

◆ column()

◆ columns()

◆ domainBasisFunctionSet()

◆ domainSpace()

◆ finalize()

◆ get()

◆ init()

◆ multiplyAdd()

◆ rangeBasisFunctionSet()

◆ rangeSpace()

◆ resort()

◆ rows()

◆ scale()

◆ set()

◆ unbind()