Struct voroxx::VoronoiCellNeighbor

#[repr(C)]pub struct VoronoiCellNeighbor(_);

A single Voronoi cell, with neighbor information.

This class represents a single Voronoi cell, as a collection of vertices that are connected by edges. The class contains routines for initializing the Voronoi cell to be simple shapes such as a box, tetrahedron, or octahedron. It the contains routines for recomputing the cell based on cutting it by a plane, which forms the key routine for the Voronoi cell computation. It contains numerous routine for computing statistics about the Voronoi cell, and it can output the cell in several formats.

Use this class in cases when is necessary to track the IDs of neighboring particles associated with each face of the Voronoi cell.

Implementations

impl VoronoiCellNeighbor

pub fn init(xyz_min: &[f64; 3], xyz_max: &[f64; 3]) -> Self

Initializes the Voronoi cell to be an axis aligned rectangular box with the given dimensions. The neighbor information for the initial faces are ID numbers from -1 to -6.

Parameters:

• xyz_min The minimum coordinates.
• xyz_max The maximum coordinates.

pub fn init_octahedron(l: f64) -> Self

Initializes the cell to be an octahedron with vertices at (l,0,0), (-l,0,0), (0,l,0), (0,-l,0), (0,0,l), and (0,0,-l). The neighbor information for the initial faces are ID numbers from -1 to -8.

Parameters:

• l a parameter setting the size of the octahedron.

pub fn init_tetrahedron(
    v1: &[f64; 3],
    v2: &[f64; 3],
    v3: &[f64; 3],
    v4: &[f64; 3]
) -> Self

Initializes the cell to be a tetrahedron. The neighbor information for the initial faces are ID numbers from -1 to -4.

Parameters:

• v1 The coordinates (x,y,z) of the first vertex.
• v2 The coordinates (x,y,z) of the second vertex.
• v3 The coordinates (x,y,z) of the third vertex.
• v4 The coordinates (x,y,z) of the fourth vertex.

pub fn plane(&mut self, xyz: &[f64; 3]) -> bool

Cuts a Voronoi cell using the plane corresponding to the perpendicular bisector between the particle and the origin. This sets the plane ID number to zero; see method nplane to supply a different plane ID number.

Parameters: (x, y, z) The position of the particle.

Returns: False if the plane cut deleted the cell entirely, true otherwise.

pub fn nplane(&mut self, xyz: &[f64; 3], p_id: i32) -> bool

Cuts a Voronoi cell using the plane corresponding to the perpendicular bisector of the particle and the origin.

Parameters:

• (x, y, z) The position of the particle.
• p_id The plane ID number for tracking neighbors.

Returns: False if the plane cut deleted the cell entirely, true otherwise.

pub fn neighbors(&self) -> Vec<i32>

Returns a list of IDs of neighboring particles corresponding to each face.

Trait Implementations

impl Clone for VoronoiCellNeighbor

pub fn clone(&self) -> Self

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Drop for VoronoiCellNeighbor

pub fn drop(&mut self)

Executes the destructor for this type.

impl VoronoiCellBase for VoronoiCellNeighbor

pub fn number_of_faces(&self) -> i32

Counts the number of faces of the Voronoi cell.

pub fn number_of_edges(&self) -> i32

Counts the number of edges of the Voronoi cell.

pub fn number_of_vertices(&self) -> i32

Counts the total number of vertices of the Voronoi cell.

pub fn translate(&mut self, xyz: &[f64; 3])

Translates the vertices of the Voronoi cell by a given vector.

pub fn surface_area(&self) -> f64

Calculates the total surface area of the Voronoi cell.

pub fn volume(&self) -> f64

Calculates the volume of the Voronoi cell, by decomposing the cell into tetrahedra extending outward from the zeroth vertex, whose volumes are evaluated using a scalar triple product.

pub fn total_edge_distance(&self) -> f64

Calculates the total edge distance of the Voronoi cell.

pub fn centroid(&self) -> [f64; 3]

Calculates the centroid of the Voronoi cell, by decomposing the cell into tetrahedra extending outward from the zeroth vertex.

pub fn vertices(&self) -> Vec<[f64; 3]>

Returns a vector of the vertex coordinates using the local coordinate system.

pub fn face_areas(&self) -> Vec<f64>

Calculates the areas of each face of the Voronoi cell.

pub fn face_perimeters(&self) -> Vec<f64>

Calculates the perimeters of each face.

pub fn face_vertices(&self) -> Vec<Vec<usize>>

Returns the vertices that make up each face of the Voronoi cell, as indices into the vertices list.

pub fn normals(&self) -> Vec<[f64; 3]>

Calculates the normal vector of each face of the Voronoi cell, and scales it to the distance from the cell center to that plane.

pub fn max_radius_squared(&self) -> f64

Calculates the maximum radius squared of any vertex from the center of the cell. This can be used to determine when enough particles have been testing an all planes that could cut the cell have been considered.