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

Public Types
typedef Traits::template Codim< codimension >::GeometryImpl	GeometryImpl

Public Member Functions
const EntityBase &	operator= (const EntityBase &other)

const EntityBase &	operator= (EntityBase &&other)

bool	equals (const EntityBase &other) const
	compare two entities More...

Types Required by DUNE
typedef Traits::ctype	ctype
	coordinate type of the grid More...

typedef Traits::template Codim< codimension >::Geometry	Geometry
	type of corresponding geometry More...

Host Types
typedef HostGrid::template Codim< codimension >::Entity	HostEntity
	type of corresponding host entity More...

typedef Traits::template Codim< codimension >::EntitySeed	EntitySeed
	type of corresponding entity seed More...

typedef HostGrid::template Codim< 0 >::Entity	HostElement
	type of host elements, i.e., of host entities of codimension 0 More...

Attributes
static const int	codimension = codim
	codimensioon of the entity More...

static const int	dimension = Traits::dimension
	dimension of the grid More...

static const int	mydimension = dimension - codimension
	dimension of the entity More...

static const int	dimensionworld = Traits::dimensionworld
	dimension of the world More...

static const bool	fake = true
	true, if the entity is faked, i.e., if there is no corresponding host entity More...

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 More...

PartitionType	partitionType () const
	obtain the partition type of this entity More...

Geometry	geometry () const

unsigned int	subEntities (unsigned int cc) const

EntitySeed	seed () const
	return EntitySeed of host grid entity More...

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 >

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

Member Typedef Documentation

◆ ctype

template<int codim, class Grid >

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

coordinate type of the grid

◆ EntitySeed

template<int codim, class Grid >

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

type of corresponding entity seed

◆ Geometry

template<int codim, class Grid >

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

type of corresponding geometry

◆ GeometryImpl

template<int codim, class Grid >

typedef Traits::template Codim<codimension>::GeometryImpl Dune::GeoGrid::EntityBase< codim, Grid, true >::GeometryImpl

◆ HostElement

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

◆ HostEntity

template<int codim, class Grid >

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

type of corresponding host entity

Constructor & Destructor Documentation

◆ EntityBase() [1/6]

template<int codim, class Grid >

Dune::GeoGrid::EntityBase< codim, Grid, true >::EntityBase ( )

inline

◆ EntityBase() [2/6]

template<int codim, class Grid >

Dune::GeoGrid::EntityBase< codim, Grid, true >::EntityBase	(	const Grid &	grid,
		const HostElement &	hostElement,
		unsigned int	subEntity
	)

inline

◆ EntityBase() [3/6]

template<int codim, class Grid >

Dune::GeoGrid::EntityBase< codim, Grid, true >::EntityBase	(	const Grid &	grid,
		const EntitySeed &	seed
	)

inline

◆ EntityBase() [4/6]

template<int codim, class Grid >

Dune::GeoGrid::EntityBase< codim, Grid, true >::EntityBase ( const EntityBase< codim, Grid, true > & other )

inline

◆ EntityBase() [5/6]

template<int codim, class Grid >

Dune::GeoGrid::EntityBase< codim, Grid, true >::EntityBase ( EntityBase< codim, Grid, true > && other )

inline

◆ EntityBase() [6/6]

template<int codim, class Grid >

Dune::GeoGrid::EntityBase< codim, Grid, true >::EntityBase	(	const Grid &	grid,
		const HostEntity &	hostEntity
	)

inline

Member Function Documentation

◆ equals()

template<int codim, class Grid >

bool Dune::GeoGrid::EntityBase< codim, Grid, true >::equals ( const EntityBase< codim, Grid, true > & other ) const

inline

compare two entities

◆ geometry()

template<int codim, class Grid >

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 geometry object

◆ grid()

template<int codim, class Grid >

const Grid & Dune::GeoGrid::EntityBase< codim, Grid, true >::grid ( ) const

inline

◆ hostElement()

template<int codim, class Grid >

const HostElement & Dune::GeoGrid::EntityBase< codim, Grid, true >::hostElement ( ) const

inline

◆ hostEntity()

template<int codim, class Grid >

const HostEntity & Dune::GeoGrid::EntityBase< codim, Grid, true >::hostEntity ( ) const

inline

◆ id()

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

◆ index()

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

◆ initialize()

template<int codim, class Grid >

void Dune::GeoGrid::EntityBase< codim, Grid, true >::initialize ( const HostElement & hostElement )

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()

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

◆ level()

template<int codim, class Grid >

int Dune::GeoGrid::EntityBase< codim, Grid, true >::level ( ) const

inline

obtain the level of this entity

◆ operator=() [1/2]

template<int codim, class Grid >

const EntityBase & Dune::GeoGrid::EntityBase< codim, Grid, true >::operator= ( const EntityBase< codim, Grid, true > & other )

inline

◆ operator=() [2/2]

template<int codim, class Grid >

const EntityBase & Dune::GeoGrid::EntityBase< codim, Grid, true >::operator= ( EntityBase< codim, Grid, true > && other )

inline

◆ partitionType()

template<int codim, class Grid >

PartitionType Dune::GeoGrid::EntityBase< codim, Grid, true >::partitionType ( ) const

inline

obtain the partition type of this entity

◆ seed()

template<int codim, class Grid >

EntitySeed Dune::GeoGrid::EntityBase< codim, Grid, true >::seed ( ) const

inline

return EntitySeed of host grid entity

◆ subEntities()

template<int codim, class Grid >

unsigned int Dune::GeoGrid::EntityBase< codim, Grid, true >::subEntities ( unsigned int cc ) const

inline

◆ subEntity()

template<int codim, class Grid >

int Dune::GeoGrid::EntityBase< codim, Grid, true >::subEntity ( ) const

inline

◆ subIndex()

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

◆ type()

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.

Member Data Documentation

◆ codimension

template<int codim, class Grid >

const int Dune::GeoGrid::EntityBase< codim, Grid, true >::codimension = codim

static

codimensioon of the entity

◆ dimension

template<int codim, class Grid >

const int Dune::GeoGrid::EntityBase< codim, Grid, true >::dimension = Traits::dimension

static

dimension of the grid

◆ dimensionworld

template<int codim, class Grid >

const int Dune::GeoGrid::EntityBase< codim, Grid, true >::dimensionworld = Traits::dimensionworld

static

dimension of the world

◆ fake

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

◆ mydimension

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:

geometrygrid/entity.hh

Public Types

Public Member Functions

Types Required by DUNE

Host Types

Attributes

Construction, Initialization and Destruction

Methods Shared by Entities of All Codimensions

Methods Supporting the Grid Implementation

Detailed Description

Member Typedef Documentation

◆ ctype

◆ EntitySeed

◆ Geometry

◆ GeometryImpl

◆ HostElement

◆ HostEntity

Constructor & Destructor Documentation

◆ EntityBase() [1/6]

◆ EntityBase() [2/6]

◆ EntityBase() [3/6]

◆ EntityBase() [4/6]

◆ EntityBase() [5/6]

◆ EntityBase() [6/6]

Member Function Documentation

◆ equals()

◆ geometry()

◆ grid()

◆ hostElement()

◆ hostEntity()

◆ id()

◆ index()

◆ initialize()

◆ isContained()

◆ level()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ partitionType()

◆ seed()

◆ subEntities()

◆ subEntity()

◆ subIndex()

◆ type()

Member Data Documentation

◆ codimension

◆ dimension

◆ dimensionworld

◆ fake

◆ mydimension