Single codim and single geometry type mapper for entities of one level.
More...
#include <dune/grid/common/scsgmapper.hh>
|
typedef GV::IndexSet::IndexType | Index |
| Number type used for indices. More...
|
|
using | size_type = decltype(std::declval< typename GV::IndexSet >().size(0)) |
| Number type used for the overall size (the return value of the 'size' method) More...
|
|
|
| LevelSingleCodimSingleGeomTypeMapper (const G &grid, int level) |
|
void | update () |
| Recalculates indices after grid adaptation. More...
|
|
Index | index (const EntityType &e) const |
| Map entity to array index. More...
|
|
Index | subIndex (const typename GV::template Codim< 0 >::Entity &e, int i, unsigned int codim) 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...
|
|
size_type | 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 GV::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 typename G::Traits::template Codim< 0 >::Entity &e, int i, int cc, GV::IndexSet::IndexType &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 (const G::LevelGridView &gridView) |
| Recalculates indices after grid adaptation. More...
|
|
void | update (G::LevelGridView &&gridView) |
| Recalculates indices after grid adaptation. More...
|
|
void | update (GridView &&gridView) |
| Reinitialize mapper after grid has been modified. More...
|
|
template<typename G, int c>
class Dune::LevelSingleCodimSingleGeomTypeMapper< G, c >
Single codim and single geometry type mapper for entities of one level.
This mapper uses all entities of a certain codimension on a given level as its entity set. It is assumed (and checked) that the given grid contains only entities of a single geometry type.
Template parameters are:
- Template Parameters
-
G | A Dune grid type. |
c | A valid codimension. |
- Deprecated:
- Use SingleCodimSingleGeomTypeMapper instead
◆ Index
Number type used for indices.
◆ size_type
Number type used for the overall size (the return value of the 'size' method)
The type used here is set to be the corresponding type used by the GridView's index set.
◆ LevelSingleCodimSingleGeomTypeMapper()
template<typename G , int c>
◆ contains() [1/3]
Returns true if the entity is contained in the index set.
- 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/3]
bool Dune::Mapper< GV::Grid , SingleCodimSingleGeomTypeMapper< G::LevelGridView, c > , GV::IndexSet::IndexType >::contains |
( |
const typename G::Traits::template Codim< 0 >::Entity & |
e, |
|
|
int |
i, |
|
|
int |
cc, |
|
|
GV::IndexSet::IndexType & |
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
◆ contains() [3/3]
Returns true if the entity is contained in the index set.
- Parameters
-
e | Reference to codim 0 entity |
i | subentity number |
cc | subentity codim |
result | integer reference where corresponding index is stored if true |
- Returns
- true if entity is in entity set of the mapper
◆ index()
Map entity to array index.
\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()
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]
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.
◆ subIndex() [2/2]
Map subentity of codim 0 entity to array index.
- Parameters
-
e | Reference to codim 0 entity. |
i | Number of the subentity of e, where cc is the template parameter of the function. |
codim | Codimension of the subentity of e |
- Returns
- An index in the range 0 ... Max number of entities in set - 1.
◆ update() [1/4]
template<typename G , int c>
Recalculates indices after grid adaptation.
After grid adaptation you need to call this to update the index set and recalculate the indices.
◆ update() [2/4]
Recalculates indices after grid adaptation.
After grid adaptation you need to call this to update the stored gridview and recalculate the indices.
◆ update() [3/4]
Recalculates indices after grid adaptation.
After grid adaptation you need to call this to update the stored gridview and recalculate the indices.
◆ update() [4/4]
Reinitialize mapper after grid has been modified.
The documentation for this class was generated from the following file: