dune-grid  2.3beta2
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
Dune::LevelIterator< codim, pitype, GridImp, LevelIteratorImp > Class Template Reference

Enables iteration over all entities of a given codimension and level of a grid. See also the documentation of Dune::EntityPointer. More...

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

Inheritance diagram for Dune::LevelIterator< codim, pitype, GridImp, LevelIteratorImp >:
Inheritance graph

Public Types

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

Public Member Functions

LevelIteratoroperator++ ()
 Preincrement operator.
Dereferencing
Entityoperator* () const
 Dereferencing operator.
Entityoperator-> () 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 Types

typedef LevelIteratorImp
< codim, pitype, GridImp > 
Implementation

Protected Member Functions

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

Protected Attributes

Implementation realIterator

Detailed Description

template<int codim, PartitionIteratorType pitype, class GridImp, template< int, PartitionIteratorType, class > class LevelIteratorImp>
class Dune::LevelIterator< codim, pitype, GridImp, LevelIteratorImp >

Enables iteration over all entities of a given codimension and level of a grid. See also the documentation of Dune::EntityPointer.

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

Member Typedef Documentation

typedef GridImp ::template Codim< codim >::Entity Dune::EntityIterator< codim, GridImp , LevelIteratorImp< codim, pitype, GridImp > >::Entity
inherited
typedef LevelIteratorImp< codim, pitype, GridImp > Dune::EntityPointer< GridImp, LevelIteratorImp< codim, pitype, GridImp > >::Implementation
protectedinherited

Member Enumeration Documentation

anonymous enum
inherited

codimension of entity pointer

anonymous enum
inherited

Member Function Documentation

bool Dune::EntityPointer< GridImp, LevelIteratorImp< codim, pitype, GridImp > >::equals ( const EntityPointer< GridImp, ItImp > &  rhs) const
inlineinherited

Forward equality check to realIterator.

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

Implementation& Dune::EntityPointer< GridImp, LevelIteratorImp< codim, pitype, GridImp > >::impl ( )
inlineprotectedinherited

return reference to the real implementation

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

const Implementation& Dune::EntityPointer< GridImp, LevelIteratorImp< codim, pitype, GridImp > >::impl ( ) const
inlineprotectedinherited

return reference to the real implementation

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

int Dune::EntityPointer< GridImp, LevelIteratorImp< codim, pitype, GridImp > >::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< GridImp, LevelIteratorImp< codim, pitype, GridImp > >::operator!= ( const EntityPointer< GridImp, 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< GridImp, LevelIteratorImp< codim, pitype, GridImp > >::operator* ( ) const
inlineinherited

Dereferencing operator.

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

template<int codim, PartitionIteratorType pitype, class GridImp , template< int, PartitionIteratorType, class > class LevelIteratorImp>
LevelIterator& Dune::LevelIterator< codim, pitype, GridImp, LevelIteratorImp >::operator++ ( )
inline

Preincrement operator.

Note
Forwarded to LevelIteratorImp.increment()

Reimplemented from Dune::EntityIterator< codim, GridImp, LevelIteratorImp< codim, pitype, GridImp > >.

Entity* Dune::EntityPointer< GridImp, LevelIteratorImp< codim, pitype, GridImp > >::operator-> ( ) const
inlineinherited
bool Dune::EntityPointer< GridImp, LevelIteratorImp< codim, pitype, GridImp > >::operator== ( const EntityPointer< GridImp, 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< GridImp, LevelIteratorImp< codim, pitype, GridImp > >::realIterator
protectedinherited

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