implementation of index set
More...
#include <dune/grid/sgrid.hh>
Public Types |
typedef IndexTypeImp | IndexType |
| The type used for the indices.
|
Public Member Functions |
| SGridLevelIndexSet (const GridImp &g, int l) |
| constructor stores reference to a grid and level
|
template<int cd> |
int | index (const typename GridImp::Traits::template Codim< cd >::Entity &e) const |
| get index of an entity
|
template<int cc> |
int | subIndex (const typename GridImp::Traits::template Codim< cc >::Entity &e, int i, unsigned int codim) const |
template<class EntityType > |
bool | contains (const EntityType &e) const |
| Return true if the given entity is contained in .
|
int | size (GeometryType type) const |
| get number of entities of given type and level (the level is known to the object)
|
int | size (int codim) const |
| return size of set for a given codim
|
const std::vector< GeometryType > & | geomTypes (int codim) const |
| deliver all geometry types used in this grid
|
|
IndexType | index (const typename remove_const< GridImp >::type::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.
|
IndexType | index (const EntityType &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.
|
IndexType | subIndex (const typename Traits::template Codim< cc >::Entity &e, int i, unsigned int codim) const |
| Map a subentity to an index.
|
IndexType | subIndex (const Entity &e, int i, unsigned int codim) const |
| Map a subentity to an index.
|
Static Public Attributes |
static const int | dimension |
| dimension of the grid (maximum allowed codimension)
|
Detailed Description
template<class GridImp>
class Dune::SGridLevelIndexSet< GridImp >
implementation of index set
Member Typedef Documentation
The type used for the indices.
Constructor & Destructor Documentation
Member Function Documentation
template<class GridImp >
template<class EntityType >
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.
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.
template<class GridImp >
template<int cd>
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.
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.
template<class GridImp >
template<int cc>
int Dune::SGridLevelIndexSet< GridImp >::subIndex |
( |
const typename GridImp::Traits::template Codim< cc >::Entity & |
e, |
|
|
int |
i, |
|
|
unsigned int |
codim |
|
) |
| const |
|
inline |
Member Data Documentation
The documentation for this class was generated from the following file: