Dune Core Modules (2.5.0)
implement a consecutive index for all entities of given codim of a YaspGrid More...
#include <dune/grid/yaspgrid/yaspgridpersistentcontainer.hh>
Public Types | |
typedef std::size_t | IndexType |
The type used for the indices. More... | |
Public Member Functions | |
template<class Entity > | |
IndexType | index (const 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... | |
template<class Entity > | |
IndexType | subIndex (const Entity &e, int i, unsigned int codim) const |
Map a subentity to an index. More... | |
std::size_t | size (int codim) const |
Return total number of entities of given geometry type in entity set \(E\). More... | |
Detailed Description
class Dune::YaspPersistentContainerIndex< Grid >
implement a consecutive index for all entities of given codim of a YaspGrid
this class behaves similar to an IndexSet
to make this work for a persistent vector we have to implement...
indexSet.size( codim ) indexSet.index( entity ); indexSet.subIndex( entity, subEntity, codimension() );
Member Typedef Documentation
◆ IndexType
typedef std::size_t Dune::YaspPersistentContainerIndex< Grid >::IndexType |
The type used for the indices.
Member Function Documentation
◆ index()
|
inline |
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.
References Dune::Entity< cd, dim, GridImp, EntityImp >::codimension, and Dune::Entity< cd, dim, GridImp, EntityImp >::level().
◆ size()
|
inline |
Return total number of entities of given geometry type in entity set \(E\).
- Parameters
-
[in] type A valid geometry type.
- Returns
- number of entities.
References Dune::Grid< dim, dimworld, ct, GridFamily >::size().
◆ subIndex()
|
inline |
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.
References Dune::Entity< cd, dim, GridImp, EntityImp >::codimension, and Dune::Entity< cd, dim, GridImp, EntityImp >::level().
The documentation for this class was generated from the following files:
- dune/grid/yaspgrid.hh
- dune/grid/yaspgrid/yaspgridpersistentcontainer.hh