Dune Core Modules (2.5.0)
Dune::IdentityGridLevelIndexSet< GridImp > Class Template Reference
#include <dune/grid/identitygrid/identitygridindexsets.hh>
Public Types | |
typedef std::remove_const< GridImp >::type::HostGridType::LevelGridView::IndexSet::IndexType | IndexType |
The type used for the indices. | |
Public Member Functions | |
template<int codim> | |
int | index (const typename GridImp::Traits::template Codim< codim >::Entity &e) const |
get index of an entity | |
template<int cc> | |
int | subIndex (const typename GridImp::Traits::template Codim< cc >::Entity &e, int i, int codim) const |
get index of subEntity of a codim 0 entity | |
int | size (int codim) const |
get number of entities of given codim, type and on this level | |
int | size (GeometryType type) const |
get number of entities of given codim, type and on this level | |
const std::vector< GeometryType > & | geomTypes (int codim) const |
Deliver all geometry types used in this grid. | |
Types | types (int codim) const |
Deliver all geometry types used in this grid. | |
template<class EntityType > | |
bool | contains (const EntityType &e) const |
Return true if the given entity is contained in the index set. | |
void | update (const GridImp &grid, int level) |
Set up the index 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 | index (const Entity &e) const |
Map entity to index. Easier to use than the above because codimension template parameter need not be supplied explicitly. 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 | |
bool | contains (const Entity &e) const |
Return true if the given entity is contained in \(E\). More... | |
Static Public Attributes | |
static const int | dimension |
dimension of the grid (maximum allowed codimension) | |
Detailed Description
template<class GridImp>
class Dune::IdentityGridLevelIndexSet< GridImp >
class Dune::IdentityGridLevelIndexSet< GridImp >
- Todo:
- Take the index types from the host grid
Member Function Documentation
◆ contains()
|
inlineinherited |
Return true if the given entity is contained in \(E\).
- Note
- If the input element e is not an element of the grid, then the result of contains() is undefined.
◆ index() [1/2]
|
inlineinherited |
Map entity to index. Easier to use than the above because codimension template parameter need not be supplied explicitly. 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. Since entity knows its codimension, automatic extraction is possible.
- Returns
- An index in the range 0 ... Max number of entities in set - 1.
◆ index() [2/2]
|
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.
◆ 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
- Note
- The parameter
codim
denotes the codimension with respect to the grid, i.e., it must satisfy cc <= codim <= dimension.
- 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
- Note
- The parameter
codim
denotes the codimension with respect to the grid, i.e., it must satisfy cc <= codim <= dimension.
- 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/identitygrid/identitygridindexsets.hh
|
Legal Statements / Impressum |
Hosted by TU Dresden |
generated with Hugo v0.111.3
(Nov 12, 23:30, 2024)