DUNE-FEM (unstable)

Dune::EntityIterator< codim, Grid, IteratorImp > Class Template Reference

interface class for an iterator over grid entities More...

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

Public Types

typedef IteratorImp Implementation
 type of underlying implementation More...
 
typedef std::conditional< std::is_lvalue_reference< decltype(realIterator.dereference())>::value, constEntity &, Entity >::type Reference
 Type of the reference used when dereferencing the Ptr.
 

Public Member Functions

Implementationimpl ()
 access to the underlying implementation More...
 
const Implementationimpl () const
 access to the underlying implementation More...
 
EntityIteratoroperator++ ()
 prefix increment operator
 
EntityIterator operator++ (int)
 postfix increment operator
 
const Entity & operator* () const
 Dereferencing operator.
 
const Entity & operator-> () const
 Pointer operator.
 
bool operator== (const EntityIterator &rhs) const
 Checks for equality.
 
bool operator!= (const EntityIterator &rhs) const
 Checks for inequality.
 
Implementor's interface
 EntityIterator ()
 default construct (undefined) iterator
 
 EntityIterator (const IteratorImp &imp)
 copy constructor from implementation
 

Detailed Description

template<int codim, class Grid, class IteratorImp>
class Dune::EntityIterator< codim, Grid, IteratorImp >

interface class for an iterator over grid entities

An entity iterator is an iterator over a subset of entities within a hierarchical grid.

Examples of entity iterators are:

  • iterators over the leaf level (LeafGridView::Iterator)
  • iterators over a grid level (LevelGridView::Iterator)
  • iterators over the children of an entity (Grid::HierarchicIterator)
Template Parameters
codimcodimension of entities this iterator walks over
Gridtype of the grid implementation
IteratorImptype of the iterator implementation

Member Typedef Documentation

◆ Implementation

template<int codim, class Grid , class IteratorImp >
typedef IteratorImp Dune::EntityIterator< codim, Grid, IteratorImp >::Implementation

type of underlying implementation

Warning
Implementation details may change without prior notification.

Member Function Documentation

◆ impl() [1/2]

template<int codim, class Grid , class IteratorImp >
Implementation & Dune::EntityIterator< codim, Grid, IteratorImp >::impl ( )
inline

access to the underlying implementation

Warning
Implementation details may change without prior notification.

◆ impl() [2/2]

template<int codim, class Grid , class IteratorImp >
const Implementation & Dune::EntityIterator< codim, Grid, IteratorImp >::impl ( ) const
inline

access to the underlying implementation

Warning
Implementation details may change without prior notification.

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 20, 23:30, 2024)