OpenFPM_pdata  1.1.0
Project that contain the implementation of distributed structures
 All Data Structures Namespaces Functions Variables Typedefs Enumerations Friends Pages
VerletNNIteratorM< dim, Ver, sh_byte > Class Template Reference

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

Detailed Description

template<unsigned int dim, typename Ver, unsigned int sh_byte>
class VerletNNIteratorM< dim, Ver, sh_byte >

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

Template Parameters
dimdimensionality of the space where the cell live
VerBase verlet structure
sh_bytenumber of bits for the phase number

Definition at line 24 of file VerletNNIteratorM.hpp.

#include <VerletNNIteratorM.hpp>

+ Inheritance diagram for VerletNNIteratorM< dim, Ver, sh_byte >:

Public Member Functions

 VerletNNIteratorM (size_t part_id, Ver &ver)
 Constructor for the Verlet iterator Multi-phase. More...
 
size_t getP ()
 Get the value of the cell. More...
 
size_t getV ()
 Get the value of the cell. More...
 
- Public Member Functions inherited from VerletNNIterator< dim, Ver >
 VerletNNIterator (size_t part_id, Ver &ver)
 Cell NN iterator. More...
 
bool isNext ()
 Check if there is the next element. More...
 
VerletNNIteratoroperator++ ()
 take the next element More...
 
Ver::Mem_type_type::loc_index get ()
 Get the value of the cell. More...
 

Private Types

typedef boost::high_bit_mask_t
< sh_byte > 
mask_high
 Mask to get the high bits of a number.
 
typedef boost::low_bits_mask_t
< sizeof(size_t)*8-sh_byte > 
mask_low
 Mask to get the low bits of a number.
 

Constructor & Destructor Documentation

template<unsigned int dim, typename Ver, unsigned int sh_byte>
VerletNNIteratorM< dim, Ver, sh_byte >::VerletNNIteratorM ( size_t  part_id,
Ver &  ver 
)
inline

Constructor for the Verlet iterator Multi-phase.

Definition at line 39 of file VerletNNIteratorM.hpp.

Member Function Documentation

template<unsigned int dim, typename Ver, unsigned int sh_byte>
size_t VerletNNIteratorM< dim, Ver, sh_byte >::getP ( )
inline

Get the value of the cell.

Returns
the next element object

Definition at line 49 of file VerletNNIteratorM.hpp.

template<unsigned int dim, typename Ver, unsigned int sh_byte>
size_t VerletNNIteratorM< dim, Ver, sh_byte >::getV ( )
inline

Get the value of the cell.

Returns
the next element object

Definition at line 59 of file VerletNNIteratorM.hpp.


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