OpenFPM_pdata  1.1.0
Project that contain the implementation of distributed structures
 All Data Structures Namespaces Functions Variables Typedefs Enumerations Friends Pages
CellIterator< Cell > Class Template Reference

it iterate through the elements of a cell More...

Detailed Description

template<typename Cell>
class CellIterator< Cell >

it iterate through the elements of a cell

In general you do not create this object you get it from the CellList structures

Template Parameters
Cellcell type

Definition at line 341 of file CellNNIterator.hpp.

#include <CellNNIterator.hpp>

+ Inheritance diagram for CellIterator< Cell >:

Public Member Functions

 CellIterator (const size_t cell, Cell &cl)
 Cell iterator. More...
 
bool isNext ()
 Check if there is the next element. More...
 
CellIteratoroperator++ ()
 take the next neoghborhood particle More...
 
Cell::value_type & get ()
 Get the value of the cell. More...
 
const Cell::value_type & get () const
 Get the value of the cell. More...
 

Private Attributes

Cell & cl
 Cell list.
 
size_t ele_id
 actual element id inside the cell
 
const long int cell
 selected cell
 

Constructor & Destructor Documentation

template<typename Cell>
CellIterator< Cell >::CellIterator ( const size_t  cell,
Cell &  cl 
)
inline

Cell iterator.

Parameters
cellCell id
clCell on which iterate

Definition at line 360 of file CellNNIterator.hpp.

Member Function Documentation

template<typename Cell>
Cell::value_type& CellIterator< Cell >::get ( )
inline

Get the value of the cell.

Returns
the next element object

Definition at line 392 of file CellNNIterator.hpp.

template<typename Cell>
const Cell::value_type& CellIterator< Cell >::get ( ) const
inline

Get the value of the cell.

Returns
the next element object

Definition at line 402 of file CellNNIterator.hpp.

template<typename Cell>
bool CellIterator< Cell >::isNext ( )
inline

Check if there is the next element.

Returns
true if there are still neighborhood particles

Definition at line 370 of file CellNNIterator.hpp.

template<typename Cell>
CellIterator& CellIterator< Cell >::operator++ ( )
inline

take the next neoghborhood particle

Returns
itself

Definition at line 380 of file CellNNIterator.hpp.


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