dune-grid 2.9.0
Classes | Public Types | Public Member Functions | Static Public Attributes | List of all members
Dune::YaspEntity< 0, dim, GridImp > Class Template Reference

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

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

Classes

struct  Codim
 

Public Types

typedef GridImp::ctype ctype
 
typedef GridImp::YGridLevelIterator YGLI
 
typedef GridImp::YGrid::Iterator I
 
typedef GridImp::template Codim< 0 >::Geometry Geometry
 
typedef GridImp::template Codim< 0 >::LocalGeometry LocalGeometry
 
typedef GridImp::template Codim< 0 >::Entity Entity
 
typedef GridImp::template Codim< 0 >::EntitySeed EntitySeed
 
typedef GridImp::LevelIntersectionIterator IntersectionIterator
 
typedef GridImp::LevelIntersectionIterator LevelIntersectionIterator
 
typedef GridImp::LeafIntersectionIterator LeafIntersectionIterator
 
typedef GridImp::HierarchicIterator HierarchicIterator
 
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 (const YGLI &g, 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...
 
PartitionType partitionType () const
 return partition type attribute More...
 
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...
 
template<int cc>
int count () const
 
unsigned int subEntities (unsigned int codim) const
 
template<int cc>
Codim< cc >::Entity subEntity (int i) const
 
Entity father () const
 Inter-level access to father element on coarser grid. Assumes that meshes are nested. More...
 
bool hasFather () const
 returns true if father entity exists More...
 
LocalGeometry geometryInFather () const
 
const I & transformingsubiterator () const
 
const YGLI & gridlevel () const
 
I & transformingsubiterator ()
 
YGLI & gridlevel ()
 
const GridImp * yaspgrid () const
 
bool isLeaf () const
 
bool isNew () const
 Returns true, if the entity has been created during the last call to adapt() More...
 
bool mightVanish () const
 Returns true, if entity might disappear during the next call to adapt() More...
 
IntersectionIterator ibegin () const
 returns intersection iterator for first intersection More...
 
LeafIntersectionIterator ileafbegin () const
 returns intersection iterator for first intersection More...
 
LevelIntersectionIterator ilevelbegin () const
 returns intersection iterator for first intersection More...
 
IntersectionIterator iend () const
 Reference to one past the last neighbor. More...
 
LeafIntersectionIterator ileafend () const
 Reference to one past the last neighbor. More...
 
LevelIntersectionIterator ilevelend () const
 Reference to one past the last neighbor. More...
 
HierarchicIterator hbegin (int maxlevel) const
 
HierarchicIterator hend (int) const
 Returns iterator to one past the last son. More...
 

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

Member Typedef Documentation

◆ ctype

template<int dim, class GridImp >
typedef GridImp::ctype Dune::YaspEntity< 0, dim, GridImp >::ctype

◆ Entity

template<int dim, class GridImp >
typedef GridImp::template Codim<0>::Entity Dune::YaspEntity< 0, dim, GridImp >::Entity

◆ EntitySeed

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

◆ Geometry

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

◆ HierarchicIterator

template<int dim, class GridImp >
typedef GridImp::HierarchicIterator Dune::YaspEntity< 0, dim, GridImp >::HierarchicIterator

◆ I

template<int dim, class GridImp >
typedef GridImp::YGrid::Iterator Dune::YaspEntity< 0, dim, GridImp >::I

◆ IntersectionIterator

template<int dim, class GridImp >
typedef GridImp::LevelIntersectionIterator Dune::YaspEntity< 0, dim, GridImp >::IntersectionIterator

◆ iTupel

template<int dim, class GridImp >
typedef GridImp::YGrid::iTupel Dune::YaspEntity< 0, dim, GridImp >::iTupel

define type used for coordinates in grid module

◆ LeafIntersectionIterator

template<int dim, class GridImp >
typedef GridImp::LeafIntersectionIterator Dune::YaspEntity< 0, dim, GridImp >::LeafIntersectionIterator

◆ LevelIntersectionIterator

template<int dim, class GridImp >
typedef GridImp::LevelIntersectionIterator Dune::YaspEntity< 0, dim, GridImp >::LevelIntersectionIterator

◆ LocalGeometry

template<int dim, class GridImp >
typedef GridImp::template Codim<0>::LocalGeometry Dune::YaspEntity< 0, dim, GridImp >::LocalGeometry

◆ PersistentIndexType

template<int dim, class GridImp >
typedef GridImp::PersistentIndexType Dune::YaspEntity< 0, dim, GridImp >::PersistentIndexType

define the type used for persistent indices

◆ YGLI

template<int dim, class GridImp >
typedef GridImp::YGridLevelIterator Dune::YaspEntity< 0, dim, GridImp >::YGLI

Constructor & Destructor Documentation

◆ YaspEntity() [1/4]

template<int dim, class GridImp >
Dune::YaspEntity< 0, dim, GridImp >::YaspEntity ( )
inline

◆ YaspEntity() [2/4]

template<int dim, class GridImp >
Dune::YaspEntity< 0, dim, GridImp >::YaspEntity ( const YGLI &  g,
const I &  it 
)
inline

◆ YaspEntity() [3/4]

template<int dim, class GridImp >
Dune::YaspEntity< 0, dim, GridImp >::YaspEntity ( const YGLI &  g,
I &&  it 
)
inline

◆ YaspEntity() [4/4]

template<int dim, class GridImp >
Dune::YaspEntity< 0, dim, GridImp >::YaspEntity ( YGLI &&  g,
I &&  it 
)
inline

Member Function Documentation

◆ count()

template<int dim, class GridImp >
template<int cc>
int Dune::YaspEntity< 0, dim, GridImp >::count ( ) const
inline

Return number of subentities with codimension cc.

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

◆ equals()

template<int dim, class GridImp >
bool Dune::YaspEntity< 0, dim, GridImp >::equals ( const YaspEntity< 0, dim, GridImp > &  e) const
inline

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

◆ father()

template<int dim, class GridImp >
Entity Dune::YaspEntity< 0, dim, GridImp >::father ( ) const
inline

Inter-level access to father element on coarser grid. Assumes that meshes are nested.

◆ geometry()

template<int dim, class GridImp >
Geometry Dune::YaspEntity< 0, dim, GridImp >::geometry ( ) const
inline

geometry of this entity

◆ geometryInFather()

template<int dim, class GridImp >
LocalGeometry Dune::YaspEntity< 0, dim, GridImp >::geometryInFather ( ) const
inline

Location of this element relative to the reference element of its father

◆ gridlevel() [1/2]

template<int dim, class GridImp >
YGLI & Dune::YaspEntity< 0, dim, GridImp >::gridlevel ( )
inline

◆ gridlevel() [2/2]

template<int dim, class GridImp >
const YGLI & Dune::YaspEntity< 0, dim, GridImp >::gridlevel ( ) const
inline

◆ hasFather()

template<int dim, class GridImp >
bool Dune::YaspEntity< 0, dim, GridImp >::hasFather ( ) const
inline

returns true if father entity exists

◆ hbegin()

template<int dim, class GridImp >
HierarchicIterator Dune::YaspEntity< 0, dim, GridImp >::hbegin ( int  maxlevel) const
inline

Inter-level access to son elements on higher levels<=maxlevel. This is provided for sparsely stored nested unstructured meshes. Returns iterator to first son.

◆ hend()

template<int dim, class GridImp >
HierarchicIterator Dune::YaspEntity< 0, dim, GridImp >::hend ( int  ) const
inline

Returns iterator to one past the last son.

◆ ibegin()

template<int dim, class GridImp >
IntersectionIterator Dune::YaspEntity< 0, dim, GridImp >::ibegin ( ) const
inline

returns intersection iterator for first intersection

◆ iend()

template<int dim, class GridImp >
IntersectionIterator Dune::YaspEntity< 0, dim, GridImp >::iend ( ) const
inline

Reference to one past the last neighbor.

◆ ileafbegin()

template<int dim, class GridImp >
LeafIntersectionIterator Dune::YaspEntity< 0, dim, GridImp >::ileafbegin ( ) const
inline

returns intersection iterator for first intersection

◆ ileafend()

template<int dim, class GridImp >
LeafIntersectionIterator Dune::YaspEntity< 0, dim, GridImp >::ileafend ( ) const
inline

Reference to one past the last neighbor.

◆ ilevelbegin()

template<int dim, class GridImp >
LevelIntersectionIterator Dune::YaspEntity< 0, dim, GridImp >::ilevelbegin ( ) const
inline

returns intersection iterator for first intersection

◆ ilevelend()

template<int dim, class GridImp >
LevelIntersectionIterator Dune::YaspEntity< 0, dim, GridImp >::ilevelend ( ) const
inline

Reference to one past the last neighbor.

◆ isLeaf()

template<int dim, class GridImp >
bool Dune::YaspEntity< 0, dim, GridImp >::isLeaf ( ) const
inline

◆ isNew()

template<int dim, class GridImp >
bool Dune::YaspEntity< 0, dim, GridImp >::isNew ( ) const
inline

Returns true, if the entity has been created during the last call to adapt()

◆ level()

template<int dim, class GridImp >
int Dune::YaspEntity< 0, dim, GridImp >::level ( ) const
inline

level of this element

◆ mightVanish()

template<int dim, class GridImp >
bool Dune::YaspEntity< 0, dim, GridImp >::mightVanish ( ) const
inline

Returns true, if entity might disappear during the next call to adapt()

◆ partitionType()

template<int dim, class GridImp >
PartitionType Dune::YaspEntity< 0, dim, GridImp >::partitionType ( ) const
inline

return partition type attribute

◆ seed()

template<int dim, class GridImp >
EntitySeed Dune::YaspEntity< 0, 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.

◆ subEntities()

template<int dim, class GridImp >
unsigned int Dune::YaspEntity< 0, dim, GridImp >::subEntities ( unsigned int  codim) const
inline

Return number of subentities with codimension cc.

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

◆ subEntity()

template<int dim, class GridImp >
template<int cc>
Codim< cc >::Entity Dune::YaspEntity< 0, dim, GridImp >::subEntity ( int  i) const
inline

Intra-element access to subentities of codimension cc > codim.

◆ transformingsubiterator() [1/2]

template<int dim, class GridImp >
I & Dune::YaspEntity< 0, dim, GridImp >::transformingsubiterator ( )
inline

◆ transformingsubiterator() [2/2]

template<int dim, class GridImp >
const I & Dune::YaspEntity< 0, dim, GridImp >::transformingsubiterator ( ) const
inline

◆ type()

template<int dim, class GridImp >
constexpr GeometryType Dune::YaspEntity< 0, 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< 0, dim, GridImp >::yaspgrid ( ) const
inline

Member Data Documentation

◆ 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:
Generated by doxygen 1.9.4