Package gov.nih.mipav.model.structures

Class Voro.wall_sphere

java.lang.Object
gov.nih.mipav.model.structures.Voro.wall
gov.nih.mipav.model.structures.Voro.wall_sphere
Enclosing class:
Voro
class Voro.wall_sphere extends Voro.wall
\brief A class representing a spherical wall object. This class represents a spherical wall object.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private double
    rc
     
    private int
    w_id
     
    private double
    xc
     
    private double
    yc
     
    private double
    zc
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    wall_sphere(double xc_, double yc_, double zc_, double rc_, int w_id_)
    Constructs a spherical wall object.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    cut_cell(Voro.voronoicell_neighbor c, double x, double y, double z)
    A pure virtual function for cutting a cell with neighbor-tracking enabled with a wall.
    boolean
    cut_cell(Voro.voronoicell c, double x, double y, double z)
    A pure virtual function for cutting a cell without neighbor-tracking with a wall.
    boolean
    cut_cell_base(Voro.voronoicell_neighbor c, double x, double y, double z)
     
    boolean
    cut_cell_base(Voro.voronoicell c, double x, double y, double z)
    Cuts a cell by the sphere wall object.
    void
    delete()
     
    boolean
    point_inside(double x, double y, double z)
    Tests to see whether a point is inside the sphere wall object.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • w_id

      private int w_id

    • xc

      private double xc

    • yc

      private double yc

    • zc

      private double zc

    • rc

      private double rc

  • Constructor Details

    • wall_sphere

      public wall_sphere(double xc_, double yc_, double zc_, double rc_, int w_id_)
      Constructs a spherical wall object. \param[in] w_id_ an ID number to associate with the wall for neighbor tracking. \param[in] (xc_,yc_,zc_) a position vector for the sphere's center. \param[in] rc_ the radius of the sphere.

  • Method Details

    • delete

      public void delete()
      Specified by:
      delete in class Voro.wall

    • point_inside

      public boolean point_inside(double x, double y, double z)
      Tests to see whether a point is inside the sphere wall object. \param[in,out] (x,y,z) the vector to test. \return True if the point is inside, false if the point is outside.
      Specified by:
      point_inside in class Voro.wall

    • cut_cell_base

      public boolean cut_cell_base(Voro.voronoicell c, double x, double y, double z)
      Cuts a cell by the sphere wall object. The spherical wall is approximated by a single plane applied at the point on the sphere which is closest to the center of the cell. This works well for particle arrangements that are packed against the wall, but loses accuracy for sparse particle distributions. \param[in,out] c the Voronoi cell to be cut. \param[in] (x,y,z) the location of the Voronoi cell. \return True if the cell still exists, false if the cell is deleted.

    • cut_cell_base

      public boolean cut_cell_base(Voro.voronoicell_neighbor c, double x, double y, double z)

    • cut_cell

      public boolean cut_cell(Voro.voronoicell c, double x, double y, double z)
      Description copied from class: Voro.wall
      A pure virtual function for cutting a cell without neighbor-tracking with a wall.
      Specified by:
      cut_cell in class Voro.wall

    • cut_cell

      public boolean cut_cell(Voro.voronoicell_neighbor c, double x, double y, double z)
      Description copied from class: Voro.wall
      A pure virtual function for cutting a cell with neighbor-tracking enabled with a wall.
      Specified by:
      cut_cell in class Voro.wall