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

Detailed Description

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.

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

Public Member Functions
	CellNNIteratorSymMP (size_t cell, size_t p, const NNc_array< dim, NNc_size > &NNc, Cell &cl, const openfpm::vector< Point< dim, typename Cell::stype >> &v_p1, const openfpm::vector< Point< dim, typename Cell::stype >> &v_p2)
	Cell NN iterator. More...

CellNNIteratorSymMP< dim, Cell, NNc_size, impl > &	operator++ ()
	take the next element More...

Public Member Functions inherited from CellNNIterator< dim, Cell, NNc_size, impl >
	CellNNIterator (size_t cell, const NNc_array< dim, NNc_size > &NNc, Cell &cl)
	Cell NN iterator. More...

bool	isNext ()
	Check if there is the next element. More...

CellNNIterator &	operator++ ()
	take the next element More...

const Cell::Mem_type_type::loc_index &	get ()
	Get the value of the cell. More...

const Cell::Mem_type_type::loc_index &	get () const
	Get the value of the cell. More...

Private Attributes
size_t	p
	index of the particle p

const openfpm::vector< Point < dim, typename Cell::stype > > &	v_p1
	Phase vector for particle p.

const openfpm::vector< Point < dim, typename Cell::stype > > &	v_p2
	Phase vector for particle q.

Additional Inherited Members
Protected Member Functions inherited from CellNNIterator< dim, Cell, NNc_size, impl >
void	selectValid ()
	Select non-empty cell. More...

Protected Attributes inherited from CellNNIterator< dim, Cell, NNc_size, impl >
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;.

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.

Constructor & Destructor Documentation

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

CellNNIteratorSymMP< dim, Cell, NNc_size, impl >::CellNNIteratorSymMP	(	size_t	cell,
		size_t	p,
		const NNc_array< dim, NNc_size > &	NNc,
		Cell &	cl,
		const openfpm::vector< Point< dim, typename Cell::stype >> &	v_p1,
		const openfpm::vector< Point< dim, typename Cell::stype >> &	v_p2
	)

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

Definition at line 307 of file CellNNIterator.hpp.

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

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

inline

take the next element

Definition at line 324 of file CellNNIterator.hpp.

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

void CellNNIteratorSymMP< dim, Cell, NNc_size, impl >::selectValid ( )

inlineprivate

Select the next valid element

Definition at line 268 of file CellNNIterator.hpp.

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