Dune Core Modules (2.4.1)
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 | 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
class Dune::LocalUniversalMapper< G >
Universal mapper based on local ids.
Template parameters are:
- Template Parameters
-
G A Dune grid type.
Constructor & Destructor Documentation
◆ LocalUniversalMapper()
|
inline |
The constructor.
- Parameters
-
grid A reference to a grid.
Member Function Documentation
◆ DUNE_DEPRECATED_MSG() [1/3]
|
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]
|
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.
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.
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] 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
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
Reinitialize mapper after grid has been modified.
◆ DUNE_DEPRECATED_MSG() [3/3]
|
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.
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.
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
-
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
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
Recalculates map after mesh adaptation
◆ index()
|
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:
- dune/grid/common/universalmapper.hh