Implementation class for a single codim and single geometry type mapper. More...

#include <dune/grid/common/scsgmapper.hh>

Public Types
typedef GV::IndexSet::IndexType	Index
	Number type used for indices.

Public Member Functions
	SingleCodimSingleGeomTypeMapper (const GV &gridView)
	Construct mapper from grid and one of its index sets. More...

template<class EntityType >
Index	index (const EntityType &e) const
	Map entity to array index. More...

Index	subIndex (const typename GV::template Codim< 0 >::Entity &e, int i, unsigned int codim) const
	Map subentity of codim 0 entity to array index. More...

int	size () const
	Return total number of entities in the entity set managed by the mapper. More...

template<class EntityType >
bool	contains (const EntityType &e, Index &result) const
	Returns true if the entity is contained in the index set. More...

bool	contains (const typename GV::template Codim< 0 >::Entity &e, int i, int cc, Index &result) const
	Returns true if the entity is contained in the index set. More...

void	update ()
	Recalculates map after mesh adaptation.

Index	subIndex (const typename G::Traits::template Codim< 0 >::Entity &e, int i, unsigned int codim) const
	Map subentity i of codim cc of a codim 0 entity to array index. More...

bool	contains (const EntityType &e, int &result) const
	Returns true if the entity is contained in the index set and at the same time the array index is returned. More...

bool	contains (const typename G::Traits::template Codim< 0 >::Entity &e, int i, int cc, int &result) const
	Returns true if the subentity is contained in the index set and at the same time the array index is returned. More...

Detailed Description

template<typename GV, int c>
class Dune::SingleCodimSingleGeomTypeMapper< GV, c >

Implementation class for a single codim and single geometry type mapper.

In this implementation of a mapper the entity set used as domain for the map consists of the entities of a given codimension c for all entities in the given index set. The index set may only contain entities of a single geometry type, otherwise an exception is thrown. This version is usually not used directly but is used to implement versions for leafwise and levelwise entity sets.

Template Parameters

GV	A Dune grid view type
c	A valid codimension

Constructor & Destructor Documentation

◆ SingleCodimSingleGeomTypeMapper()

template<typename GV , int c>

Dune::SingleCodimSingleGeomTypeMapper< GV, c >::SingleCodimSingleGeomTypeMapper ( const GV & gridView )

inline

Construct mapper from grid and one of its index sets.

Parameters

gridView A Dune GridView object.

References DUNE_THROW.

Member Function Documentation

◆ contains() [1/4]

template<typename GV , int c>

template<class EntityType >

bool Dune::SingleCodimSingleGeomTypeMapper< GV, c >::contains	(	const EntityType &	e,
		Index &	result
	)		const

inline

Returns true if the entity is contained in the index set.

Parameters

e	Reference to entity
result	integer reference where corresponding index is stored if true

Returns: true if entity is in entity set of the mapper

References Dune::SingleCodimSingleGeomTypeMapper< GV, c >::index().

◆ contains() [2/4]

bool Dune::Mapper< GV::Grid , SingleCodimSingleGeomTypeMapper< GV, c > , GV::IndexSet::IndexType >::contains	(	const EntityType &	e,
		int &	result
	)		const

inlineinherited

Returns true if the entity is contained in the index set and at the same time the array index is returned.

Parameters

[in]	e	Reference to entity
[out]	result	Filled with array index if entity is contained

Returns: true if entity is in entity set of the mapper

◆ contains() [3/4]

bool Dune::Mapper< GV::Grid , SingleCodimSingleGeomTypeMapper< GV, c > , GV::IndexSet::IndexType >::contains	(	const typename G::Traits::template Codim< 0 >::Entity &	e,
		int	i,
		int	cc,
		int &	result
	)		const

inlineinherited

Returns true if the subentity is contained in the index set and at the same time the array index is returned.

Parameters

[in]	e	Reference to codim 0 entity
[in]	i	subentity number
[in]	cc	subentity codim
[out]	result	Filled with array index if entity is contained

Returns: true if entity is in entity set of the mapper

◆ contains() [4/4]

template<typename GV , int c>

bool Dune::SingleCodimSingleGeomTypeMapper< GV, c >::contains	(	const typename GV::template Codim< 0 >::Entity &	e,
		int	i,
		int	cc,
		Index &	result
	)		const

inline

Returns true if the entity is contained in the index set.

Parameters

e	Reference to codim 0 entity
i	subentity number
cc	subentity codim
result	integer reference where corresponding index is stored if true

Returns: true if entity is in entity set of the mapper

References Dune::SingleCodimSingleGeomTypeMapper< GV, c >::subIndex().

◆ index()

template<typename GV , int c>

template<class EntityType >

Index Dune::SingleCodimSingleGeomTypeMapper< GV, c >::index ( const EntityType & e ) const

inline

Map entity to array index.

\param e Reference to codim cc entity, where cc is the template parameter of the function.
\return An index in the range 0 ... Max number of entities in set - 1.

Referenced by Dune::SingleCodimSingleGeomTypeMapper< GV, c >::contains().

◆ size()

template<typename GV , int c>

int Dune::SingleCodimSingleGeomTypeMapper< GV, c >::size ( ) const

inline

Return total number of entities in the entity set managed by the mapper.

This number can be used to allocate a vector of data elements associated with the entities of the set. In the parallel case this number is per process (i.e. it may be different in different processes).

Returns: Size of the entity set.

◆ subIndex() [1/2]

Index Dune::Mapper< GV::Grid , SingleCodimSingleGeomTypeMapper< GV, c > , GV::IndexSet::IndexType >::subIndex	(	const typename G::Traits::template Codim< 0 >::Entity &	e,
		int	i,
		unsigned int	codim
	)		const

inlineinherited

Map subentity i of codim cc of a codim 0 entity to array index.

Parameters

e	Reference to codim 0 entity.
i	Number of codim cc subentity of e, where cc is the template parameter of the function.
codim	codimension of subentity of e

Returns: An index in the range 0 ... Max number of entities in set - 1.

◆ subIndex() [2/2]

template<typename GV , int c>

Index Dune::SingleCodimSingleGeomTypeMapper< GV, c >::subIndex	(	const typename GV::template Codim< 0 >::Entity &	e,
		int	i,
		unsigned int	codim
	)		const

inline

Map subentity of codim 0 entity to array index.

Parameters

e	Reference to codim 0 entity.
i	Number of the subentity of e, where cc is the template parameter of the function.
codim	Codimension of the subentity of e

Returns: An index in the range 0 ... Max number of entities in set - 1.

References DUNE_THROW.

Referenced by Dune::SingleCodimSingleGeomTypeMapper< GV, c >::contains().

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

dune/grid/common/scsgmapper.hh

DUNE Distributed and Unified Numerics Environment

Dune Core Modules (2.5.0)

Public Types

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SingleCodimSingleGeomTypeMapper()

Member Function Documentation

◆ contains() [1/4]

◆ contains() [2/4]

◆ contains() [3/4]

◆ contains() [4/4]

◆ index()

◆ size()

◆ subIndex() [1/2]

◆ subIndex() [2/2]