CellNNIteratorRadius< dim, Cell, impl > Class Template Reference

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

Detailed Description

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

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

dim	dimensionality of the space where the cell live
Cell	cell type on which the iterator is working
NNc_size	neighborhood size
impl	implementation specific options NO_CHECK do not do check on access, SAFE do check on access

Definition at line 25 of file CellListNNIteratorRadius.hpp.

#include <CellListNNIteratorRadius.hpp>

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

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

Constructor & Destructor Documentation

CellNNIteratorRadius()

template<unsigned int dim, typename Cell , unsigned int impl>

CellNNIteratorRadius< dim, Cell, impl >::CellNNIteratorRadius ( size_t  cell, const openfpm::vector< long int > &  NNc, Cell &  cl  )

inline

Cell NN iterator.

Parameters

cell	Cell id
NNc	Cell neighborhood indexes (relative)
cl	Cell structure

Definition at line 74 of file CellListNNIteratorRadius.hpp.

Member Function Documentation

get()

template<unsigned int dim, typename Cell , unsigned int impl>

Cell::value_type & CellNNIteratorRadius< dim, Cell, impl >::get ( )

inline

Get the value of the cell.

Returns

the next element object

Definition at line 115 of file CellListNNIteratorRadius.hpp.

isNext()

template<unsigned int dim, typename Cell , unsigned int impl>

bool CellNNIteratorRadius< dim, Cell, impl >::isNext ( )

inline

Check if there is the next element.

Definition at line 91 of file CellListNNIteratorRadius.hpp.

operator++()

template<unsigned int dim, typename Cell , unsigned int impl>

CellNNIteratorRadius & CellNNIteratorRadius< dim, Cell, impl >::operator++ ( )

inline

take the next element

Definition at line 101 of file CellListNNIteratorRadius.hpp.

selectValid()

template<unsigned int dim, typename Cell , unsigned int impl>

void CellNNIteratorRadius< dim, Cell, impl >::selectValid ( )

inlineprivate

Select non-empty cell.

Definition at line 48 of file CellListNNIteratorRadius.hpp.

Field Documentation

cell

template<unsigned int dim, typename Cell , unsigned int impl>

const long int CellNNIteratorRadius< dim, Cell, impl >::cell

private

Definition at line 43 of file CellListNNIteratorRadius.hpp.

cell_id

template<unsigned int dim, typename Cell , unsigned int impl>

size_t CellNNIteratorRadius< dim, Cell, impl >::cell_id

private

Definition at line 34 of file CellListNNIteratorRadius.hpp.

cl

template<unsigned int dim, typename Cell , unsigned int impl>

Cell& CellNNIteratorRadius< dim, Cell, impl >::cl

private

Definition at line 28 of file CellListNNIteratorRadius.hpp.

ele_id

template<unsigned int dim, typename Cell , unsigned int impl>

size_t CellNNIteratorRadius< dim, Cell, impl >::ele_id

private

Definition at line 37 of file CellListNNIteratorRadius.hpp.

NNc

template<unsigned int dim, typename Cell , unsigned int impl>

const openfpm::vector<long int>& CellNNIteratorRadius< dim, Cell, impl >::NNc

private

Definition at line 40 of file CellListNNIteratorRadius.hpp.

NNc_id

template<unsigned int dim, typename Cell , unsigned int impl>

size_t CellNNIteratorRadius< dim, Cell, impl >::NNc_id

private

Definition at line 31 of file CellListNNIteratorRadius.hpp.

---

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

• openfpm_data/src/NN/CellList/CellListNNIteratorRadius.hpp