Package gov.nih.mipav.model.structures

Class Voro.c_loop_all

java.lang.Object

gov.nih.mipav.model.structures.Voro.c_loop_base

gov.nih.mipav.model.structures.Voro.c_loop_all

Enclosing class:

Voro

class Voro.c_loop_all
extends Voro.c_loop_base

\brief Class for looping over all of the particles in a container. This is one of the simplest loop classes, that scans the computational blocks in order, and scans all the particles within each block in order.

Field Summary

Fields inherited from class gov.nih.mipav.model.structures.Voro.c_loop_base

co, i, id, ijk, j, k, nx, nxy, nxyz, ny, nz, p, ps, q

Constructor Summary

Constructors

Constructor	Description
c_loop_all(Voro.container_poly_radius_poly con)
c_loop_all(Voro.container_radius_mono con)	The constructor copies several necessary constants from the base container class.

Method Summary

Modifier and Type	Method	Description
boolean	inc()	Finds the next particle to test.
private boolean	next_block()	Updates the internal variables to find the next computational block with any particles.
boolean	start()	Sets the class to consider the first particle.

Methods inherited from class gov.nih.mipav.model.structures.Voro.c_loop_base

pid, pos, pos, x, y, z

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

c_loop_all

public c_loop_all(Voro.container_radius_mono con)

The constructor copies several necessary constants from the base container class. \param[in] con the container class to use.

c_loop_all

public c_loop_all(Voro.container_poly_radius_poly con)

Method Details

start

public boolean start()

Sets the class to consider the first particle. \return True if there is any particle to consider, false otherwise.

inc

public boolean inc()

Finds the next particle to test. \return True if there is another particle, false if no more particles are available.

next_block

private boolean next_block()

Updates the internal variables to find the next computational block with any particles. \return True if another block is found, false if there are no more blocks.