Trait voroxx::VoronoiCellBase

pub trait VoronoiCellBase: VoronoiCellBaseFFI {
    pub fn number_of_faces(&self) -> i32 { ... }
    pub fn number_of_edges(&self) -> i32 { ... }
    pub fn number_of_vertices(&self) -> i32 { ... }
    pub fn translate(&mut self, xyz: &[f64; 3]) { ... }
    pub fn surface_area(&self) -> f64 { ... }
    pub fn volume(&self) -> f64 { ... }
    pub fn total_edge_distance(&self) -> f64 { ... }
    pub fn centroid(&self) -> [f64; 3] { ... }
    pub fn vertices(&self) -> Vec<[f64; 3]> { ... }
    pub fn face_areas(&self) -> Vec<f64> { ... }
    pub fn face_perimeters(&self) -> Vec<f64> { ... }
    pub fn face_vertices(&self) -> Vec<Vec<usize>> { ... }
    pub fn normals(&self) -> Vec<[f64; 3]> { ... }
    pub fn max_radius_squared(&self) -> f64 { ... }
}

Methods which are common to both variants of Voronoi cells.

Provided methods

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.

Returns (x, y, z) coordinates of the centroid.

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.

Loading content...

Implementors

impl VoronoiCellBase for VoronoiCell

impl VoronoiCellBase for VoronoiCellNeighbor

Loading content...