OpenFPM  5.2.0
Project that contain the implementation of distributed structures
CellNNIteratorRadius< dim, Cell > Class Template Reference

Iterator for the neighborhood of the cell structures with free radius. More...

#include <CellNNIteratorRadius.hpp>

Public Member Functions

 CellNNIteratorRadius (size_t cell, const openfpm::vector< long int > &NNc, Cell &cl)
 Cell NN iterator. More...
 
bool isNext ()
 Check if there is the next element.
 
CellNNIteratorRadiusoperator++ ()
 take the next element
 
Cell::value_type & get ()
 Get the value of the cell. More...
 

Private Member Functions

void selectValid ()
 Select non-empty cell.
 

Private Attributes

Cell & cl
 
size_t NNc_id
 
size_t cell_id
 
size_t ele_id
 
const openfpm::vector< long int > & NNc
 
const long int cell
 

Detailed Description

template<unsigned int dim, typename Cell>
class CellNNIteratorRadius< dim, Cell >

Iterator for the neighborhood of the cell structures with free radius.

In general you never create it directly but you get it from the CellList structures

It iterate across all the element of the selected cell and the near cells (inside a radius)

Template Parameters
dimdimensionality of the space where the cell live
Cellcell type on which the iterator is working
NNc_sizeneighborhood size

Definition at line 24 of file CellNNIteratorRadius.hpp.

Constructor & Destructor Documentation

◆ CellNNIteratorRadius()

template<unsigned int dim, typename Cell >
CellNNIteratorRadius< dim, Cell >::CellNNIteratorRadius ( size_t  cell,
const openfpm::vector< long int > &  NNc,
Cell &  cl 
)
inline

Cell NN iterator.

Parameters
cellCell id
NNcCell neighborhood indexes (relative)
clCell structure

Definition at line 73 of file CellNNIteratorRadius.hpp.

Member Function Documentation

◆ get()

template<unsigned int dim, typename Cell >
Cell::value_type& CellNNIteratorRadius< dim, Cell >::get ( )
inline

Get the value of the cell.

Returns
the next element object

Definition at line 114 of file CellNNIteratorRadius.hpp.


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