dune-grid 2.11
Loading...
Searching...
No Matches
Dune::IdentityGridEntitySeed< codim, GridImp > Class Template Reference

The EntitySeed class provides the minimal information needed to restore an Entity using the grid. More...

#include <dune/grid/identitygrid/identitygridentityseed.hh>

Public Member Functions

 IdentityGridEntitySeed ()
 Construct an empty (i.e. isValid() == false) seed.
 IdentityGridEntitySeed (const HostEntity &hostEntity)
 Create EntitySeed from hostgrid Entity.
const HostEntitySeed & hostEntitySeed () const
 Get stored HostEntitySeed.
bool isValid () const
 Check whether it is safe to create an Entity from this Seed.

Static Public Attributes

static constexpr int codimension = codim

Protected Types

typedef GridImp::HostGridType::Traits::template Codim< codim >::Entity HostEntity
typedef GridImp::HostGridType::Traits::template Codim< codim >::EntitySeed HostEntitySeed

Detailed Description

template<int codim, class GridImp>
class Dune::IdentityGridEntitySeed< codim, GridImp >

The EntitySeed class provides the minimal information needed to restore an Entity using the grid.

Member Typedef Documentation

◆ HostEntity

template<int codim, class GridImp>
typedef GridImp::HostGridType::Traits::template Codim<codim>::Entity Dune::IdentityGridEntitySeed< codim, GridImp >::HostEntity
protected

◆ HostEntitySeed

template<int codim, class GridImp>
typedef GridImp::HostGridType::Traits::template Codim<codim>::EntitySeed Dune::IdentityGridEntitySeed< codim, GridImp >::HostEntitySeed
protected

Constructor & Destructor Documentation

◆ IdentityGridEntitySeed() [1/2]

template<int codim, class GridImp>
Dune::IdentityGridEntitySeed< codim, GridImp >::IdentityGridEntitySeed ( )
inline

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

◆ IdentityGridEntitySeed() [2/2]

template<int codim, class GridImp>
Dune::IdentityGridEntitySeed< codim, GridImp >::IdentityGridEntitySeed ( const HostEntity & hostEntity)
inline

Create EntitySeed from hostgrid Entity.

We call hostEntity.seed() directly in the constructor of IdentityGridEntitySeed to allow for return value optimization.

Member Function Documentation

◆ hostEntitySeed()

template<int codim, class GridImp>
const HostEntitySeed & Dune::IdentityGridEntitySeed< codim, GridImp >::hostEntitySeed ( ) const
inline

Get stored HostEntitySeed.

◆ isValid()

template<int codim, class GridImp>
bool Dune::IdentityGridEntitySeed< codim, GridImp >::isValid ( ) const
inline

Check whether it is safe to create an Entity from this Seed.

Member Data Documentation

◆ codimension

template<int codim, class GridImp>
int Dune::IdentityGridEntitySeed< codim, GridImp >::codimension = codim
staticconstexpr

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