dune-foamgrid 2.8.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
Dune::FoamGridHierarchicIterator< 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/foamgrid/foamgrid/foamgridhierarchiciterator.hh>

Public Types

enum  { codimension = 0 }
 We only iterate over elements with this iterator. More...
 
using Entity = typename GridImp::template Codim< 0 >::Entity
 

Public Member Functions

 FoamGridHierarchicIterator (EntityImpPointer target, int maxLevel)
 Constructor with element impl (begin iterator)
 
 FoamGridHierarchicIterator (int maxLevel)
 Constructor without valid element (end iterator)
 
void increment ()
 
const Entitydereference () const
 dereferencing
 
bool equals (const FoamGridHierarchicIterator< GridImp > &other) const
 equality
 

Detailed Description

template<class GridImp>
class Dune::FoamGridHierarchicIterator< 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 >
using Dune::FoamGridHierarchicIterator< GridImp >::Entity = typename GridImp::template Codim<0>::Entity

Member Enumeration Documentation

◆ anonymous enum

template<class GridImp >
anonymous enum

We only iterate over elements with this iterator.

Enumerator
codimension 

Constructor & Destructor Documentation

◆ FoamGridHierarchicIterator() [1/2]

template<class GridImp >
Dune::FoamGridHierarchicIterator< GridImp >::FoamGridHierarchicIterator ( EntityImpPointer  target,
int  maxLevel 
)
inline

Constructor with element impl (begin iterator)

◆ FoamGridHierarchicIterator() [2/2]

template<class GridImp >
Dune::FoamGridHierarchicIterator< GridImp >::FoamGridHierarchicIterator ( int  maxLevel)
inline

Constructor without valid element (end iterator)

Member Function Documentation

◆ dereference()

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

dereferencing

◆ equals()

template<class GridImp >
bool Dune::FoamGridHierarchicIterator< GridImp >::equals ( const FoamGridHierarchicIterator< GridImp > &  other) const
inline

equality

◆ increment()

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

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