Dune::LocalUniversalMapper< G > Class Template Reference

Universal mapper based on local ids. More...

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

Public Types
typedef int	Index
	Number type used for indices.

Public Member Functions
	LocalUniversalMapper (const G &grid)
	The constructor. More...
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...
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...
int	size () const
	Return total number of entities in the entity set managed by the mapper. More...
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...
template<class EntityType >
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...
void	update ()
	Recalculates map after mesh adaptation.

Detailed Description

template<typename G>
class Dune::LocalUniversalMapper< G >

Universal mapper based on local ids.

Template parameters are:

Template Parameters

G	A Dune grid type.

Constructor & Destructor Documentation

LocalUniversalMapper()

template<typename G >

Dune::LocalUniversalMapper< G >::LocalUniversalMapper ( const G &  grid )

inline

The constructor.

Parameters

grid	A reference to a grid.

Deprecated:

"LocalUniversalMapper is deprecated in DUNE 2.6"

Member Function Documentation

contains() [1/4]

bool Dune::UniversalMapper< G, G::Traits::LocalIdSet , int >::contains ( const EntityType &  e, Index &  result  ) const

inlineinherited

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]

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

template<class EntityType >

bool Dune::Mapper< G, MapperImp, 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::UniversalMapper< G, G::Traits::LocalIdSet , int >::contains ( const typename G::Traits::template Codim< 0 >::Entity &  e, int  i, int  cc, Index &  result  ) const

inlineinherited

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]

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

bool Dune::Mapper< G, MapperImp, 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

index()

Index Dune::UniversalMapper< G, G::Traits::LocalIdSet , int >::index ( const EntityType &  e ) const

inlineinherited

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()

int Dune::UniversalMapper< G, G::Traits::LocalIdSet , int >::size ( ) const

inlineinherited

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::UniversalMapper< G, G::Traits::LocalIdSet , int >::subIndex ( const typename G::Traits::template Codim< 0 >::Entity &  e, int  i, int  cc  ) const

inlineinherited

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]

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

Index Dune::Mapper< G, MapperImp, 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.

Referenced by checkVertexDataMapper().

---

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

• dune/grid/common/universalmapper.hh