Loosen trait bounds on structs and enums

Author: w1th0utnam3

splashsurf_lib/src/aabb.rs

@@ -1,16 +1,13 @@
 //! Axis-aligned bounding boxes
 
-use std::fmt;
-use std::fmt::Debug;
-
 use nalgebra::SVector;
 use rayon::prelude::*;
 
-use crate::{Real, RealConvert, ThreadSafe};
+use crate::{Real, RealConvert, Scalar, ThreadSafe};
 
 /// Type representing an axis aligned bounding box in arbitrary dimensions
-#[derive(Clone, Eq, PartialEq)]
-pub struct AxisAlignedBoundingBox<R: Real, const D: usize> {
+#[derive(Clone, Debug, Eq, PartialEq)]
+pub struct AxisAlignedBoundingBox<R: Scalar, const D: usize> {
     min: SVector<R, D>,
     max: SVector<R, D>,
 }
@@ -274,19 +271,6 @@ where
     }
 }
 
-impl<R, const D: usize> Debug for AxisAlignedBoundingBox<R, D>
-where
-    R: Real,
-{
-    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(
-            f,
-            "AxisAlignedBoundingBox {{ min: [{:.7}, {:.7}, {:.7}], max: [{:.7}, {:.7}, {:.7}] }}",
-            self.min[0], self.min[1], self.min[2], self.max[0], self.max[1], self.max[2]
-        )
-    }
-}
-
 #[test]
 fn test_aabb_contains_point() {
     use crate::nalgebra::Vector3;

splashsurf_lib/src/density_map.rs

@@ -32,10 +32,11 @@ use crate::utils::{ChunkSize, ParallelPolicy};
 use crate::{HashState, Index, MapType, ParallelMapType, Real, new_map, profile};
 use dashmap::ReadOnlyView as ReadDashMap;
 use log::{info, trace, warn};
-use nalgebra::Vector3;
+use nalgebra::{Scalar, Vector3};
 use rayon::prelude::*;
 use std::borrow::Cow;
 use std::cell::RefCell;
+use std::hash::Hash;
 use thiserror::Error as ThisError;
 use thread_local::ThreadLocal;
 
@@ -44,7 +45,7 @@ use thread_local::ThreadLocal;
 
 /// Errors that can occur during generation of the density map
 #[derive(Debug, ThisError)]
-pub enum DensityMapError<R: Real> {
+pub enum DensityMapError<R: Scalar> {
     /// Indicates that domain for the density map is inconsistent or degenerate
     ///
     /// For the density map computation the user specified domain is shrunk ensuring that all
@@ -225,7 +226,7 @@ pub fn parallel_compute_particle_densities<I: Index, R: Real>(
 /// The density map contains values for all points of the background grid where the density is not
 /// trivially zero (which is the case when a point is outside the compact support of any particles).
 #[derive(Clone, Debug)]
-pub enum DensityMap<'a, I: Index, R: Real> {
+pub enum DensityMap<'a, I: Scalar + Eq + Hash, R: Scalar> {
     Standard(MapType<I, R>),
     DashMap(ReadDashMap<I, R, HashState>),
     Dense(Cow<'a, [R]>),

splashsurf_lib/src/halfedge_mesh.rs

@@ -4,7 +4,7 @@
 
 use crate::mesh::{Mesh3d, TriMesh3d, TriMesh3dExt};
 use crate::{Real, SetType, profile};
-use nalgebra::Vector3;
+use nalgebra::{Scalar, Vector3};
 use rayon::prelude::*;
 use thiserror::Error as ThisError;
 
@@ -54,7 +54,7 @@ impl HalfEdge {
 /// [`is_valid_vertex`](HalfEdgeTriMesh::is_valid_vertex)/[`is_valid_triangle`](HalfEdgeTriMesh::is_valid_triangle)/[`is_valid_half_edge`](HalfEdgeTriMesh::is_valid_half_edge)
 /// methods.
 #[derive(Clone, Debug, Default)]
-pub struct HalfEdgeTriMesh<R: Real> {
+pub struct HalfEdgeTriMesh<R: Scalar> {
     /// All vertices in the mesh
     pub vertices: Vec<Vector3<R>>,
     /// All triangles in the mesh

splashsurf_lib/src/lib.rs

@@ -26,6 +26,7 @@
 use log::info;
 /// Re-export the version of `nalgebra` used by this crate
 pub use nalgebra;
+use nalgebra::Scalar;
 use nalgebra::Vector3;
 use std::borrow::Cow;
 use std::hash::Hash;
@@ -154,7 +155,7 @@ impl Default for GridDecompositionParameters {
 
 /// Parameters for the surface reconstruction
 #[derive(Clone, Debug)]
-pub struct Parameters<R: Real> {
+pub struct Parameters<R: Scalar> {
     /// Radius per particle (used to calculate the particle volume)
     pub particle_radius: R,
     /// Rest density of the fluid
@@ -237,7 +238,7 @@ impl<R: Real> Parameters<R> {
 
 /// Result data returned when the surface reconstruction was successful
 #[derive(Clone, Debug)]
-pub struct SurfaceReconstruction<I: Index, R: Real> {
+pub struct SurfaceReconstruction<I: Scalar, R: Scalar + Send + Default> {
     /// Background grid that was used as a basis for generating the density map for marching cubes
     pub grid: UniformGrid<I, R>,
     /// Per particle densities (contains only data of particles inside the domain)

splashsurf_lib/src/mesh.rs

@@ -15,7 +15,7 @@
 //!  - [`IntoVtkUnstructuredGridPiece`] to convert basic meshes and meshes with attached attributes to the
 //!  - [`IntoVtkDataSet`] for all meshes implementing [`IntoVtkUnstructuredGridPiece`] to directly save a mesh as a VTK file
 
-use crate::{Aabb3d, MapType, Real, RealConvert, new_map, profile};
+use crate::{Aabb3d, MapType, Real, RealConvert, Scalar, new_map, profile};
 use bytemuck_derive::{Pod, Zeroable};
 use nalgebra::{Unit, Vector3};
 use rayon::prelude::*;
@@ -159,7 +159,7 @@ impl<R: Real> TriMesh3dExt<R> for TriMesh3d<R> {
 ///
 /// The attribute data can be owned or borrowed.
 #[derive(Clone, Debug)]
-pub struct MeshAttribute<'a, R: Real> {
+pub struct MeshAttribute<'a, R: Scalar> {
     /// Name of the attribute
     pub name: String,
     /// Data of the attribute
@@ -174,7 +174,7 @@ pub type OwnedMeshAttribute<R> = MeshAttribute<'static, R>;
 /// Each value in the data-set is associated to a point or cell of the mesh.
 /// Data can be owned or borrowed.
 #[derive(Clone, Debug)]
-pub enum AttributeData<'a, R: Real> {
+pub enum AttributeData<'a, R: Scalar> {
     ScalarU64(Cow<'a, [u64]>),
     ScalarReal(Cow<'a, [R]>),
     Vector3Real(Cow<'a, [Vector3<R>]>),
@@ -185,7 +185,7 @@ pub type OwnedAttributeData<R> = AttributeData<'static, R>;
 
 /// A triangle (surface) mesh in 3D
 #[derive(Clone, Debug, Default)]
-pub struct TriMesh3d<R: Real> {
+pub struct TriMesh3d<R: Scalar> {
     /// Coordinates of all vertices of the mesh
     pub vertices: Vec<Vector3<R>>,
     /// The triangles of the mesh identified by their vertex indices
@@ -229,7 +229,7 @@ impl TriangleOrQuadCell {
 
 /// A surface mesh in 3D containing cells representing either triangles or quadrilaterals
 #[derive(Clone, Debug, Default)]
-pub struct MixedTriQuadMesh3d<R: Real> {
+pub struct MixedTriQuadMesh3d<R: Scalar> {
     /// Coordinates of all vertices of the mesh
     pub vertices: Vec<Vector3<R>>,
     /// All triangle and quad cells of the mesh
@@ -238,7 +238,7 @@ pub struct MixedTriQuadMesh3d<R: Real> {
 
 /// A hexahedral (volumetric) mesh in 3D
 #[derive(Clone, Debug, Default)]
-pub struct HexMesh3d<R: Real> {
+pub struct HexMesh3d<R: Scalar> {
     /// Coordinates of all vertices of the mesh
     pub vertices: Vec<Vector3<R>>,
     /// The hexahedral cells of the mesh identified by their vertex indices
@@ -247,7 +247,7 @@ pub struct HexMesh3d<R: Real> {
 
 /// A point cloud in 3D
 #[derive(Clone, Debug, Default)]
-pub struct PointCloud3d<R: Real> {
+pub struct PointCloud3d<R: Scalar> {
     /// Coordinates of all points in the point cloud
     points: Vec<Vector3<R>>,
     /// Indices of the points (for `CellConnectivity`)
@@ -330,7 +330,7 @@ where
         }
     }
 
-    /// Removes all cells from the mesh that are completely outside of the given AABB and clamps the remaining cells to the boundary
+    /// Removes all cells from the mesh that are completely outside the given AABB and clamps the remaining cells to the boundary
     fn par_clamp_with_aabb(
         &self,
         aabb: &Aabb3d<R>,

splashsurf_lib/src/uniform_grid.rs

@@ -5,7 +5,7 @@ use crate::{Aabb3d, Index, Real};
 use bitflags::bitflags;
 use itertools::iproduct;
 use log::trace;
-use nalgebra::Vector3;
+use nalgebra::{Scalar, Vector3};
 use num_traits::Bounded;
 use std::iter::Iterator;
 use thiserror::Error as ThisError;
@@ -107,7 +107,7 @@ pub type UniformGrid<I, R> = UniformCartesianCubeGrid3d<I, R>;
 
 /// Helper type for connectivity information on a 3D cartesian grid based on uniform cubes
 ///
-/// This type represents a virtual or implicit three dimensional cartesian grid in based on uniform cubes.
+/// This type represents a virtual or implicit three-dimensional cartesian grid in based on uniform cubes.
 /// It provides helper functions to access connectivity of points (vertices), edges and cells on
 /// the virtual grid.
 ///
@@ -127,7 +127,7 @@ pub type UniformGrid<I, R> = UniformCartesianCubeGrid3d<I, R>;
 /// functions respectively. These functions check if the specified indices are in the valid index range
 /// of the grid (as computed during construction based on the extents of the grid).
 #[derive(Clone, PartialEq, Debug)]
-pub struct UniformCartesianCubeGrid3d<I: Index, R: Real> {
+pub struct UniformCartesianCubeGrid3d<I: Scalar, R: Scalar> {
     /// AABB of the grid. Note that the grid may extend beyond the max coordinate of the AABB by less than the `cell_size`.
     aabb: Aabb3d<R>,
     /// The edge length of the cubes in the grid

splashsurf_lib/src/workspace.rs

@@ -1,6 +1,6 @@
 //! Workspace for reusing allocated memory between multiple surface reconstructions
 
-use crate::Real;
+use crate::{Real, Scalar};
 use nalgebra::Vector3;
 use std::cell::RefCell;
 use std::fmt;
@@ -9,7 +9,7 @@ use thread_local::ThreadLocal;
 
 /// Collection of all thread local workspaces used to reduce allocations on subsequent surface reconstructions
 #[derive(Default)]
-pub struct ReconstructionWorkspace<R: Real> {
+pub struct ReconstructionWorkspace<R: Scalar + Send> {
     /// Temporary storage for storing a filtered set of the user provided particles
     filtered_particles: Vec<Vector3<R>>,
     local_workspaces: ThreadLocal<RefCell<LocalReconstructionWorkspace<R>>>,
@@ -31,22 +31,22 @@ impl<R: Real> ReconstructionWorkspace<R> {
     }
 }
 
-impl<R: Real> Clone for ReconstructionWorkspace<R> {
+impl<R: Scalar + Send + Default> Clone for ReconstructionWorkspace<R> {
     /// Returns a new default workspace without any allocated memory
     fn clone(&self) -> Self {
         ReconstructionWorkspace::default()
     }
 }
 
-impl<R: Real> Debug for ReconstructionWorkspace<R> {
+impl<R: Scalar + Send> Debug for ReconstructionWorkspace<R> {
     /// Only print the name of type to the formatter
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         f.debug_struct("ReconstructionWorkspace").finish()
     }
 }
 
 /// Workspace used by [`reconstruct_surface_inplace`] internally to re-use allocated memory
-pub(crate) struct LocalReconstructionWorkspace<R: Real> {
+pub(crate) struct LocalReconstructionWorkspace<R: Scalar> {
     /// Storage for per particle neighbor lists
     pub particle_neighbor_lists: Vec<Vec<usize>>,
     /// Storage for per particle densities