dune-grid: Dune::EntitySeed< GridImp, EntitySeedImp > Class Template Reference

dune-grid 2.9.0

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. More...

	EntitySeed (const EntitySeedImp &implementation)
	Construct from implementation class. More...

bool	isValid () const
	check whether it is safe to create an Entity from this Seed More...

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 More...

Detailed Description

template<class GridImp, class 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.

Constructor & Destructor Documentation

◆ EntitySeed() [1/2]

template<class GridImp , class EntitySeedImp >

Dune::EntitySeed< GridImp, EntitySeedImp >::EntitySeed ( )

inline

Construct an empty (i.e. isValid() == false) seed.

◆ EntitySeed() [2/2]

template<class GridImp , class EntitySeedImp >

Dune::EntitySeed< GridImp, EntitySeedImp >::EntitySeed ( const EntitySeedImp & implementation )

inline

Construct from implementation class.

Member Function Documentation

◆ impl() [1/2]

template<class GridImp , class EntitySeedImp >

Implementation & Dune::EntitySeed< GridImp, EntitySeedImp >::impl ( )

inline

access to the underlying implementation

Warning: Implementation details may change without prior notification.

◆ impl() [2/2]

template<class GridImp , class EntitySeedImp >

const Implementation & Dune::EntitySeed< GridImp, EntitySeedImp >::impl ( ) const

inline

access to the underlying implementation

Warning: Implementation details may change without prior notification.

◆ isValid()

template<class GridImp , class EntitySeedImp >

bool Dune::EntitySeed< GridImp, EntitySeedImp >::isValid ( ) const

inline

check whether it is safe to create an Entity from this Seed

Member Data Documentation

◆ codimension

template<class GridImp , class EntitySeedImp >

constexpr int Dune::EntitySeed< GridImp, EntitySeedImp >::codimension = EntitySeedImp::codimension

staticconstexpr

codimension of underlying entity

The documentation for this class was generated from the following file:

common/entityseed.hh