Provide default implementation of method if IndexSet.
More...
#include <dune/grid/common/indexidset.hh>
|
|
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...
|
|
|
auto | size (GeometryType type) const |
| Return total number of entities of given geometry type in entity set \(E\). More...
|
|
bool | contains (const Entity &e) const |
| Return true if the given entity is contained in \(E\). More...
|
|
|
static const int | dimension = Base::dimension |
| dimension of the grid (maximum allowed codimension)
|
|
|
Types | types (int codim) const |
|
auto | size (const int codim) const |
| Return total number of entities of given codim in the entity set \(E\). This is simply a sum over all geometry types. More...
|
|
template<class GridImp, class IndexSetImp>
class Dune::IndexSetDefaultImplementation< GridImp, IndexSetImp >
Provide default implementation of method if IndexSet.
◆ contains()
bool Dune::IndexSet< GridImp, IndexSetImp, IndexTypeImp, TypesImp >::contains |
( |
const Entity & |
e | ) |
const |
|
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]
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]
IndexType Dune::IndexSet< GridImp, IndexSetImp, IndexTypeImp, TypesImp >::index |
( |
const typename Traits::template Codim< cc >::Entity & |
e | ) |
const |
|
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() [1/2]
template<class GridImp , class IndexSetImp >
Return total number of entities of given codim in the entity set \(E\). This is simply a sum over all geometry types.
- Parameters
-
[in] | codim | A valid codimension |
- Returns
- number of entities (type is auto determined by the implementation. std::size_t is the expected return type).
References Dune::IndexSet< GridImp, IndexSetImp >::size().
◆ size() [2/2]
Return total number of entities of given geometry type in entity set \(E\).
- Parameters
-
[in] | type | A valid geometry type. |
- Returns
- number of entities (type is auto determined by the implementation. std::size_t is the expected return type).
◆ subIndex() [1/2]
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]
IndexType Dune::IndexSet< GridImp, IndexSetImp, IndexTypeImp, TypesImp >::subIndex |
( |
const typename Traits::template Codim< cc >::Entity & |
e, |
|
|
int |
i, |
|
|
unsigned int |
codim |
|
) |
| const |
|
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: