Universal mapper based on local ids.
More...
#include <dune/grid/common/universalmapper.hh>
|
typedef IndexType | Index |
| Number type used for indices. More...
|
|
|
| LocalUniversalMapper (const G &grid) |
| The constructor. More...
|
|
Index | map (const EntityType &e) const |
| Map entity to array index. More...
|
|
Index | map (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 | map (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...
|
|
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...
|
|
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. More...
|
|
void | clear () |
|
template<typename G>
class Dune::LocalUniversalMapper< G >
Universal mapper based on local ids.
Template parameters are:
- Template Parameters
-
Number type used for indices.
The constructor.
- Parameters
-
grid | A reference to a grid. |
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
bool Dune::UniversalMapper< G, G::Traits::LocalIdSet , IndexType >::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
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
bool Dune::Mapper< G, UniversalMapper< G, G::Traits::LocalIdSet > , 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
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.
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.
- Deprecated:
- "Will be removed after dune-grid-2.4. Use method 'index' instead!"
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.
- Deprecated:
- "Will be removed after dune-grid-2.4. Use method 'subIndex' instead!"
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.
- Deprecated:
- "Will be removed after dune-grid-2.4. Use method 'index' instead!"
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.
Index Dune::UniversalMapper< G, G::Traits::LocalIdSet , IndexType >::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.
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.
Recalculates map after mesh adaptation.
The documentation for this class was generated from the following file: