Dune Core Modules (2.3.1)

Dune::HierarchicIterator< GridImp, HierarchicIteratorImp > Class Template Reference

Enables iteration over all codim zero entities in a subtree See also the documentation of Dune::EntityPointer. More...

#include <dune/grid/common/hierarchiciterator.hh>

Public Types

enum  
 codimension of entity pointer
 

Public Member Functions

HierarchicIteratoroperator++ ()
 Preincrement operator. More...
 
Dereferencing
Entity & operator* () const
 Dereferencing operator.
 
Entity * operator-> () const
 Pointer operator.
 
Compare methods
bool operator== (const EntityPointer< GridImp, ItImp > &rhs) const
 Checks for equality. Only works for EntityPointers and iterators on the same grid. Due to the conversion operators one can compare all kinds of iterators and EntityPointer.
 
bool operator!= (const EntityPointer< GridImp, ItImp > &rhs) const
 Checks for inequality. Only works for EntityPointers and iterators on the same grid. Due to the conversion operators one can compare all kinds of iterators and EntityPointer.
 
Query methods
int level () const
 Ask for level of entity. This method is redundant and is only there for efficiency reasons. It allows an implementation to return the level without actually constructing the entity.
 
Implementor interface
bool equals (const EntityPointer< GridImp, ItImp > &rhs) const
 Forward equality check to realIterator.
 

Protected Member Functions

Implementation & impl ()
 return reference to the real implementation
 
const Implementation & impl () const
 return reference to the real implementation
 

Detailed Description

template<class GridImp, template< class > class HierarchicIteratorImp>
class Dune::HierarchicIterator< GridImp, HierarchicIteratorImp >

Enables iteration over all codim zero entities in a subtree See also the documentation of Dune::EntityPointer.

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. This is redundant but important for memory efficient implementations of unstructured hierarchically refined meshes.

Note
The HierarchicIterator interface is deprecated. Use the EntityIterator interface instead.

Member Function Documentation

◆ operator++()

template<class GridImp , template< class > class HierarchicIteratorImp>
HierarchicIterator & Dune::HierarchicIterator< GridImp, HierarchicIteratorImp >::operator++ ( )
inline

Preincrement operator.

Note
Forwarded to LevelIteratorImp.increment()

The documentation for this class was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Nov 12, 23:30, 2024)