Dune Core Modules (2.4.1)
Multiple codim and multiple geometry type mapper for entities of one level. More...
#include <dune/grid/common/mcmgmapper.hh>
Public Types | |
typedef GV::IndexSet::IndexType | Index |
Number type used for indices. | |
Public Member Functions | |
LevelMultipleCodimMultipleGeomTypeMapper (const G &grid, int level) | |
The constructor. More... | |
LevelMultipleCodimMultipleGeomTypeMapper (const G &grid, int level, const Layout< G::dimension > layout) | |
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::LevelGridView |
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 GV::Grid |
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::LevelMultipleCodimMultipleGeomTypeMapper< G, Layout >
Multiple codim and multiple 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.
- Template Parameters
-
G A Dune grid type. Layout A helper class template which determines which types of entities are mapped by this mapper. See MultipleCodimMultipleGeomTypeMapper for how exactly this template should look.
Constructor & Destructor Documentation
◆ LevelMultipleCodimMultipleGeomTypeMapper() [1/2]
|
inline |
The constructor.
- Parameters
-
grid A reference to a grid. level A valid level of the grid.
◆ LevelMultipleCodimMultipleGeomTypeMapper() [2/2]
|
inline |
The constructor.
Use this constructor to provide a custom layout object e.g. not using the default constructor.
- Parameters
-
grid A reference to a grid. level A valid level of the grid. layout A layout object
Member Function Documentation
◆ DUNE_DEPRECATED_MSG() [1/3]
|
inlineinherited |
Map entity to array index.
- Template Parameters
-
EntityType
- Parameters
-
e Reference to codim EntityType entity.
- Returns
- 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.
- Parameters
-
e Reference to codim 0 entity. i Number of subentity of e codim Codimension 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.
- Parameters
-
e Reference to codim 0 entity. i Number of subentity of e codim Codimension 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
- 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
-
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
Recalculates map after mesh adaptation
◆ index()
|
inlineinherited |
Map entity to array index.
- Template Parameters
-
EntityType
- Parameters
-
e Reference to codim EntityType entity.
- Returns
- 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/mcmgmapper.hh