Dune::Fem::Stencil< DomainSpace, RangeSpace > Class Template Reference

default implementation for a general operator stencil More...

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

Inheritance diagram for Dune::Fem::Stencil< DomainSpace, RangeSpace >:

Public Types
typedef DomainIteratorType::Entity	DomainEntityType
typedef RangeIteratorType::Entity	RangeEntityType
typedef DomainBlockMapper::GlobalKeyType	DomainGlobalKeyType
typedef RangeBlockMapper::GlobalKeyType	RangeGlobalKeyType
typedef std::set< DomainGlobalKeyType >	LocalStencilType
	type for storing the stencil of one row More...
typedef std::map< RangeGlobalKeyType, LocalStencilType >	GlobalStencilType
	type for storing the full stencil More...

Public Member Functions
	Stencil (const DomainSpace &dSpace, const RangeSpace &rSpace)
	Constructor. More...
void	fill (const DomainEntityType &dEntity, const RangeEntityType &rEntity, bool fillGhost=true)
	Create stencil entries for (dEntity,rEntity) pair. More...
const LocalStencilType &	localStencil (const RangeGlobalKeyType &key) const
	Return stencil for a given row of the matrix. More...
const GlobalStencilType &	globalStencil () const
	Return the full stencil. More...
int	maxNonZerosEstimate () const
	Return an upper bound for the maximum number of non-zero entries in all row. More...
int	rows () const
int	cols () const

Protected Attributes
const DomainBlockMapper &	domainBlockMapper_
const RangeBlockMapper &	rangeBlockMapper_
GlobalStencilType	globalStencil_

Detailed Description

template<class DomainSpace, class RangeSpace>
class Dune::Fem::Stencil< DomainSpace, RangeSpace >

default implementation for a general operator stencil

To assemble a matrix from an operator the method reserve has to be called on the linear operator class passing a stencil object as parameter. To setup a full stencil the method fill has to be called with each pair (en,nb) for which the localMatrix method is called during the assembly.

Template Parameters

DomainSpace	type of discrete function space for the domain
RangeSpace	type of discrete function space for the range

Member Typedef Documentation

DomainEntityType

template<class DomainSpace , class RangeSpace >

typedef DomainIteratorType::Entity Dune::Fem::Stencil< DomainSpace, RangeSpace >::DomainEntityType

DomainGlobalKeyType

template<class DomainSpace , class RangeSpace >

typedef DomainBlockMapper::GlobalKeyType Dune::Fem::Stencil< DomainSpace, RangeSpace >::DomainGlobalKeyType

GlobalStencilType

template<class DomainSpace , class RangeSpace >

typedef std::map<RangeGlobalKeyType,LocalStencilType> Dune::Fem::Stencil< DomainSpace, RangeSpace >::GlobalStencilType

type for storing the full stencil

LocalStencilType

template<class DomainSpace , class RangeSpace >

typedef std::set<DomainGlobalKeyType> Dune::Fem::Stencil< DomainSpace, RangeSpace >::LocalStencilType

type for storing the stencil of one row

RangeEntityType

template<class DomainSpace , class RangeSpace >

typedef RangeIteratorType::Entity Dune::Fem::Stencil< DomainSpace, RangeSpace >::RangeEntityType

RangeGlobalKeyType

template<class DomainSpace , class RangeSpace >

typedef RangeBlockMapper::GlobalKeyType Dune::Fem::Stencil< DomainSpace, RangeSpace >::RangeGlobalKeyType

Constructor & Destructor Documentation

Stencil()

template<class DomainSpace , class RangeSpace >

Dune::Fem::Stencil< DomainSpace, RangeSpace >::Stencil ( const DomainSpace &  dSpace, const RangeSpace &  rSpace  )

inline

Constructor.

Parameters

[in]	dSpace	domain space
[in]	rSpace	range space

Member Function Documentation

cols()

template<class DomainSpace , class RangeSpace >

int Dune::Fem::Stencil< DomainSpace, RangeSpace >::cols ( ) const

inline

fill()

template<class DomainSpace , class RangeSpace >

void Dune::Fem::Stencil< DomainSpace, RangeSpace >::fill ( const DomainEntityType &  dEntity, const RangeEntityType &  rEntity, bool  fillGhost = true  )

inline

Create stencil entries for (dEntity,rEntity) pair.

Parameters

[in]	dEntity	domain entity
[in]	rEntity	range entity
[in]	fillGhost	setup stencil even for a ghost domain entity

globalStencil()

template<class DomainSpace , class RangeSpace >

const GlobalStencilType& Dune::Fem::Stencil< DomainSpace, RangeSpace >::globalStencil ( ) const

inline

Return the full stencil.

localStencil()

template<class DomainSpace , class RangeSpace >

const LocalStencilType& Dune::Fem::Stencil< DomainSpace, RangeSpace >::localStencil ( const RangeGlobalKeyType &  key ) const

inline

Return stencil for a given row of the matrix.

Parameters

[in]

key

key for matrix row

maxNonZerosEstimate()

template<class DomainSpace , class RangeSpace >

int Dune::Fem::Stencil< DomainSpace, RangeSpace >::maxNonZerosEstimate ( ) const

inline

Return an upper bound for the maximum number of non-zero entries in all row.

rows()

template<class DomainSpace , class RangeSpace >

int Dune::Fem::Stencil< DomainSpace, RangeSpace >::rows ( ) const

inline

Member Data Documentation

domainBlockMapper_

template<class DomainSpace , class RangeSpace >

const DomainBlockMapper& Dune::Fem::Stencil< DomainSpace, RangeSpace >::domainBlockMapper_

protected

globalStencil_

template<class DomainSpace , class RangeSpace >

GlobalStencilType Dune::Fem::Stencil< DomainSpace, RangeSpace >::globalStencil_

protected

rangeBlockMapper_

template<class DomainSpace , class RangeSpace >

const RangeBlockMapper& Dune::Fem::Stencil< DomainSpace, RangeSpace >::rangeBlockMapper_

protected

---

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

• stencil.hh