OpenFPM_pdata  4.1.0
Project that contain the implementation of distributed structures
 
Loading...
Searching...
No Matches
VerletNNIterator< dim, Ver > Class Template Reference

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

Detailed Description

template<unsigned int dim, typename Ver>
class VerletNNIterator< dim, Ver >

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
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 27 of file VerletNNIterator.hpp.

#include <VerletNNIterator.hpp>

+ Inheritance diagram for VerletNNIterator< dim, Ver >:

Public Member Functions

 VerletNNIterator (size_t part_id, Ver &ver)
 Cell NN iterator.
 
bool isNext ()
 Check if there is the next element.
 
VerletNNIteratoroperator++ ()
 take the next element
 
Ver::Mem_type_type::local_index_type get ()
 Get the value of the cell.
 

Private Attributes

const Ver::Mem_type_type::local_index_type * start
 start index for the neighborhood
 
const Ver::Mem_type_type::local_index_type * stop
 stop index for the neighborhood
 
const Ver::Mem_type_type::local_index_type * ele_id
 actual neighborhood
 
Ver & ver
 verlet list
 

Constructor & Destructor Documentation

◆ VerletNNIterator()

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

Cell NN iterator.

Parameters
part_idParticle id
verVerlet-list

Definition at line 51 of file VerletNNIterator.hpp.

Member Function Documentation

◆ get()

template<unsigned int dim, typename Ver >
Ver::Mem_type_type::local_index_type VerletNNIterator< dim, Ver >::get ( )
inline

Get the value of the cell.

Returns
the next element object

Definition at line 86 of file VerletNNIterator.hpp.

◆ isNext()

template<unsigned int dim, typename Ver >
bool VerletNNIterator< dim, Ver >::isNext ( )
inline

Check if there is the next element.

Returns
true if there is the next element

Definition at line 62 of file VerletNNIterator.hpp.

◆ operator++()

template<unsigned int dim, typename Ver >
VerletNNIterator & VerletNNIterator< dim, Ver >::operator++ ( )
inline

take the next element

Returns
itself

Definition at line 74 of file VerletNNIterator.hpp.

Field Documentation

◆ ele_id

template<unsigned int dim, typename Ver >
const Ver::Mem_type_type::local_index_type* VerletNNIterator< dim, Ver >::ele_id
private

actual neighborhood

Definition at line 36 of file VerletNNIterator.hpp.

◆ start

template<unsigned int dim, typename Ver >
const Ver::Mem_type_type::local_index_type* VerletNNIterator< dim, Ver >::start
private

start index for the neighborhood

Definition at line 30 of file VerletNNIterator.hpp.

◆ stop

template<unsigned int dim, typename Ver >
const Ver::Mem_type_type::local_index_type* VerletNNIterator< dim, Ver >::stop
private

stop index for the neighborhood

Definition at line 33 of file VerletNNIterator.hpp.

◆ ver

template<unsigned int dim, typename Ver >
Ver& VerletNNIterator< dim, Ver >::ver
private

verlet list

Definition at line 39 of file VerletNNIterator.hpp.


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