voro::c_loop_all_periodic Class Reference

A class for looping over all particles in a container_periodic or container_periodic_poly class. More...

#include <c_loops.hh>

Inheritance diagram for voro::c_loop_all_periodic:

Public Member Functions
template<class c_class >
	c_loop_all_periodic (c_class &con)
bool	start ()
bool	inc ()
Public Member Functions inherited from voro::c_loop_base
template<class c_class >
	c_loop_base (c_class &con)
void	pos (double &x, double &y, double &z)
void	pos (int &pid, double &x, double &y, double &z, double &r)
double	x ()
double	y ()
double	z ()
int	pid ()

Additional Inherited Members
Public Attributes inherited from voro::c_loop_base
const int	nx
const int	ny
const int	nz
const int	nxy
const int	nxyz
const int	ps
double **	p
int **	id
int *	co
int	i
int	j
int	k
int	ijk
int	q

Detailed Description

A class for looping over all particles in a container_periodic or container_periodic_poly class.

Since the container_periodic and container_periodic_poly classes have a fundamentally different memory organization, the regular loop classes cannot be used with them.

Constructor & Destructor Documentation

c_loop_all_periodic()

template<class c_class >

voro::c_loop_all_periodic::c_loop_all_periodic ( c_class &  con )

inline

The constructor copies several necessary constants from the base periodic container class.

Parameters

[in]

con

the periodic container class to use.

Member Function Documentation

inc()

bool voro::c_loop_all_periodic::inc ( )

inline

Finds the next particle to test.

Returns

True if there is another particle, false if no more particles are available.

start()

bool voro::c_loop_all_periodic::start ( )

inline

Sets the class to consider the first particle.

Returns

True if there is any particle to consider, false otherwise.

---

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

• Engine/Source/Runtime/Experimental/Voronoi/Private/voro++/src/c_loops.hh