dune-grid  2.4
Public Types | Public Member Functions | Protected Types | List of all members
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 Types

enum  { codimension = codim }
 

Public Member Functions

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

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

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

Constructor & Destructor Documentation

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

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

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

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

Get stored HostEntitySeed.

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.


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