ParticleIt_Cells< dim, CellListType > Class Template Reference

This iterator iterate across the particles of a Cell-list following the Cell structure. More...

Detailed Description

template<unsigned int dim, typename CellListType>
class ParticleIt_Cells< dim, CellListType >

This iterator iterate across the particles of a Cell-list following the Cell structure.

Template Parameters

dim	Dimensionality
CellListType	type of the cell-list

Definition at line 18 of file ParticleIt_Cells.hpp.

#include <ParticleIt_Cells.hpp>

Public Member Functions
	ParticleIt_Cells (CellListType &cli, const openfpm::vector< size_t > &dom_cell, size_t g_m)
	Initialize the iterator.
ParticleIt_Cells &	operator++ ()
	Increment to the next particle.
bool	isNext ()
	Return true if there is the next particle.
size_t	get ()
	Get the actual particle id.

Private Member Functions
void	selectValid ()
	Adjust the counters to reach a valid particle element.

Private Attributes
const size_t *	start
	starting position
const size_t *	stop
	stop position
size_t	cid
	Actual cell.
const openfpm::vector< size_t > &	dom_cell
	List of all the domain cells.
CellListType &	cli
	Celllist type.
size_t	g_m
	Ghost marker.

Constructor & Destructor Documentation

ParticleIt_Cells()

template<unsigned int dim, typename CellListType >

ParticleIt_Cells< dim, CellListType >::ParticleIt_Cells ( CellListType &  cli, const openfpm::vector< size_t > &  dom_cell, size_t  g_m  )

inline

Initialize the iterator.

Parameters

cli	Cell-list
dom_cell	domain cell
g_m	ghost marker

Definition at line 73 of file ParticleIt_Cells.hpp.

Member Function Documentation

get()

template<unsigned int dim, typename CellListType >

size_t ParticleIt_Cells< dim, CellListType >::get ( )

inline

Get the actual particle id.

Returns

the actual particle id

Definition at line 139 of file ParticleIt_Cells.hpp.

isNext()

template<unsigned int dim, typename CellListType >

bool ParticleIt_Cells< dim, CellListType >::isNext ( )

inline

Return true if there is the next particle.

Returns

true if there is a new point

Definition at line 129 of file ParticleIt_Cells.hpp.

operator++()

template<unsigned int dim, typename CellListType >

ParticleIt_Cells & ParticleIt_Cells< dim, CellListType >::operator++ ( )

inline

Increment to the next particle.

Returns

The actual particle iterator

Definition at line 110 of file ParticleIt_Cells.hpp.

selectValid()

template<unsigned int dim, typename CellListType >

void ParticleIt_Cells< dim, CellListType >::selectValid ( )

inlineprivate

Adjust the counters to reach a valid particle element.

Definition at line 44 of file ParticleIt_Cells.hpp.

Field Documentation

cid

template<unsigned int dim, typename CellListType >

size_t ParticleIt_Cells< dim, CellListType >::cid

private

Actual cell.

Definition at line 29 of file ParticleIt_Cells.hpp.

cli

template<unsigned int dim, typename CellListType >

CellListType& ParticleIt_Cells< dim, CellListType >::cli

private

Celllist type.

Definition at line 35 of file ParticleIt_Cells.hpp.

dom_cell

template<unsigned int dim, typename CellListType >

const openfpm::vector<size_t>& ParticleIt_Cells< dim, CellListType >::dom_cell

private

List of all the domain cells.

Definition at line 32 of file ParticleIt_Cells.hpp.

g_m

template<unsigned int dim, typename CellListType >

size_t ParticleIt_Cells< dim, CellListType >::g_m

private

Ghost marker.

Definition at line 38 of file ParticleIt_Cells.hpp.

start

template<unsigned int dim, typename CellListType >

const size_t* ParticleIt_Cells< dim, CellListType >::start

private

starting position

Definition at line 23 of file ParticleIt_Cells.hpp.

stop

template<unsigned int dim, typename CellListType >

const size_t* ParticleIt_Cells< dim, CellListType >::stop

private

stop position

Definition at line 26 of file ParticleIt_Cells.hpp.

---

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

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