CellNNIteratorSym< dim, Cell, vector_pos_type, RUNTIME > Class Template Reference

Symmetric iterator for the neighborhood of the cell structures. More...

#include <CellNNIteratorRuntime.hpp>

Inheritance diagram for CellNNIteratorSym< dim, Cell, vector_pos_type, RUNTIME >:

Public Member Functions
	__attribute__ ((always_inline)) inline CellNNIteratorSym(size_t cell
	Cell NN iterator. More...
size_t const long int size_t Cell const vector_pos_type	RUNTIME (cell, NNc, NNc_size, cl)
size_t const long int size_t Cell const vector_pos_type	p (p)
size_t const long int size_t Cell const vector_pos_type	v (v)
	__attribute__ ((always_inline)) inline CellNNIteratorSym< dim
	take the next element More...
RUNTIME &	operator++ ()
Public Member Functions inherited from CellNNIterator< dim, Cell, RUNTIME >
	__attribute__ ((always_inline)) inline CellNNIterator(size_t cell
	Cell NN iterator. More...
const long int size_t Cell	NNc_size (NNc_size)
const long int size_t Cell	cell (cell)
const long int size_t Cell	cell_id (NNc[NNc_id]+cell)
const long int size_t Cell	cl (cl)
const long int size_t Cell	NNc (NNc)
	__attribute__ ((always_inline)) inline bool isNext()
	Check if there is the next element. More...
	__attribute__ ((always_inline)) inline CellNNIterator &operator++()
	take the next element More...
	__attribute__ ((always_inline)) inline const typename Cell
	Get the value of the cell. More...

Data Fields
size_t const long int *	NNc
size_t const long int size_t	NNc_size
size_t const long int size_t Cell &	cl
size_t const long int size_t Cell const vector_pos_type &	v:CellNNIterator<dim
size_t const long int size_t Cell const vector_pos_type	Cell
	Cell
	vector_pos_type
Data Fields inherited from CellNNIterator< dim, Cell, RUNTIME >
const long int size_t	NNc_size
const long int size_t Cell &	cl:NNc_id(0)

Private Member Functions
	__attribute__ ((always_inline)) inline void selectValid()

Private Attributes
size_t	p
	index of the particle p
const vector_pos_type &	v
	Position of the particle p.

Additional Inherited Members
Protected Member Functions inherited from CellNNIterator< dim, Cell, RUNTIME >
	__attribute__ ((always_inline)) inline void selectValid()
	Select non-empty cell.
Protected Attributes inherited from CellNNIterator< dim, Cell, RUNTIME >
const Cell::Mem_type_type::loc_index *	start_id
	actual element id
const Cell::Mem_type_type::loc_index *	stop_id
	stop id to read the end of the cell
size_t	NNc_id
	Actual NNc_id;.
size_t	NNc_size
	Size of the neighboring cells.
const long int	cell
	Center cell, or cell for witch we are searching the NN-cell.
size_t	cell_id
	actual cell id = NNc[NNc_id]+cell stored for performance reason
Cell &	cl
	Cell list.
const long int *	NNc
	NN cell id.

Detailed Description

template<unsigned int dim, typename Cell, typename vector_pos_type>
class CellNNIteratorSym< dim, Cell, vector_pos_type, RUNTIME >

Symmetric iterator for the neighborhood of the cell structures.

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.

Note

if we query the neighborhood of p and q is the neighborhood of p when we will query the neighborhood of q p is not present. This is useful to implement formula like \( \sum_{q = neighborhood(p) and p <= q} \)

Template Parameters

dim	dimensionality of the space where the cell live
Cell	cell type on which the iterator is working
NNc_size	neighborhood size

Definition at line 156 of file CellNNIteratorRuntime.hpp.

Member Function Documentation

__attribute__() [1/3]

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

CellNNIteratorSym< dim, Cell, vector_pos_type, RUNTIME >::__attribute__

(

(always_inline)

)

Cell NN iterator.

Parameters

cell	Cell id
p	index of the particle from which we are searching the neighborhood particles
NNc	Cell neighborhood indexes (relative)
cl	Cell structure

__attribute__() [2/3]

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

CellNNIteratorSym< dim, Cell, vector_pos_type, RUNTIME >::__attribute__

(

(always_inline)

)

take the next element

Returns

itself

__attribute__() [3/3]

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

CellNNIteratorSym< dim, Cell, vector_pos_type, RUNTIME >::__attribute__ ( (always_inline)  )

inlineprivate

Select the next valid element

Definition at line 167 of file CellNNIteratorRuntime.hpp.

---

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

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