Dune Core Modules (2.4.1)
hierarchic index set of ALU2dGrid More...
#include <dune/grid/alugrid/2d/indexsets.hh>
Public Types | |
typedef int | IndexType |
The type used for the indices. | |
typedef TypesImp | Types |
iterator range for geometry types in domain | |
Public Member Functions | |
template<int codim> | |
int | index (const typename GridType::Traits::template Codim< codim >::Entity &entity) const |
return hierarchic index of given entity | |
template<class Entity > | |
int | index (const Entity &entity) const |
return hierarchic index of given entity | |
int | subIndex (const EntityCodim0Type &e, int i, unsigned int codim) const |
return subIndex of given entity for codim sub entity | |
int | size (GeometryType type) const |
int | size (int codim) const |
return size of indexset, i.e. maxindex+1 | |
const std::vector< GeometryType > & | geomTypes (int codim) const |
deliver all geometry types used in this grid | |
template<class EntityType > | |
bool | contains (const EntityType &) const |
return true because all entities are contained in this set | |
Index access from entity | |
IndexType | index (const typename Traits::template Codim< cc >::Entity &e) const |
Map entity to index. The result of calling this method with an entity that is not in the index set is undefined. More... | |
IndexType | subIndex (const typename Traits::template Codim< cc >::Entity &e, int i, unsigned int codim) const |
Map a subentity to an index. More... | |
IndexType | subIndex (const Entity &e, int i, unsigned int codim) const |
Map a subentity to an index. More... | |
Access to entity set | |
Types | types (int codim) const |
obtain all geometry types of entities in domain More... | |
Static Public Attributes | |
static const int | dimension |
dimension of the grid (maximum allowed codimension) | |
Detailed Description
class Dune::ALU2dGridHierarchicIndexSet< dim, dimworld, eltype >
hierarchic index set of ALU2dGrid
Member Function Documentation
◆ index()
|
inlineinherited |
Map entity to index. The result of calling this method with an entity that is not in the index set is undefined.
- Parameters
-
e Reference to codim cc entity, where cc is the template parameter of the function.
- Returns
- An index in the range 0 ... Max number of entities in set - 1.
◆ size()
|
inline |
return size of indexset, i.e. maxindex+1 for given type, if type is not exisiting within grid 0 is returned
References Dune::GeometryType::dim(), Dune::ALU2dGrid< dim, dimworld, eltype >::geomTypes(), and Dune::ALU2dGrid< dim, dimworld, eltype >::hierSetSize().
Referenced by Dune::ALU2dGridLocalIdSet< dim, dimworld, eltype >::id(), and Dune::ALU2dGridLocalIdSet< dim, dimworld, eltype >::subId().
◆ subIndex() [1/2]
|
inlineinherited |
Map a subentity to an index.
The result of calling this method with an entity that is not in the index set is undefined.
- Note
- This method exists for convenience only. It extracts the codimension from the type of the entity, which can be guessed by the compiler.
- Template Parameters
-
Entity type of entity (must be GridImp::Codim< cc >::Entity for some cc)
- Parameters
-
[in] e reference to entity [in] i number subentity of e within the codimension [in] codim codimension of the subentity we're interested in
- Returns
- An index in the range 0 ... Max number of entities in set - 1.
◆ subIndex() [2/2]
|
inlineinherited |
Map a subentity to an index.
The result of calling this method with an entity that is not in the index set is undefined.
- Template Parameters
-
cc codimension of the entity
- Parameters
-
[in] e reference to codimension cc entity [in] i number subentity of e within the codimension [in] codim codimension of the subentity we're interested in (must satisfy cc <= codim <= dimension)
- Returns
- An index in the range 0 ... Max number of entities in set - 1.
◆ types()
|
inlineinherited |
obtain all geometry types of entities in domain
This method returns an iterator range (something that behaves like Dune::IteratorRange) visiting all geometry types of codimension codim in the domain of the index map exactly once. The iterator must implement the concept of a forward iterator (in the sense of the STL). The elements in the iterator range are required to be of type Dune::GeometryType.
- Parameters
-
[in] codim a valid codimension
- Returns
- iterator range over Const reference to a vector of geometry types.
The documentation for this class was generated from the following files:
- dune/grid/alugrid/2d/grid.hh
- dune/grid/alugrid/2d/indexsets.hh