Package gov.nih.mipav.model.structures

Class Voro.c_loop_all_periodic

java.lang.Object

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

gov.nih.mipav.model.structures.Voro.c_loop_all_periodic

Enclosing class:

Voro

class Voro.c_loop_all_periodic
extends Voro.c_loop_base

\brief 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.

Field Summary

Fields

Modifier and Type	Field	Description
private int	ey	The lower y index (inclusive) of the primary domain within the block structure.
private int	ez	The lower y index (inclusive) of the primary domain within the block structure.
private int	ijk0	The index of the (0,0,0) block within the block structure.
private int	inc2	A value to increase ijk by when the z index is increased.
private int	wy	The upper y index (exclusive) of the primary domain within the block structure.
private int	wz	The upper z index (exclusive) of the primary domain within the block structure.

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_periodic(Voro.container_periodic_poly_radius_poly con)
c_loop_all_periodic(Voro.container_periodic_radius_mono con)	The constructor copies several necessary constants from the base periodic 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

Field Detail

ey

private int ey

The lower y index (inclusive) of the primary domain within the block structure.

ez

private int ez

The lower y index (inclusive) of the primary domain within the block structure.

wy

private int wy

The upper y index (exclusive) of the primary domain within the block structure.

wz

private int wz

The upper z index (exclusive) of the primary domain within the block structure.

ijk0

private int ijk0

The index of the (0,0,0) block within the block structure.

inc2

private int inc2

A value to increase ijk by when the z index is increased.

Constructor Detail

c_loop_all_periodic

public c_loop_all_periodic(Voro.container_periodic_radius_mono con)

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

c_loop_all_periodic

public c_loop_all_periodic(Voro.container_periodic_poly_radius_poly con)

Method Detail

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.