Dune Core Modules (2.4.1)
#include <dune/grid/common/mapper.hh>
Public Types | |
typedef IndexType | Index |
Number type used for indices. | |
Public Member Functions | |
template<class EntityType > | |
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... | |
template<class EntityType > | |
Index | index (const EntityType &e) const |
Map 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... | |
Detailed Description
class Dune::Mapper< G, MapperImp, IndexType >
Mapper interface.
This class template is used as a base class for all mapper implementations. It uses the Barton-Nackman trick to ensure conformity to the interface.
- Template Parameters
-
G Type that is a model of Dune::Grid MapperImp Type that is a model of Dune::Mapper IndexType Integer type used for indices. Default type is for backward-compatibility
- Todo:
- IndexType should be extracted from MapperImp, but gcc doesn't let me
Member Function Documentation
◆ DUNE_DEPRECATED_MSG() [1/2]
|
inline |
Map entity to array index.
\param e Reference to codim cc entity. The codim is extracted from the entity. \return An index in the range 0 ... Max number of entities in set - 1.
◆ DUNE_DEPRECATED_MSG() [2/2]
|
inline |
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.
◆ index()
|
inline |
Map entity to array index.
\param e Reference to codim cc entity. The codim is extracted from the entity. \return An index in the range 0 ... Max number of entities in set - 1.
Referenced by checkElementDataMapper(), and checkMixedDataMapper().
The documentation for this class was generated from the following file:
- dune/grid/common/mapper.hh