Implements a mapper for an arbitrary subset of entities. More...

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

Public Types
typedef IndexType	Index
	Number type used for indices.

Public Member Functions
	UniversalMapper (const G &grid, const IDS &idset)
	Construct mapper from grid and one of its id sets. More...

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

Index	subIndex (const typename G::Traits::template Codim< 0 >::Entity &e, int i, int cc) 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 G::Traits::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 G, typename IDS, typename IndexType = int>
class Dune::UniversalMapper< G, IDS, IndexType >

Implements a mapper for an arbitrary subset of entities.

This implementation uses an ID set and a map, thus it has log complexity for each access. Template parameters are:

Entities need to be registered in order to use them. If an entity is queried with map, the known index is returned or a new index is created. The method contains only return true, if the entites was queried via map already.

Template Parameters

G	A Dune grid type.
IDS	An Id set type for the given grid.
IndexType	Number type used for the indices

Constructor & Destructor Documentation

◆ UniversalMapper()

template<typename G , typename IDS , typename IndexType = int>

Dune::UniversalMapper< G, IDS, IndexType >::UniversalMapper	(	const G &	grid,
		const IDS &	idset
	)

inline

Construct mapper from grid and one of its id sets.

Parameters

grid	A Dune grid object.
idset	An IndexSet object of the grid.

Deprecated:: "UniversalMapper is deprecated in DUNE 2.6"

Member Function Documentation

◆ contains() [1/4]

template<typename G , typename IDS , typename IndexType = int>

template<class EntityType >

bool Dune::UniversalMapper< G, IDS, IndexType >::contains	(	const EntityType &	e,
		Index &	result
	)		const

inline

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

The method contains only return true, if the entites was queried via map already.

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

◆ contains() [2/4]

bool Dune::Mapper< G, UniversalMapper< G, IDS > , int >::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]

template<typename G , typename IDS , typename IndexType = int>

bool Dune::UniversalMapper< G, IDS, IndexType >::contains	(	const typename G::Traits::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

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

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

◆ contains() [4/4]

bool Dune::Mapper< G, UniversalMapper< G, IDS > , int >::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

◆ index()

template<typename G , typename IDS , typename IndexType = int>

template<class EntityType >

Index Dune::UniversalMapper< G, IDS, IndexType >::index ( const EntityType & e ) const

inline

Map entity to array index.

If an entity is queried with map, the known index is returned or a new index is created. A call to map can never fail.

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

◆ size()

template<typename G , typename IDS , typename IndexType = int>

int Dune::UniversalMapper< G, IDS, IndexType >::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]

template<typename G , typename IDS , typename IndexType = int>

Index Dune::UniversalMapper< G, IDS, IndexType >::subIndex	(	const typename G::Traits::template Codim< 0 >::Entity &	e,
		int	i,
		int	cc
	)		const

inline

Map subentity of codim 0 entity to array index.

If an entity is queried with map, the known index is returned or a new index is created. A call to map can never fail.

Parameters

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

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

◆ subIndex() [2/2]

Index Dune::Mapper< G, UniversalMapper< G, IDS > , int >::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.

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

dune/grid/common/universalmapper.hh

DUNE Distributed and Unified Numerics Environment

Dune Core Modules (2.6.0)

Public Types

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ UniversalMapper()

Member Function Documentation

◆ contains() [1/4]

◆ contains() [2/4]

◆ contains() [3/4]

◆ contains() [4/4]

◆ index()

◆ size()

◆ subIndex() [1/2]

◆ subIndex() [2/2]