Dune Core Modules (2.4.2)

Dune::GlobalUniversalMapper< G > Class Template Reference

Universal mapper based on global ids. More...

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

Public Types

typedef int Index
 Number type used for indices.
 

Public Member Functions

Index DUNE_DEPRECATED_MSG ("Will be removed after dune-grid-2.4. Use method 'index' instead!") map(const EntityType &e) const
 Map entity to array index. More...
 
Index DUNE_DEPRECATED_MSG ("Will be removed after dune-grid-2.4. Use method 'subIndex' instead!") map(const typename G
 Map subentity of codim 0 entity to array index. More...
 
Index DUNE_DEPRECATED_MSG ("Will be removed after dune-grid-2.4. Use method 'index' instead!") map(const typename G
 Map subentity i of codim cc of a codim 0 entity to array index. More...
 
Index index (const EntityType &e) const
 Map entity to array index. More...
 

Detailed Description

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

Universal mapper based on global ids.

Template parameters are:

Template Parameters
GA Dune grid type.

Member Function Documentation

◆ DUNE_DEPRECATED_MSG() [1/3]

Index Dune::UniversalMapper< G, G::Traits::GlobalIdSet , int >::DUNE_DEPRECATED_MSG ( "Will be removed after dune-grid-2.4. Use method 'index' instead!"  ) 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.

◆ DUNE_DEPRECATED_MSG() [2/3]

template<typename G , typename MapperImp , typename IndexType = int>
Index Dune::Mapper< G, MapperImp, IndexType >::DUNE_DEPRECATED_MSG ( "Will be removed after dune-grid-2.4. Use method 'index' instead!"  ) const
inlineinherited

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

Parameters
eReference to codim 0 entity.
iNumber of codim cc subentity of e, where cc is the template parameter of the function.
codimcodimension of subentity of e
Returns
An index in the range 0 ... Max number of entities in set - 1.

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

Parameters
eReference to codim 0 entity.
iNumber of codim cc subentity of e, where cc is the template parameter of the function.
codimcodimension of subentity of e
Returns
An index in the range 0 ... Max number of entities in set - 1.

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.

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

Parameters
[in]eReference to entity
[out]resultFilled with array index if entity is contained
Returns
true if entity is in entity set of the mapper

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

Parameters
[in]eReference to codim 0 entity
[in]isubentity number
[in]ccsubentity codim
[out]resultFilled with array index if entity is contained
Returns
true if entity is in entity set of the mapper

Reinitialize mapper after grid has been modified.

◆ DUNE_DEPRECATED_MSG() [3/3]

Index Dune::UniversalMapper< G, G::Traits::GlobalIdSet , int >::DUNE_DEPRECATED_MSG ( "Will be removed after dune-grid-2.4. Use method 'subIndex' instead!"  ) 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
eReference to codim 0 entity.
iNumber of codim cc subentity of e, where cc is the template parameter of the function.
cccodim of the subentity
Returns
An index in the range 0 ... Max number of entities in set - 1.

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
eReference to codim 0 entity.
iNumber of codim cc subentity of e, where cc is the template parameter of the function.
cccodim of the subentity
Returns
An index in the range 0 ... Max number of entities in set - 1.

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.

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
eReference to entity
resultinteger reference where corresponding index is stored if true
Returns
true if entity is in entity set of the mapper

Returns true if the entity is contained in the index set

Parameters
[in]eReference to codim 0 entity
[in]isubentity number
[in]ccsubentity codim
[out]resultinteger reference where corresponding index is stored if true
Returns
true if entity is in entity set of the mapper

Recalculates map after mesh adaptation

◆ index()

Index Dune::UniversalMapper< G, G::Traits::GlobalIdSet , 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.

The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.80.0 (Apr 19, 22:31, 2024)