dune-grid  2.2.0
Public Types | Public Member Functions | List of all members
Dune::GeoGrid::EntityBase< codim, Grid, false > Class Template Reference

construct an uninitialized entity More...

#include <dune/grid/geometrygrid/entity.hh>

Public Types

typedef Traits::template Codim
< codim >::GeometryImpl 
GeometryImpl

Public Member Functions

const EntityBaseoperator= (const EntityBase &other)
 operator bool () const

Attributes

static const int codimension = codim
 codimensioon of the entity
static const int dimension = Traits::dimension
 dimension of the grid
static const int mydimension = dimension - codimension
 dimension of the entity
static const int dimensionworld = Traits::dimensionworld
 dimension of the world
static const bool fake = false
 true, if the entity is faked, i.e., if there is no corresponding host entity

Types Required by DUNE

typedef Traits::ctype ctype
 coordinate type of the grid
typedef Traits::template Codim
< codimension >::Geometry 
Geometry
 type of corresponding geometry

Host Types

typedef HostGrid::template
Codim< codimension >::Entity 
HostEntity
 type of corresponding host entity
typedef HostGrid::template
Codim< codimension >
::EntityPointer 
HostEntityPointer
 type of corresponding host entity pointer
typedef Traits::template Codim
< codimension >::EntitySeed 
EntitySeed
 type of corresponding entity seed
typedef HostGrid::template
Codim< 0 >::Entity 
HostElement
 type of host elements, i.e., of host entities of codimension 0

Construction, Initialization and Destruction

 EntityBase (const Grid &grid)
 construct an uninitialized entity
 EntityBase (const GeometryImpl &geo)
 construct an uninitialized entity
 EntityBase (const EntityBase &other)

Methods Shared by Entities of All Codimensions

GeometryType type () const
 obtain the name of the corresponding reference element
unsigned int topologyId () const
int level () const
 obtain the level of this entity
PartitionType partitionType () const
 obtain the partition type of this entity
Geometry geometry () const
EntitySeed seed () const
 return EntitySeed of host grid entity

Methods Supporting the Grid Implementation

const Gridgrid () const
const HostEntityhostEntity () const
void initialize (const HostEntity &hostEntity)
 initiliaze an entity
template<class HostIndexSet >
HostIndexSet::IndexType index (const HostIndexSet &indexSet) const
 obtain the entity's index from a host IndexSet
template<class HostIndexSet >
HostIndexSet::IndexType subIndex (const HostIndexSet &indexSet, int i, unsigned int cd) const
 obtain the index of a subentity from a host IndexSet
template<class HostIndexSet >
bool isContained (const HostIndexSet &indexSet) const
 check whether the entity is contained in a host index set
template<class HostIdSet >
HostIdSet::IdType id (const HostIdSet &idSet) const
 obtain the entity's id from a host IdSet

Detailed Description

template<int codim, class Grid>
class Dune::GeoGrid::EntityBase< codim, Grid, false >

construct an uninitialized entity

Parameters
[in]gridGeometryGrid this entity belongs to
Note
The geometry of an uninitialized entity might already be set

This specialization implements the case, where the host grid provides the entity for this codimension, i.e., fake = false.

Member Typedef Documentation

template<int codim, class Grid >
typedef Traits::ctype Dune::GeoGrid::EntityBase< codim, Grid, false >::ctype

coordinate type of the grid

template<int codim, class Grid >
typedef Traits::template Codim< codimension >::EntitySeed Dune::GeoGrid::EntityBase< codim, Grid, false >::EntitySeed

type of corresponding entity seed

template<int codim, class Grid >
typedef Traits::template Codim< codimension >::Geometry Dune::GeoGrid::EntityBase< codim, Grid, false >::Geometry

type of corresponding geometry

template<int codim, class Grid >
typedef Traits::template Codim< codim >::GeometryImpl Dune::GeoGrid::EntityBase< codim, Grid, false >::GeometryImpl
template<int codim, class Grid >
typedef HostGrid::template Codim< 0 >::Entity Dune::GeoGrid::EntityBase< codim, Grid, false >::HostElement

type of host elements, i.e., of host entities of codimension 0

template<int codim, class Grid >
typedef HostGrid::template Codim< codimension >::Entity Dune::GeoGrid::EntityBase< codim, Grid, false >::HostEntity

type of corresponding host entity

template<int codim, class Grid >
typedef HostGrid::template Codim< codimension >::EntityPointer Dune::GeoGrid::EntityBase< codim, Grid, false >::HostEntityPointer

type of corresponding host entity pointer

Constructor & Destructor Documentation

template<int codim, class Grid >
Dune::GeoGrid::EntityBase< codim, Grid, false >::EntityBase ( const Grid grid)
inlineexplicit

construct an uninitialized entity

Parameters
[in]gridGeometryGrid this entity belongs to
Note
The geometry of an uninitialized entity might already be set
template<int codim, class Grid >
Dune::GeoGrid::EntityBase< codim, Grid, false >::EntityBase ( const GeometryImpl geo)
inlineexplicit

construct an uninitialized entity

Parameters
[in]geoalready known geometry this entity will have
Note
The geometry of an uninitialized entity might already be set
template<int codim, class Grid >
Dune::GeoGrid::EntityBase< codim, Grid, false >::EntityBase ( const EntityBase< codim, Grid, false > &  other)
inline

Member Function Documentation

template<int codim, class Grid >
Geometry Dune::GeoGrid::EntityBase< codim, Grid, false >::geometry ( ) const
inline

obtain the geometry of this entity

Each DUNE entity encapsulates a geometry object, representing the map from the reference element to world coordinates. Wrapping the geometry is the main objective of the GeometryGrid.

The GeometryGrid provides geometries of order 1, obtained by interpolation of its corners $y_i$. There corners are calculated from the corners $x_i$ of the host geometry through the GeometryGrid's coordinate function $c$, i.e., $y_i = c( x_i )$.

Returns
a const reference to the geometry
template<int codim, class Grid >
const Grid& Dune::GeoGrid::EntityBase< codim, Grid, false >::grid ( ) const
inline
template<int codim, class Grid >
const HostEntity& Dune::GeoGrid::EntityBase< codim, Grid, false >::hostEntity ( ) const
inline
template<int codim, class Grid >
template<class HostIdSet >
HostIdSet::IdType Dune::GeoGrid::EntityBase< codim, Grid, false >::id ( const HostIdSet &  idSet) const
inline

obtain the entity's id from a host IdSet

template<int codim, class Grid >
template<class HostIndexSet >
HostIndexSet::IndexType Dune::GeoGrid::EntityBase< codim, Grid, false >::index ( const HostIndexSet &  indexSet) const
inline

obtain the entity's index from a host IndexSet

template<int codim, class Grid >
void Dune::GeoGrid::EntityBase< codim, Grid, false >::initialize ( const HostEntity hostEntity)
inline

initiliaze an entity

Parameters
[in]hostEntityreference to the host entity
Note
The reference must remain valid as long as this entity is in use.
template<int codim, class Grid >
template<class HostIndexSet >
bool Dune::GeoGrid::EntityBase< codim, Grid, false >::isContained ( const HostIndexSet &  indexSet) const
inline

check whether the entity is contained in a host index set

template<int codim, class Grid >
int Dune::GeoGrid::EntityBase< codim, Grid, false >::level ( ) const
inline

obtain the level of this entity

template<int codim, class Grid >
Dune::GeoGrid::EntityBase< codim, Grid, false >::operator bool ( ) const
inline
template<int codim, class Grid >
const EntityBase& Dune::GeoGrid::EntityBase< codim, Grid, false >::operator= ( const EntityBase< codim, Grid, false > &  other)
inline
template<int codim, class Grid >
PartitionType Dune::GeoGrid::EntityBase< codim, Grid, false >::partitionType ( ) const
inline

obtain the partition type of this entity

template<int codim, class Grid >
EntitySeed Dune::GeoGrid::EntityBase< codim, Grid, false >::seed ( ) const
inline

return EntitySeed of host grid entity

References seed().

Referenced by seed().

template<int codim, class Grid >
template<class HostIndexSet >
HostIndexSet::IndexType Dune::GeoGrid::EntityBase< codim, Grid, false >::subIndex ( const HostIndexSet &  indexSet,
int  i,
unsigned int  cd 
) const
inline

obtain the index of a subentity from a host IndexSet

template<int codim, class Grid >
unsigned int Dune::GeoGrid::EntityBase< codim, Grid, false >::topologyId ( ) const
inline
template<int codim, class Grid >
GeometryType Dune::GeoGrid::EntityBase< codim, Grid, false >::type ( ) const
inline

obtain the name of the corresponding reference element

This type can be used to access the DUNE reference element.

Member Data Documentation

template<int codim, class Grid >
const int Dune::GeoGrid::EntityBase< codim, Grid, false >::codimension = codim
static

codimensioon of the entity

template<int codim, class Grid >
const int Dune::GeoGrid::EntityBase< codim, Grid, false >::dimension = Traits::dimension
static

dimension of the grid

template<int codim, class Grid >
const int Dune::GeoGrid::EntityBase< codim, Grid, false >::dimensionworld = Traits::dimensionworld
static

dimension of the world

template<int codim, class Grid >
const bool Dune::GeoGrid::EntityBase< codim, Grid, false >::fake = false
static

true, if the entity is faked, i.e., if there is no corresponding host entity

template<int codim, class Grid >
const int Dune::GeoGrid::EntityBase< codim, Grid, false >::mydimension = dimension - codimension
static

dimension of the entity


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