Dune Core Modules (unstable)
Dune::EntitySeed< GridImp, EntitySeedImp > Class Template Reference
Store a reference to an entity with a minimal memory footprint. More...
#include <dune/grid/common/entityseed.hh>
Public Types | |
typedef EntitySeedImp | Implementation |
type of underlying implementation More... | |
Public Member Functions | |
EntitySeed () | |
Construct an empty (i.e. isValid() == false) seed. | |
EntitySeed (const EntitySeedImp &implementation) | |
Construct from implementation class. | |
bool | isValid () const |
check whether it is safe to create an Entity from this Seed | |
Implementation & | impl () |
access to the underlying implementation More... | |
const Implementation & | impl () const |
access to the underlying implementation More... | |
Static Public Attributes | |
static constexpr int | codimension = EntitySeedImp::codimension |
codimension of underlying entity | |
Detailed Description
template<class GridImp, class EntitySeedImp>
class Dune::EntitySeed< GridImp, EntitySeedImp >
class Dune::EntitySeed< GridImp, EntitySeedImp >
Store a reference to an entity with a minimal memory footprint.
The EntitySeed provides a light-weight way to store an entity. It is supposed to be implemented as memory-efficiently as possible. To get back the actual entity, you need the corresponding grid. On the grid, there is the method entity(const EntitySeed&), which gives you an Entity in exchange for an EntitySeed.
Member Typedef Documentation
◆ Implementation
template<class GridImp , class EntitySeedImp >
typedef EntitySeedImp Dune::EntitySeed< GridImp, EntitySeedImp >::Implementation |
type of underlying implementation
- Warning
- Implementation details may change without prior notification.
Member Function Documentation
◆ impl() [1/2]
template<class GridImp , class EntitySeedImp >
|
inline |
access to the underlying implementation
- Warning
- Implementation details may change without prior notification.
Referenced by Dune::AlbertaGrid< dim, dimworld >::entity(), and Dune::IdentityGrid< HostGrid >::entity().
◆ impl() [2/2]
template<class GridImp , class EntitySeedImp >
|
inline |
access to the underlying implementation
- Warning
- Implementation details may change without prior notification.
The documentation for this class was generated from the following file:
- dune/grid/common/entityseed.hh
![Creative Commons License](https://i.creativecommons.org/l/by-sa/4.0/80x15.png)