Dune Core Modules (2.9.0)

Dune::SPEntitySeed< codim, Grd > Struct Template Reference

entity seed for SPGrid More...

#include <dune/grid/spgrid/entityseed.hh>

Public Types

typedef std::remove_const< Grd >::type Grid
 type of grid this entity seed belongs to
 
typedef Grid::Traits::ReferenceCube ReferenceCube
 type of reference cube More...
 
typedef Grid::Traits::template Codim< codimension >::Entity Entity
 type of the seeded entity
 
typedef ReferenceCube::MultiIndex MultiIndex
 type of multi index More...
 

Public Member Functions

 SPEntitySeed ()
 default constructor More...
 
 SPEntitySeed (const int level, const MultiIndex &id, const unsigned int partitionNumber)
 constructor More...
 
bool isValid () const
 check whether this seed generates a valid entity
 
int level () const
 obtain level of the seeded entity More...
 
MultiIndex id () const
 obtain the multi index of the seeded entity More...
 
unsigned int partitionNumber () const
 obtain number of the partition, the seeded entity belongs to More...
 

Static Public Attributes

static const int dimension = ReferenceCube::dimension
 dimension of the grid
 
static const int codimension = codim
 codimension of the seeded entity
 
static const int mydimension = dimension - codimension
 dimension of the seeded entity
 
static const int dimensionworld = dimension
 world dimension of the grid
 

Detailed Description

template<int codim, class Grd>
struct Dune::SPEntitySeed< codim, Grd >

entity seed for SPGrid

The entity seed contains the minimal information required to rebuild the entity, if the grid is still known. It should be preferred over the entity pointer when storing entities.

Note
While rebuilding an entity pointer from an entity seed is assumed to be cheap, it introduces non-negligible overhead. If a large quantity of the grid is to be stored and the order is of no import, filtering an iterator might be a better option.
Template Parameters
codimcodimension of the seeded entity
GrdGrid (must be a SPGrid)

Member Typedef Documentation

◆ MultiIndex

template<int codim, class Grd >
typedef ReferenceCube::MultiIndex Dune::SPEntitySeed< codim, Grd >::MultiIndex

type of multi index

◆ ReferenceCube

template<int codim, class Grd >
typedef Grid::Traits::ReferenceCube Dune::SPEntitySeed< codim, Grd >::ReferenceCube

type of reference cube

Constructor & Destructor Documentation

◆ SPEntitySeed() [1/2]

template<int codim, class Grd >
Dune::SPEntitySeed< codim, Grd >::SPEntitySeed ( )
inline

default constructor

Note
A default constructed entity seed is invalid.

◆ SPEntitySeed() [2/2]

template<int codim, class Grd >
Dune::SPEntitySeed< codim, Grd >::SPEntitySeed ( const int  level,
const MultiIndex id,
const unsigned int  partitionNumber 
)
inline

constructor

Parameters
[in]levellevel of the seeded entity
[in]idmulti index of the seeded entity
[in]partitionNumbernumber of the partition, the seeded entity belongs to

Member Function Documentation

◆ id()

template<int codim, class Grd >
MultiIndex Dune::SPEntitySeed< codim, Grd >::id ( ) const
inline

obtain the multi index of the seeded entity

Returns
the multi index of the seeded entity

References Dune::SPEntitySeed< codim, Grd >::isValid().

◆ level()

template<int codim, class Grd >
int Dune::SPEntitySeed< codim, Grd >::level ( ) const
inline

obtain level of the seeded entity

Returns
the level of the seeded entity

References Dune::SPEntitySeed< codim, Grd >::isValid().

◆ partitionNumber()

template<int codim, class Grd >
unsigned int Dune::SPEntitySeed< codim, Grd >::partitionNumber ( ) const
inline

obtain number of the partition, the seeded entity belongs to

Returns
the number of the partition, the seeded entity belongs to

References Dune::SPEntitySeed< codim, Grd >::isValid().


The documentation for this struct was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.80.0 (Mar 28, 23:30, 2024)