Voro++
Public Member Functions
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 ()

Detailed Description

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

Definition at line 331 of file c_loops.hh.


Constructor & Destructor Documentation

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]conthe periodic container class to use.

Definition at line 337 of file c_loops.hh.


Member Function Documentation

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.

Definition at line 354 of file c_loops.hh.

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.

Definition at line 342 of file c_loops.hh.


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