CellNNIteratorSymMP< dim, Cell, vector_pos_type, NNc_size, impl > Class Template Reference

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

Detailed Description

template<unsigned int dim, typename Cell, typename vector_pos_type, int NNc_size, unsigned int impl>
class CellNNIteratorSymMP< dim, Cell, vector_pos_type, NNc_size, impl >

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
impl	implementation specific options NO_CHECK do not do check on access, SAFE do check on access

Definition at line 254 of file CellNNIterator.hpp.

#include <CellNNIterator.hpp>

Inheritance diagram for CellNNIteratorSymMP< dim, Cell, vector_pos_type, NNc_size, impl >:

Public Member Functions
	__attribute__ ((always_inline)) inline CellNNIteratorSymMP(size_t cell
	Cell NN iterator. More...
size_t const NNc_array< dim, NNc_size > Cell const vector_pos_type const vector_pos_type	impl (cell, NNc, cl)
size_t const NNc_array< dim, NNc_size > Cell const vector_pos_type const vector_pos_type	p (p)
size_t const NNc_array< dim, NNc_size > Cell const vector_pos_type const vector_pos_type	v_p1 (v_p1)
size_t const NNc_array< dim, NNc_size > Cell const vector_pos_type const vector_pos_type	v_p2 (v_p2)
	__attribute__ ((always_inline)) inline CellNNIteratorSymMP< dim
	take the next element More...
impl &	operator++ ()
Public Member Functions inherited from CellNNIterator< dim, Cell, NNc_size, impl >
	__attribute__ ((always_inline)) inline CellNNIterator(size_t cell
	Cell NN iterator. More...
const NNc_array< dim, NNc_size > Cell	cell (cell)
const NNc_array< dim, NNc_size > Cell	cell_id (NNc[NNc_id]+cell)
const NNc_array< dim, NNc_size > Cell	cl (cl)
const NNc_array< dim, NNc_size > 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 NNc_array< dim, NNc_size > &	NNc
size_t const NNc_array< dim, NNc_size > Cell &	cl
size_t const NNc_array< dim, NNc_size > Cell const vector_pos_type &	v_p1
size_t const NNc_array< dim, NNc_size > Cell const vector_pos_type const vector_pos_type &	v_p2:CellNNIterator<dim
size_t const NNc_array< dim, NNc_size > Cell const vector_pos_type const vector_pos_type	Cell
size_t const NNc_array< dim, NNc_size > Cell const vector_pos_type const vector_pos_type	NNc_size
	Cell
	vector_pos_type
	NNc_size
Data Fields inherited from CellNNIterator< dim, Cell, NNc_size, impl >
const NNc_array< dim, NNc_size > 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_p1
	Phase vector for particle p.
const vector_pos_type &	v_p2
	Phase vector for particle q.

Additional Inherited Members
Protected Member Functions inherited from CellNNIterator< dim, Cell, NNc_size, impl >
	__attribute__ ((always_inline)) inline void selectValid()
	Select non-empty cell. More...
Protected Attributes inherited from CellNNIterator< dim, Cell, NNc_size, impl >
const Cell::Mem_type_type::local_index_type *	start_id
	actual element id
const Cell::Mem_type_type::local_index_type *	stop_id
	stop id to read the end of the cell
size_t	NNc_id
	Actual NNc_id;.
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 NNc_array< dim, NNc_size > &	NNc
	NN cell id.

Member Function Documentation

__attribute__() [1/3]

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

CellNNIteratorSymMP< dim, Cell, vector_pos_type, NNc_size, impl >::__attribute__ ( (always_inline)  )

inlineprivate

Select the next valid element

Definition at line 268 of file CellNNIterator.hpp.

__attribute__() [2/3]

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

CellNNIteratorSymMP< dim, Cell, vector_pos_type, NNc_size, impl >::__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__() [3/3]

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

CellNNIteratorSymMP< dim, Cell, vector_pos_type, NNc_size, impl >::__attribute__

(

(always_inline)

)

take the next element

Returns

itself

---

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

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