Provide default implementation of method if IndexSet. More...
#include <dune/grid/common/indexidset.hh>
Inheritance diagram for Dune::IndexSetDefaultImplementation< GridImp, IndexSetImp >:
Public Types | |
| typedef Base::IndexType | IndexType |
| The type used for the indices. | |
| typedef Base::Types | Types |
Public Member Functions | |
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. | |
| 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. | |
| 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. | |
Access to entity set | |
| auto | size (GeometryType type) const |
Return total number of entities of given geometry type in entity set  | |
| bool | contains (const Entity &e) const |
| Return true if the given entity is contained in | |
Static Public Attributes | |
| static const int | dimension = Base::dimension |
| dimension of the grid (maximum allowed codimension) | |
Access to entity set | |
| Types | types (int codim) const |
| auto | size (const int codim) const |
| Return total number of entities of given codim in the entity set | |
Detailed Description
template<class GridImp, class IndexSetImp>
class Dune::IndexSetDefaultImplementation< GridImp, IndexSetImp >
class Dune::IndexSetDefaultImplementation< GridImp, IndexSetImp >
Provide default implementation of method if IndexSet.
Member Typedef Documentation
◆ IndexType
template<class GridImp , class IndexSetImp >
| typedef Base::IndexType Dune::IndexSetDefaultImplementation< GridImp, IndexSetImp >::IndexType |
The type used for the indices.
◆ Types
template<class GridImp , class IndexSetImp >
| typedef Base::Types Dune::IndexSetDefaultImplementation< GridImp, IndexSetImp >::Types |
Member Function Documentation
◆ contains()
|
inlineinherited |
Return true if the given entity is contained in
- 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.
◆ size() [1/2]
template<class GridImp , class IndexSetImp >
|
inline |
Return total number of entities of given codim in the entity set
- 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).
◆ size() [2/2]
|
inlineinherited |
Return total number of entities of given geometry type in entity set
- 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]
|
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
codimdenotes 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
codimdenotes 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.
◆ types()
template<class GridImp , class IndexSetImp >
|
inline |
Member Data Documentation
◆ dimension
template<class GridImp , class IndexSetImp >
|
static |
dimension of the grid (maximum allowed codimension)
The documentation for this class was generated from the following file:
