dune-grid: Dune::YaspEntity< dim, dim, GridImp > Class Template Reference

dune-grid 2.9.0

#include <dune/grid/yaspgrid/yaspgridentity.hh>

Inheritance diagram for Dune::YaspEntity< dim, dim, GridImp >:

Inheritance graph

Public Types
typedef GridImp::ctype	ctype

typedef GridImp::YGridLevelIterator	YGLI

typedef GridImp::YGrid::Iterator	I

typedef GridImp::template Codim< dim >::Geometry	Geometry

typedef GridImp::template Codim< dim >::EntitySeed	EntitySeed

typedef GridImp::PersistentIndexType	PersistentIndexType
	define the type used for persistent indices More...

typedef GridImp::YGrid::iTupel	iTupel
	define type used for coordinates in grid module More...

Public Member Functions
	YaspEntity ()

	YaspEntity (const YGLI &g, const I &it)

	YaspEntity (YGLI &&g, I &&it)

bool	equals (const YaspEntity &e) const
	Return true when two iterators over the same grid are equal (!). More...

int	level () const
	level of this element More...

EntitySeed	seed () const
	Return the entity seed which contains sufficient information to generate the entity again and uses as little memory as possible. More...

unsigned int	subEntities (unsigned int cc) const

Geometry	geometry () const
	geometry of this entity More...

constexpr GeometryType	type () const
	Return the name of the reference element. The type can be used to access the Dune::ReferenceElement. More...

PartitionType	partitionType () const
	return partition type attribute More...

int	subCompressedIndex (int, unsigned int) const
	subentity compressed index simply returns compressedIndex More...

const I &	transformingsubiterator () const

const YGLI &	gridlevel () const

I &	transformingsubiterator ()

YGLI &	gridlevel ()

const GridImp *	yaspgrid () const

Static Public Attributes
static constexpr int	codimension
	know your own codimension More...

static constexpr int	dimension
	Dimension of the grid. More...

static constexpr int	mydimension
	Know dimension of the entity. More...

Protected Attributes
I	_it = {}

YGLI	_g = {}

Member Typedef Documentation

◆ ctype

template<int dim, class GridImp >

typedef GridImp::ctype Dune::YaspEntity< dim, dim, GridImp >::ctype

◆ EntitySeed

template<int dim, class GridImp >

typedef GridImp::template Codim<dim>::EntitySeed Dune::YaspEntity< dim, dim, GridImp >::EntitySeed

◆ Geometry

template<int dim, class GridImp >

typedef GridImp::template Codim<dim>::Geometry Dune::YaspEntity< dim, dim, GridImp >::Geometry

◆ I

template<int dim, class GridImp >

typedef GridImp::YGrid::Iterator Dune::YaspEntity< dim, dim, GridImp >::I

◆ iTupel

template<int dim, class GridImp >

typedef GridImp::YGrid::iTupel Dune::YaspEntity< dim, dim, GridImp >::iTupel

define type used for coordinates in grid module

◆ PersistentIndexType

template<int dim, class GridImp >

typedef GridImp::PersistentIndexType Dune::YaspEntity< dim, dim, GridImp >::PersistentIndexType

define the type used for persistent indices

◆ YGLI

template<int dim, class GridImp >

typedef GridImp::YGridLevelIterator Dune::YaspEntity< dim, dim, GridImp >::YGLI

Constructor & Destructor Documentation

◆ YaspEntity() [1/3]

template<int dim, class GridImp >

Dune::YaspEntity< dim, dim, GridImp >::YaspEntity ( )

inline

◆ YaspEntity() [2/3]

template<int dim, class GridImp >

Dune::YaspEntity< dim, dim, GridImp >::YaspEntity	(	const YGLI &	g,
		const I &	it
	)

inline

◆ YaspEntity() [3/3]

template<int dim, class GridImp >

Dune::YaspEntity< dim, dim, GridImp >::YaspEntity	(	YGLI &&	g,
		I &&	it
	)

inline

Member Function Documentation

◆ equals()

template<int dim, class GridImp >

bool Dune::YaspEntity< dim, dim, GridImp >::equals ( const YaspEntity< dim, dim, GridImp > & e ) const

inline

Return true when two iterators over the same grid are equal (!).

◆ geometry()

template<int dim, class GridImp >

Geometry Dune::YaspEntity< dim, dim, GridImp >::geometry ( ) const

inline

geometry of this entity

◆ gridlevel() [1/2]

template<int dim, class GridImp >

YGLI & Dune::YaspEntity< dim, dim, GridImp >::gridlevel ( )

inline

◆ gridlevel() [2/2]

template<int dim, class GridImp >

const YGLI & Dune::YaspEntity< dim, dim, GridImp >::gridlevel ( ) const

inline

◆ level()

template<int dim, class GridImp >

int Dune::YaspEntity< dim, dim, GridImp >::level ( ) const

inline

level of this element

◆ partitionType()

template<int dim, class GridImp >

PartitionType Dune::YaspEntity< dim, dim, GridImp >::partitionType ( ) const

inline

return partition type attribute

◆ seed()

template<int dim, class GridImp >

EntitySeed Dune::YaspEntity< dim, dim, GridImp >::seed ( ) const

inline

Return the entity seed which contains sufficient information to generate the entity again and uses as little memory as possible.

◆ subCompressedIndex()

template<int dim, class GridImp >

int Dune::YaspEntity< dim, dim, GridImp >::subCompressedIndex	(	int	,
		unsigned int
	)		const

inline

subentity compressed index simply returns compressedIndex

◆ subEntities()

template<int dim, class GridImp >

unsigned int Dune::YaspEntity< dim, dim, GridImp >::subEntities ( unsigned int cc ) const

inline

Return number of subentities with codimension cc.

That number is (dim over (dim-codim)) times 2^codim

◆ transformingsubiterator() [1/2]

template<int dim, class GridImp >

I & Dune::YaspEntity< dim, dim, GridImp >::transformingsubiterator ( )

inline

◆ transformingsubiterator() [2/2]

template<int dim, class GridImp >

const I & Dune::YaspEntity< dim, dim, GridImp >::transformingsubiterator ( ) const

inline

◆ type()

template<int dim, class GridImp >

constexpr GeometryType Dune::YaspEntity< dim, dim, GridImp >::type ( ) const

inlineconstexpr

Return the name of the reference element. The type can be used to access the Dune::ReferenceElement.

◆ yaspgrid()

template<int dim, class GridImp >

const GridImp * Dune::YaspEntity< dim, dim, GridImp >::yaspgrid ( ) const

inline

Member Data Documentation

◆ _g

template<int dim, class GridImp >

YGLI Dune::YaspEntity< dim, dim, GridImp >::_g = {}

protected

◆ _it

template<int dim, class GridImp >

I Dune::YaspEntity< dim, dim, GridImp >::_it = {}

protected

◆ codimension

constexpr int Dune::EntityDefaultImplementation< cd, dim, GridImp, YaspEntity >::codimension

staticconstexprinherited

know your own codimension

◆ dimension

constexpr int Dune::EntityDefaultImplementation< cd, dim, GridImp, YaspEntity >::dimension

staticconstexprinherited

Dimension of the grid.

◆ mydimension

constexpr int Dune::EntityDefaultImplementation< cd, dim, GridImp, YaspEntity >::mydimension

staticconstexprinherited

Know dimension of the entity.

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

yaspgridentity.hh