Dune::GeoGrid::EntityBase< codim, Grid, true > Class Template Reference

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

List of all members.

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

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 = true
 true, if the entity is faked, i.e., if there is no corresponding host entity

Construction, Initialization and Destruction



 EntityBase (const Grid &grid, const HostElement &hostElement, int subEntity)
 construct an initialized 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
const Geometrygeometry () const
EntitySeed seed () const
 return EntitySeed of host grid entity

Methods Supporting the Grid Implementation



const Gridgrid () const
const HostEntityhostEntity () const
const HostElementhostElement () const
int subEntity () const
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, true >

construct an initialized entity

Parameters:
[in] grid GeometryGrid this entity belongs to
[in] hostElement any host element containing the corresponding host entity
[in] subEntity number of this entity within the host element
Note:
Both references must remain valid as long as this entity is in use.

This specialization implements the case, where the host grid does not provide the entity for this codimension, i.e., fake = true.


Member Typedef Documentation

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

coordinate type of the grid

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

type of corresponding entity seed

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

type of corresponding geometry

template<int codim, class Grid >
typedef HostGrid::template Codim< 0 >::Entity Dune::GeoGrid::EntityBase< codim, Grid, true >::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, true >::HostEntity

type of corresponding host entity

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

type of corresponding host entity pointer


Constructor & Destructor Documentation

template<int codim, class Grid >
Dune::GeoGrid::EntityBase< codim, Grid, true >::EntityBase ( const Grid grid,
const HostElement hostElement,
int  subEntity 
) [inline]

construct an initialized entity

Parameters:
[in] grid GeometryGrid this entity belongs to
[in] hostElement any host element containing the corresponding host entity
[in] subEntity number of this entity within the host element
Note:
Both references must remain valid as long as this entity is in use.
template<int codim, class Grid >
Dune::GeoGrid::EntityBase< codim, Grid, true >::EntityBase ( const EntityBase< codim, Grid, true > &  other  )  [inline]

Member Function Documentation

template<int codim, class Grid >
const Geometry& Dune::GeoGrid::EntityBase< codim, Grid, true >::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, true >::grid (  )  const [inline]
template<int codim, class Grid >
const HostElement& Dune::GeoGrid::EntityBase< codim, Grid, true >::hostElement (  )  const [inline]
template<int codim, class Grid >
const HostEntity& Dune::GeoGrid::EntityBase< codim, Grid, true >::hostEntity (  )  const [inline]
template<int codim, class Grid >
template<class HostIdSet >
HostIdSet::IdType Dune::GeoGrid::EntityBase< codim, Grid, true >::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, true >::index ( const HostIndexSet &  indexSet  )  const [inline]

obtain the entity's index from a host IndexSet

template<int codim, class Grid >
template<class HostIndexSet >
bool Dune::GeoGrid::EntityBase< codim, Grid, true >::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, true >::level (  )  const [inline]

obtain the level of this entity

template<int codim, class Grid >
PartitionType Dune::GeoGrid::EntityBase< codim, Grid, true >::partitionType (  )  const [inline]

obtain the partition type of this entity

References Dune::BorderEntity, Dune::FrontEntity, and Dune::GenericReferenceElement< ctype, dim >::size().

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

return EntitySeed of host grid entity

References seed().

Referenced by seed().

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

obtain the index of a subentity from a host IndexSet

References Dune::GenericReferenceElement< ctype, dim >::subEntity().

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

obtain the name of the corresponding reference element

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

References Dune::GenericReferenceElement< ctype, dim >::type().


Member Data Documentation

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

codimensioon of the entity

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

dimension of the grid

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

dimension of the world

template<int codim, class Grid >
const bool Dune::GeoGrid::EntityBase< codim, Grid, true >::fake = true [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, true >::mydimension = dimension - codimension [static]

dimension of the entity


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

Generated on Fri Apr 29 2011 with Doxygen (ver 1.7.1) [doxygen-log,error-log].