dune-grid  2.3.1
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
Dune::EntityIterator< codim, Grid, IteratorImp > Class Template Reference

interface class for an iterator over grid entitiesAn entity iterator is an iterator over a subset of entities within a hierarchical grid. It is an extension of the Dune::EntityPointer interface. More...

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

Inheritance diagram for Dune::EntityIterator< codim, Grid, IteratorImp >:
Inheritance graph

Public Types

typedef Grid::template Codim
< codim >::Entity 
Entity
 
enum  
 codimension of entity pointer More...
 
enum  
 

Public Member Functions

EntityIteratoroperator++ ()
 prefix increment operator More...
 
Implementor's interface
 EntityIterator (const IteratorImp &imp)
 copy constructor from implementaton More...
 
Dereferencing
Entityoperator* () const
 Dereferencing operator. More...
 
Entityoperator-> () const
 Pointer operator. More...
 
Compare methods
bool operator== (const EntityPointer< Grid, 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. More...
 
bool operator!= (const EntityPointer< Grid, 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. More...
 
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. More...
 
Implementor interface
bool equals (const EntityPointer< Grid, ItImp > &rhs) const
 Forward equality check to realIterator. More...
 

Protected Types

typedef IteratorImp Implementation
 

Protected Member Functions

Implementationimpl ()
 return reference to the real implementation More...
 
const Implementationimpl () const
 return reference to the real implementation More...
 

Protected Attributes

Implementation realIterator
 

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. It is an extension of the Dune::EntityPointer interface.

Examples of entity iterators are:

See also the documentation of Dune::EntityPointer.

Template Parameters
codimcodimension of entities this iterator walks over
Gridtype of the grid implementation
IteratorImptype of the iterator implementation

Member Typedef Documentation

template<int codim, class Grid, class IteratorImp>
typedef Grid::template Codim< codim >::Entity Dune::EntityIterator< codim, Grid, IteratorImp >::Entity
typedef IteratorImp Dune::EntityPointer< Grid , IteratorImp >::Implementation
protectedinherited

Member Enumeration Documentation

anonymous enum
inherited

codimension of entity pointer

anonymous enum
inherited

Constructor & Destructor Documentation

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

copy constructor from implementaton

Member Function Documentation

bool Dune::EntityPointer< Grid , IteratorImp >::equals ( const EntityPointer< Grid , ItImp > &  rhs) const
inlineinherited

Forward equality check to realIterator.

References Dune::EntityPointer< GridImp, IteratorImp >::realIterator.

Implementation& Dune::EntityPointer< Grid , IteratorImp >::impl ( )
inlineprotectedinherited

return reference to the real implementation

References Dune::EntityPointer< GridImp, IteratorImp >::realIterator.

const Implementation& Dune::EntityPointer< Grid , IteratorImp >::impl ( ) const
inlineprotectedinherited

return reference to the real implementation

References Dune::EntityPointer< GridImp, IteratorImp >::realIterator.

int Dune::EntityPointer< Grid , IteratorImp >::level ( ) const
inlineinherited

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.

References Dune::EntityPointer< GridImp, IteratorImp >::realIterator.

bool Dune::EntityPointer< Grid , IteratorImp >::operator!= ( const EntityPointer< Grid , ItImp > &  rhs) const
inlineinherited

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.

References Dune::EntityPointer< GridImp, IteratorImp >::equals().

Entity& Dune::EntityPointer< Grid , IteratorImp >::operator* ( ) const
inlineinherited

Dereferencing operator.

References Dune::EntityPointer< GridImp, IteratorImp >::realIterator.

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

prefix increment operator

Entity* Dune::EntityPointer< Grid , IteratorImp >::operator-> ( ) const
inlineinherited
bool Dune::EntityPointer< Grid , IteratorImp >::operator== ( const EntityPointer< Grid , ItImp > &  rhs) const
inlineinherited

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.

References Dune::EntityPointer< GridImp, IteratorImp >::equals().

Member Data Documentation

Implementation Dune::EntityPointer< Grid , IteratorImp >::realIterator
protectedinherited

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