dune-grid 2.9.0
Public Types | Public Member Functions | Static Public Attributes | List of all members
Dune::IdentityGridHierarchicIterator< GridImp > Class Template Reference

Iterator over the descendants of an entity.Mesh entities of codimension 0 ("elements") allow to visit all entities of codimension 0 obtained through nested, hierarchic refinement of the entity. Iteration over this set of entities is provided by the HierarchicIterator, starting from a given entity. More...

#include <dune/grid/identitygrid/identitygridhierarchiciterator.hh>

Public Types

typedef GridImp::template Codim< 0 >::Entity Entity
 

Public Member Functions

 IdentityGridHierarchicIterator (const GridImp *identityGrid, const Entity &startEntity, int maxLevel)
 the default Constructor More...
 
 IdentityGridHierarchicIterator (const GridImp *identityGrid, const Entity &startEntity, int maxLevel, bool endDummy)
 
void increment ()
 
Entity dereference () const
 dereferencing More...
 
bool equals (const IdentityGridHierarchicIterator &i) const
 equality More...
 

Static Public Attributes

static constexpr int codimension = 0
 

Detailed Description

template<class GridImp>
class Dune::IdentityGridHierarchicIterator< GridImp >

Iterator over the descendants of an entity.

Mesh entities of codimension 0 ("elements") allow to visit all entities of codimension 0 obtained through nested, hierarchic refinement of the entity. Iteration over this set of entities is provided by the HierarchicIterator, starting from a given entity.

Member Typedef Documentation

◆ Entity

template<class GridImp >
typedef GridImp::template Codim<0>::Entity Dune::IdentityGridHierarchicIterator< GridImp >::Entity

Constructor & Destructor Documentation

◆ IdentityGridHierarchicIterator() [1/2]

template<class GridImp >
Dune::IdentityGridHierarchicIterator< GridImp >::IdentityGridHierarchicIterator ( const GridImp *  identityGrid,
const Entity startEntity,
int  maxLevel 
)
inlineexplicit

the default Constructor

◆ IdentityGridHierarchicIterator() [2/2]

template<class GridImp >
Dune::IdentityGridHierarchicIterator< GridImp >::IdentityGridHierarchicIterator ( const GridImp *  identityGrid,
const Entity startEntity,
int  maxLevel,
bool  endDummy 
)
inlineexplicit
Todo:
Please doc me !

Member Function Documentation

◆ dereference()

template<class GridImp >
Entity Dune::IdentityGridHierarchicIterator< GridImp >::dereference ( ) const
inline

dereferencing

◆ equals()

template<class GridImp >
bool Dune::IdentityGridHierarchicIterator< GridImp >::equals ( const IdentityGridHierarchicIterator< GridImp > &  i) const
inline

equality

◆ increment()

template<class GridImp >
void Dune::IdentityGridHierarchicIterator< GridImp >::increment ( )
inline
Todo:
Please doc me !

Member Data Documentation

◆ codimension

template<class GridImp >
constexpr int Dune::IdentityGridHierarchicIterator< GridImp >::codimension = 0
staticconstexpr

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