OpenFPM_pdata  4.1.0
Project that contain the implementation of distributed structures
 
Loading...
Searching...
No Matches
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

 __attribute__ ((always_inline)) inline CellIterator(const size_t cell
 Cell iterator.
 
Cell ele_id (0)
 
Cell cell (cell)
 
 __attribute__ ((always_inline)) inline bool isNext()
 Check if there is the next element.
 
 __attribute__ ((always_inline)) inline CellIterator &operator++()
 take the next neoghborhood particle
 
 __attribute__ ((always_inline)) inline typename Cell
 Get the value of the cell.
 

Private Attributes

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

Member Function Documentation

◆ __attribute__() [1/4]

template<typename Cell >
CellIterator< Cell >::__attribute__ ( (always_inline)  )
inline

Check if there is the next element.

Returns
true if there are still neighborhood particles

Definition at line 370 of file CellNNIterator.hpp.

◆ __attribute__() [2/4]

template<typename Cell >
CellIterator< Cell >::__attribute__ ( (always_inline)  ) &
inline

take the next neoghborhood particle

Returns
itself

Definition at line 380 of file CellNNIterator.hpp.

◆ __attribute__() [3/4]

template<typename Cell >
CellIterator< Cell >::__attribute__ ( (always_inline)  ) const

Cell iterator.

Parameters
cellCell id
clCell on which iterate

◆ __attribute__() [4/4]

template<typename Cell >
CellIterator< Cell >::__attribute__ ( (always_inline)  )
inline

Get the value of the cell.

Returns
the next element object

Definition at line 392 of file CellNNIterator.hpp.

◆ cell()

template<typename Cell >
Cell CellIterator< Cell >::cell ( cell  )
inline

Definition at line 361 of file CellNNIterator.hpp.

Field Documentation

◆ cell

template<typename Cell >
const long int CellIterator< Cell >::cell
private

selected cell

Definition at line 350 of file CellNNIterator.hpp.

◆ cl

template<typename Cell >
Cell & CellIterator< Cell >::cl
private

Cell list.

Definition at line 344 of file CellNNIterator.hpp.

◆ ele_id

template<typename Cell >
size_t CellIterator< Cell >::ele_id
private

actual element id inside the cell

Definition at line 347 of file CellNNIterator.hpp.


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