Dune Core Modules (2.5.2)
actual implementation of the entity More...
#include <dune/grid/geometrygrid/entity.hh>
Public Member Functions | |
bool | equals (const EntityBase &other) const |
compare two entities | |
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 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 () | |
EntityBase (const Grid &grid, const HostElement &hostElement, unsigned int subEntity) | |
EntityBase (const Grid &grid, const EntitySeed &seed) | |
EntityBase (const EntityBase &other) | |
EntityBase (EntityBase &&other) | |
EntityBase (const Grid &grid, const HostEntity &hostEntity) | |
Methods Shared by Entities of All Codimensions | |
GeometryType | type () const |
obtain the name of the corresponding reference element More... | |
int | level () const |
obtain the level of this entity | |
PartitionType | partitionType () const |
obtain the partition type of this entity | |
Geometry | geometry () const |
unsigned int | subEntities (unsigned int cc) const |
EntitySeed | seed () const |
return EntitySeed of host grid entity | |
Methods Supporting the Grid Implementation | |
const Grid & | grid () const |
const HostEntity & | hostEntity () const |
const HostElement & | hostElement () const |
int | subEntity () const |
void | initialize (const HostElement &hostElement) |
initiliaze an entity More... | |
template<class HostIndexSet > | |
HostIndexSet::IndexType | index (const HostIndexSet &indexSet) const |
obtain the entity's index from a host IndexSet More... | |
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 More... | |
template<class HostIndexSet > | |
bool | isContained (const HostIndexSet &indexSet) const |
check whether the entity is contained in a host index set More... | |
template<class HostIdSet > | |
HostIdSet::IdType | id (const HostIdSet &idSet) const |
obtain the entity's id from a host IdSet More... | |
Detailed Description
template<int codim, class Grid>
class Dune::GeoGrid::EntityBase< codim, Grid, true >
actual implementation of the entity
- Template Parameters
-
codim codimension of the entity Grid GeometryGrid, this entity belongs to fake true, if the host grid does not provide this entity (do not specify, the default value is already the intended use)
This specialization implements the case, where the host grid does not provide the entity for this codimension, i.e., fake = true.
Member Function Documentation
◆ geometry()
|
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 geometry object
◆ id()
|
inline |
◆ index()
|
inline |
◆ initialize()
|
inline |
initiliaze an entity
- Parameters
-
[in] hostElement reference to the host element
- Note
- The reference must remain valid as long as this entity is in use.
◆ isContained()
|
inline |
check whether the entity is contained in a host index set
This method is provided by the entity, because its implementation is different for fake and non-fake entities.
- Parameters
-
indexSet host IndexSet to use
◆ subIndex()
|
inline |
obtain the index of a subentity from a host IndexSet
This method is provided by the entity, because its implementation is different for fake and non-fake entities.
- Parameters
-
[in] indexSet host IndexSet to use [in] i number of the subentity [in] cd codimension of the subentity
References Dune::ReferenceElements< ctype, dim >::general(), and Dune::ReferenceElement< ctype, dim >::subEntity().
◆ type()
|
inline |
obtain the name of the corresponding reference element
This type can be used to access the DUNE reference element.
References Dune::ReferenceElements< ctype, dim >::general(), and Dune::ReferenceElement< ctype, dim >::type().
The documentation for this class was generated from the following file:
- dune/grid/geometrygrid/entity.hh