OpenFPM_pdata  4.1.0
Project that contain the implementation of distributed structures
 
Loading...
Searching...
No Matches
CellNNIteratorSymM< dim, Cell, sh_byte, NNc_size, impl > Class Template Reference

Iterator for the neighborhood of the cell structures. More...

Detailed Description

template<unsigned int dim, typename Cell, unsigned int sh_byte, int NNc_size, unsigned int impl>
class CellNNIteratorSymM< dim, Cell, sh_byte, NNc_size, impl >

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 accordingly yo the symmetric scheme

Template Parameters
dimdimensionality of the space where the cell live
Cellcell type on which the iterator is working
NNc_sizeneighborhood size
implimplementation specific options NO_CHECK do not do check on access, SAFE do check on access

Definition at line 31 of file CellNNIteratorM.hpp.

#include <CellNNIteratorM.hpp>

+ Inheritance diagram for CellNNIteratorSymM< dim, Cell, sh_byte, NNc_size, impl >:

Public Member Functions

 CellNNIteratorSymM (size_t cell, size_t pp, size_t p, const NNc_array< dim, NNc_size > &NNc, Cell &cl, const typename Cell::internal_vector_pos_type &pos, const typename openfpm::vector< pos_v< typename Cell::internal_vector_pos_type > > &ps)
 Cell NN iterator.
 
size_t getP ()
 Get the value of the cell.
 
size_t getV ()
 Get the value of the cell.
 
CellNNIteratorSymM< dim, Cell, sh_byte, NNc_size, impl > & operator++ ()
 take the next element
 
- Public Member Functions inherited from CellNNIterator< dim, Cell, NNc_size, impl >
 __attribute__ ((always_inline)) inline CellNNIterator(size_t cell
 Cell NN iterator.
 
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.
 
 __attribute__ ((always_inline)) inline CellNNIterator &operator++()
 take the next element
 
 __attribute__ ((always_inline)) inline const typename Cell
 Get the value of the cell.
 

Private Types

typedef boost::low_bits_mask_t< sizeof(size_t) *8-sh_bytemask_low
 

Private Member Functions

void selectValid ()
 

Private Attributes

size_t pp
 phase of particle p
 
size_t p
 index of the particle p
 
const Cell::internal_vector_pos_type & pos
 Position of the particles p.
 
const openfpm::vector< pos_v< typename Cell::internal_vector_pos_type > > & ps
 Position of the particle p.
 

Additional Inherited Members

- Data Fields inherited from CellNNIterator< dim, Cell, NNc_size, impl >
const NNc_array< dim, NNc_size > Cell & cl:NNc_id(0)
 
- Protected Member Functions inherited from CellNNIterator< dim, Cell, NNc_size, impl >
 __attribute__ ((always_inline)) inline void selectValid()
 Select non-empty cell.
 
- 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 Typedef Documentation

◆ mask_low

template<unsigned int dim, typename Cell , unsigned int sh_byte, int NNc_size, unsigned int impl>
typedef boost::low_bits_mask_t<sizeof(size_t)*8-sh_byte> CellNNIteratorSymM< dim, Cell, sh_byte, NNc_size, impl >::mask_low
private

Definition at line 33 of file CellNNIteratorM.hpp.

Constructor & Destructor Documentation

◆ CellNNIteratorSymM()

template<unsigned int dim, typename Cell , unsigned int sh_byte, int NNc_size, unsigned int impl>
CellNNIteratorSymM< dim, Cell, sh_byte, NNc_size, impl >::CellNNIteratorSymM ( size_t  cell,
size_t  pp,
size_t  p,
const NNc_array< dim, NNc_size > &  NNc,
Cell &  cl,
const typename Cell::internal_vector_pos_type &  pos,
const typename openfpm::vector< pos_v< typename Cell::internal_vector_pos_type > > &  ps 
)
inline

Cell NN iterator.

Parameters
cellCell id
NNcCell neighborhood indexes (relative)
clCell structure

Definition at line 89 of file CellNNIteratorM.hpp.

Member Function Documentation

◆ getP()

template<unsigned int dim, typename Cell , unsigned int sh_byte, int NNc_size, unsigned int impl>
size_t CellNNIteratorSymM< dim, Cell, sh_byte, NNc_size, impl >::getP ( )
inline

Get the value of the cell.

Returns
the next element object

Definition at line 107 of file CellNNIteratorM.hpp.

◆ getV()

template<unsigned int dim, typename Cell , unsigned int sh_byte, int NNc_size, unsigned int impl>
size_t CellNNIteratorSymM< dim, Cell, sh_byte, NNc_size, impl >::getV ( )
inline

Get the value of the cell.

Returns
the next element object

Definition at line 117 of file CellNNIteratorM.hpp.

◆ operator++()

template<unsigned int dim, typename Cell , unsigned int sh_byte, int NNc_size, unsigned int impl>
CellNNIteratorSymM< dim, Cell, sh_byte, NNc_size, impl > & CellNNIteratorSymM< dim, Cell, sh_byte, NNc_size, impl >::operator++ ( )
inline

take the next element

Returns
itself

Definition at line 127 of file CellNNIteratorM.hpp.

◆ selectValid()

template<unsigned int dim, typename Cell , unsigned int sh_byte, int NNc_size, unsigned int impl>
void CellNNIteratorSymM< dim, Cell, sh_byte, NNc_size, impl >::selectValid ( )
inlineprivate

Select the next valid element

Definition at line 50 of file CellNNIteratorM.hpp.

Field Documentation

◆ p

template<unsigned int dim, typename Cell , unsigned int sh_byte, int NNc_size, unsigned int impl>
size_t CellNNIteratorSymM< dim, Cell, sh_byte, NNc_size, impl >::p
private

index of the particle p

Definition at line 39 of file CellNNIteratorM.hpp.

◆ pos

template<unsigned int dim, typename Cell , unsigned int sh_byte, int NNc_size, unsigned int impl>
const Cell::internal_vector_pos_type& CellNNIteratorSymM< dim, Cell, sh_byte, NNc_size, impl >::pos
private

Position of the particles p.

Definition at line 42 of file CellNNIteratorM.hpp.

◆ pp

template<unsigned int dim, typename Cell , unsigned int sh_byte, int NNc_size, unsigned int impl>
size_t CellNNIteratorSymM< dim, Cell, sh_byte, NNc_size, impl >::pp
private

phase of particle p

Definition at line 36 of file CellNNIteratorM.hpp.

◆ ps

template<unsigned int dim, typename Cell , unsigned int sh_byte, int NNc_size, unsigned int impl>
const openfpm::vector<pos_v<typename Cell::internal_vector_pos_type> >& CellNNIteratorSymM< dim, Cell, sh_byte, NNc_size, impl >::ps
private

Position of the particle p.

Definition at line 45 of file CellNNIteratorM.hpp.


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