Dune Core Modules (unstable)

Dune::YGridComponent< Coordinates >::Iterator Class Reference

#include <dune/grid/yaspgrid/ygrid.hh>

Public Member Functions

 Iterator (const YGridComponent< Coordinates > &r)
 Make iterator pointing to first cell in a grid.
 
 Iterator (const YGridComponent< Coordinates > &r, const iTupel &coord)
 Make iterator pointing to given cell in a grid.
 
void reinit (const YGridComponent< Coordinates > &r, const iTupel &coord)
 reinitialize iterator to given position
 
bool operator== (const Iterator &i) const
 Return true when two iterators over the same grid are equal (!).
 
bool operator!= (const Iterator &i) const
 Return true when two iterators over the same grid are not equal (!).
 
int superindex () const
 Return consecutive index in enclosing grid.
 
int coord (int i) const
 Return coordinate of the cell in direction i.
 
const iTupel & coord () const
 Return coordinate of the cell as reference (do not modify).
 
void move (int i, int dist)
 move this iterator dist cells in direction i
 
void move (const iTupel &dist)
 move this iterator dist cells in direction i
 
Iteratoroperator++ ()
 Increment iterator to next cell with position.
 
ct lowerleft (int i) const
 Return ith component of lower left corner of the entity associated with the current coordinates and shift.
 
fTupel lowerleft () const
 Return lower left corner of the entity associated with the current coordinates and shift.
 
ct upperright (int i) const
 Return ith component of upper right corder of the entity associated with the current coordinates and shift.
 
fTupel upperright () const
 Return upper right corder of the entity associated with the current coordinates and shift.
 
ct meshsize (int i) const
 Return meshsize in direction i.
 
fTupel meshsize () const
 Return meshsize of current cell as reference.
 

Protected Attributes

iTupel _coord
 current position in index set
 
int _superindex = 0
 consecutive index in enclosing grid
 

Detailed Description

template<class Coordinates>
class Dune::YGridComponent< Coordinates >::Iterator

Iterator class allows one to run over all cells of a grid. The cells of the grid to iterate over are numbered consecutively starting with zero. Via the index() method the iterator provides a mapping of the cells of the grid to a one-dimensional array. The number of entries in this array must be the size of the grid.


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