Package gov.nih.mipav.model.structures

Class Voro.c_loop_order_periodic

java.lang.Object
gov.nih.mipav.model.structures.Voro.c_loop_base
gov.nih.mipav.model.structures.Voro.c_loop_order_periodic
Enclosing class:
Voro
class Voro.c_loop_order_periodic extends Voro.c_loop_base
\brief Class for looping over all of the particles specified in a pre-assembled particle_order class, for use with container_periodic classes. The particle_order class can be used to create a specific order of particles within the container. This class can then loop over these particles in this order. The class is particularly useful in cases where the ordering of the output must match the ordering of particles as they were inserted into the container.

  • Field Details

    • vo

      public Voro.particle_order vo
      A reference to the ordering class to use.

    • cp

      public int[] cp
      A pointer to the current position in the ordering class.

    • nx

      private int nx
      The number of computational blocks in the x direction.

    • oxy

      private int oxy
      The number of computational blocks in a z-slice.

  • Constructor Details

    • c_loop_order_periodic

      public c_loop_order_periodic(Voro.container_periodic_radius_mono con, Voro.particle_order vo_)
      The constructor copies several necessary constants from the base class, and sets up a reference to the ordering class to use. \param[in] con the container class to use. \param[in] vo_ the ordering class to use.

  • 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.

    • decode

      private void decode()
      Takes the current block index and computes indices in the x, y, and z directions.