Rename use_custom_grid_decomposition, add auto_disable_subdomain_grid

Author: w1th0utnam3

pysplashsurf/pysplashsurf/__init__.py

@@ -209,7 +209,8 @@ def reconstruct_surface(
     iso_surface_threshold: float = 0.6,
     enable_multi_threading: bool = False,
     global_neighborhood_list: bool = False,
-    subdomain_grid: bool = False,
+    subdomain_grid: bool = True,
+    auto_disable_subdomain_grid: bool = True,
     subdomain_num_cubes_per_dim: int = 64,
     aabb_min = None,
     aabb_max = None,
@@ -245,7 +246,10 @@ def reconstruct_surface(
         Global neighborhood list flag
     
     subdomain_grid: bool
-        Enable spatial decomposition using a regular grid-based approach
+        Enable spatial decomposition using by dividing the domain into subdomains with dense marching cube grids for efficient multi-threading
+
+    auto_disable_subdomain_grid: bool
+        Whether to automatically disable the subdomain grid if the global domain is too small
         
     subdomain_num_cubes_per_dim: int
         Each subdomain will be a cube consisting of this number of MC cube cells along each coordinate axis
@@ -267,13 +271,13 @@ def reconstruct_surface(
         return reconstruct_surface_f32(particles, particle_radius=particle_radius, rest_density=rest_density, 
                                 smoothing_length=smoothing_length, cube_size=cube_size, iso_surface_threshold=iso_surface_threshold, 
                                 enable_multi_threading=enable_multi_threading, global_neighborhood_list=global_neighborhood_list, 
-                                use_custom_grid_decomposition=subdomain_grid, subdomain_num_cubes_per_dim=subdomain_num_cubes_per_dim, 
+                                use_subdomain_grid=subdomain_grid, auto_disable_subdomain_grid=auto_disable_subdomain_grid, subdomain_num_cubes_per_dim=subdomain_num_cubes_per_dim,
                                 aabb_min=aabb_min, aabb_max=aabb_max)   
     elif particles.dtype == 'float64':
         return reconstruct_surface_f64(particles, particle_radius=particle_radius, rest_density=rest_density, 
                                 smoothing_length=smoothing_length, cube_size=cube_size, iso_surface_threshold=iso_surface_threshold, 
                                 enable_multi_threading=enable_multi_threading, global_neighborhood_list=global_neighborhood_list, 
-                                use_custom_grid_decomposition=subdomain_grid, subdomain_num_cubes_per_dim=subdomain_num_cubes_per_dim, 
+                                use_subdomain_grid=subdomain_grid, auto_disable_subdomain_grid=auto_disable_subdomain_grid, subdomain_num_cubes_per_dim=subdomain_num_cubes_per_dim,
                                 aabb_min=aabb_min, aabb_max=aabb_max)
     else:
         raise ValueError("Invalid data type (only float32 and float64 are supported, consider explicitly specifying the dtype for particles)")
@@ -530,7 +534,7 @@ def reconstruction_pipeline(
     mesh_smoothing_weights_normalization=13.0, mesh_smoothing_iters=None, normals_smoothing_iters=None,
     mesh_cleanup=False, mesh_cleanup_snap_dist=None, decimate_barnacles=False, keep_vertices=False,
     compute_normals=False, output_raw_normals=False, output_raw_mesh=False, output_mesh_smoothing_weights=False, mesh_aabb_clamp_vertices=False,
-    subdomain_grid=True, subdomain_num_cubes_per_dim=64, aabb_min=None, aabb_max=None, mesh_aabb_min=None, mesh_aabb_max=None,
+    subdomain_grid=True, auto_disable_subdomain_grid=True, subdomain_num_cubes_per_dim=64, aabb_min=None, aabb_max=None, mesh_aabb_min=None, mesh_aabb_max=None,
     generate_quads=False, quad_max_edge_diag_ratio=1.75, quad_max_normal_angle=10.0, quad_max_interior_angle=135.0
 ):
     """Surface reconstruction based on particle positions with subsequent post-processing
@@ -622,7 +626,10 @@ def reconstruction_pipeline(
         Flag to clamp the vertices of the mesh to the AABB
         
     subdomain_grid: bool
-        Enables spatial decomposition using a regular grid-based approach
+        Enable spatial decomposition using by dividing the domain into subdomains with dense marching cube grids for efficient multi-threading
+
+    auto_disable_subdomain_grid: bool
+        Whether to automatically disable the subdomain grid if the global domain is too small
     
     subdomain_num_cubes_per_dim: int
         Each subdomain will be a cube consisting of this number of MC cube cells along each coordinate axis
@@ -660,7 +667,7 @@ def reconstruction_pipeline(
         tri_mesh, tri_quad_mesh, reconstruction = reconstruction_pipeline_f32(particles, attributes_to_interpolate=attributes_to_interpolate, particle_radius=particle_radius, rest_density=rest_density, 
                                                                               smoothing_length=smoothing_length, cube_size=cube_size, iso_surface_threshold=iso_surface_threshold, 
                                                                               aabb_min=aabb_min, aabb_max=aabb_max, enable_multi_threading=enable_multi_threading, 
-                                                                              use_custom_grid_decomposition=subdomain_grid, subdomain_num_cubes_per_dim=subdomain_num_cubes_per_dim,
+                                                                              use_subdomain_grid=subdomain_grid, auto_disable_subdomain_grid=auto_disable_subdomain_grid, subdomain_num_cubes_per_dim=subdomain_num_cubes_per_dim,
                                                                               check_mesh_closed=check_mesh_closed, check_mesh_manifold=check_mesh_manifold, check_mesh_orientation=check_mesh_orientation, check_mesh_debug=check_mesh_debug,
                                                                               mesh_cleanup=mesh_cleanup, max_rel_snap_dist=mesh_cleanup_snap_dist, decimate_barnacles=decimate_barnacles,
                                                                               keep_vertices=keep_vertices, compute_normals=compute_normals, sph_normals=sph_normals, normals_smoothing_iters=normals_smoothing_iters,
@@ -678,7 +685,7 @@ def reconstruction_pipeline(
         tri_mesh, tri_quad_mesh, reconstruction = reconstruction_pipeline_f64(particles, attributes_to_interpolate=attributes_to_interpolate, particle_radius=particle_radius, rest_density=rest_density,
                                                                               smoothing_length=smoothing_length, cube_size=cube_size, iso_surface_threshold=iso_surface_threshold,
                                                                               aabb_min=aabb_min, aabb_max=aabb_max, enable_multi_threading=enable_multi_threading,
-                                                                              use_custom_grid_decomposition=subdomain_grid, subdomain_num_cubes_per_dim=subdomain_num_cubes_per_dim,
+                                                                              use_subdomain_grid=subdomain_grid, auto_disable_subdomain_grid=auto_disable_subdomain_grid, subdomain_num_cubes_per_dim=subdomain_num_cubes_per_dim,
                                                                               check_mesh_closed=check_mesh_closed, check_mesh_manifold=check_mesh_manifold, check_mesh_orientation=check_mesh_orientation, check_mesh_debug=check_mesh_debug,
                                                                               mesh_cleanup=mesh_cleanup, max_rel_snap_dist=mesh_cleanup_snap_dist, decimate_barnacles=decimate_barnacles,
                                                                               keep_vertices=keep_vertices, compute_normals=compute_normals, sph_normals=sph_normals, normals_smoothing_iters=normals_smoothing_iters,

pysplashsurf/src/pipeline.rs

@@ -27,7 +27,8 @@ fn reconstruction_pipeline_generic<I: Index, R: Real>(
     aabb_min: Option<[R; 3]>,
     aabb_max: Option<[R; 3]>,
     enable_multi_threading: bool,
-    use_custom_grid_decomposition: bool,
+    use_subdomain_grid: bool,
+    auto_disable_subdomain_grid: bool,
     subdomain_num_cubes_per_dim: u32,
     check_mesh_closed: bool,
     check_mesh_manifold: bool,
@@ -64,10 +65,11 @@ fn reconstruction_pipeline_generic<I: Index, R: Real>(
         None
     };
 
-    let spatial_decomposition = if use_custom_grid_decomposition {
-        let mut grid_params = GridDecompositionParameters::default();
-        grid_params.subdomain_num_cubes_per_dim = subdomain_num_cubes_per_dim;
-        SpatialDecomposition::UniformGrid(grid_params)
+    let spatial_decomposition = if use_subdomain_grid {
+        SpatialDecomposition::UniformGrid(GridDecompositionParameters {
+            subdomain_num_cubes_per_dim,
+            auto_disable: auto_disable_subdomain_grid,
+        })
     } else {
         SpatialDecomposition::None
     };
@@ -180,7 +182,7 @@ fn attrs_conversion<R: Real + Element>(
 #[pyo3(signature = (particles, *, attributes_to_interpolate, particle_radius, rest_density,
     smoothing_length, cube_size, iso_surface_threshold,
     aabb_min = None, aabb_max = None, enable_multi_threading = false,
-    use_custom_grid_decomposition = false, subdomain_num_cubes_per_dim = 64,
+    use_subdomain_grid = true, auto_disable_subdomain_grid = true, subdomain_num_cubes_per_dim = 64,
     check_mesh_closed = false, check_mesh_manifold = false, check_mesh_orientation = false, check_mesh_debug = false,
     mesh_cleanup, max_rel_snap_dist = None, decimate_barnacles, keep_vertices, compute_normals, sph_normals,
     normals_smoothing_iters, mesh_smoothing_iters, mesh_smoothing_weights, mesh_smoothing_weights_normalization,
@@ -199,7 +201,8 @@ pub fn reconstruction_pipeline_py_f32<'py>(
     aabb_min: Option<[f32; 3]>,
     aabb_max: Option<[f32; 3]>,
     enable_multi_threading: bool,
-    use_custom_grid_decomposition: bool,
+    use_subdomain_grid: bool,
+    auto_disable_subdomain_grid: bool,
     subdomain_num_cubes_per_dim: u32,
     check_mesh_closed: bool,
     check_mesh_manifold: bool,
@@ -252,7 +255,8 @@ pub fn reconstruction_pipeline_py_f32<'py>(
         aabb_min,
         aabb_max,
         enable_multi_threading,
-        use_custom_grid_decomposition,
+        use_subdomain_grid,
+        auto_disable_subdomain_grid,
         subdomain_num_cubes_per_dim,
         check_mesh_closed,
         check_mesh_manifold,
@@ -293,7 +297,7 @@ pub fn reconstruction_pipeline_py_f32<'py>(
 #[pyo3(signature = (particles, *, attributes_to_interpolate, particle_radius, rest_density,
     smoothing_length, cube_size, iso_surface_threshold,
     aabb_min = None, aabb_max = None, enable_multi_threading = false,
-    use_custom_grid_decomposition = false, subdomain_num_cubes_per_dim = 64,
+    use_subdomain_grid = true, auto_disable_subdomain_grid = true, subdomain_num_cubes_per_dim = 64,
     check_mesh_closed = false, check_mesh_manifold = false, check_mesh_orientation = false, check_mesh_debug = false,
     mesh_cleanup, max_rel_snap_dist = None, decimate_barnacles, keep_vertices, compute_normals, sph_normals,
     normals_smoothing_iters, mesh_smoothing_iters, mesh_smoothing_weights, mesh_smoothing_weights_normalization,
@@ -312,7 +316,8 @@ pub fn reconstruction_pipeline_py_f64<'py>(
     aabb_min: Option<[f64; 3]>,
     aabb_max: Option<[f64; 3]>,
     enable_multi_threading: bool,
-    use_custom_grid_decomposition: bool,
+    use_subdomain_grid: bool,
+    auto_disable_subdomain_grid: bool,
     subdomain_num_cubes_per_dim: u32,
     check_mesh_closed: bool,
     check_mesh_manifold: bool,
@@ -365,7 +370,8 @@ pub fn reconstruction_pipeline_py_f64<'py>(
         aabb_min,
         aabb_max,
         enable_multi_threading,
-        use_custom_grid_decomposition,
+        use_subdomain_grid,
+        auto_disable_subdomain_grid,
         subdomain_num_cubes_per_dim,
         check_mesh_closed,
         check_mesh_manifold,

pysplashsurf/src/reconstruction.rs

@@ -79,7 +79,8 @@ pub fn reconstruct_surface_py<I: Index, R: Real>(
     iso_surface_threshold: R,
     enable_multi_threading: bool,
     global_neighborhood_list: bool,
-    use_custom_grid_decomposition: bool,
+    use_subdomain_grid: bool,
+    auto_disable_subdomain_grid: bool,
     subdomain_num_cubes_per_dim: u32,
     aabb_min: Option<[R; 3]>,
     aabb_max: Option<[R; 3]>,
@@ -96,10 +97,11 @@ pub fn reconstruct_surface_py<I: Index, R: Real>(
     }
 
     let spatial_decomposition;
-    if use_custom_grid_decomposition {
-        let mut grid_params = GridDecompositionParameters::default();
-        grid_params.subdomain_num_cubes_per_dim = subdomain_num_cubes_per_dim;
-        spatial_decomposition = SpatialDecomposition::UniformGrid(grid_params);
+    if use_subdomain_grid {
+        spatial_decomposition = SpatialDecomposition::UniformGrid(GridDecompositionParameters {
+            subdomain_num_cubes_per_dim,
+            auto_disable: auto_disable_subdomain_grid,
+        });
     } else {
         spatial_decomposition = SpatialDecomposition::None;
     }
@@ -126,7 +128,7 @@ pub fn reconstruct_surface_py<I: Index, R: Real>(
 #[pyo3(name = "reconstruct_surface_f32")]
 #[pyo3(signature = (particles, *, particle_radius, rest_density,
     smoothing_length, cube_size, iso_surface_threshold, enable_multi_threading=false,
-    global_neighborhood_list=false, use_custom_grid_decomposition=false, subdomain_num_cubes_per_dim=64,
+    global_neighborhood_list=false, use_subdomain_grid=true, auto_disable_subdomain_grid=true, subdomain_num_cubes_per_dim=64,
     aabb_min = None, aabb_max = None
 ))]
 pub fn reconstruct_surface_py_f32<'py>(
@@ -138,7 +140,8 @@ pub fn reconstruct_surface_py_f32<'py>(
     iso_surface_threshold: f32,
     enable_multi_threading: bool,
     global_neighborhood_list: bool,
-    use_custom_grid_decomposition: bool,
+    use_subdomain_grid: bool,
+    auto_disable_subdomain_grid: bool,
     subdomain_num_cubes_per_dim: u32,
     aabb_min: Option<[f32; 3]>,
     aabb_max: Option<[f32; 3]>,
@@ -157,7 +160,8 @@ pub fn reconstruct_surface_py_f32<'py>(
         iso_surface_threshold,
         enable_multi_threading,
         global_neighborhood_list,
-        use_custom_grid_decomposition,
+        use_subdomain_grid,
+        auto_disable_subdomain_grid,
         subdomain_num_cubes_per_dim,
         aabb_min,
         aabb_max,
@@ -170,7 +174,7 @@ pub fn reconstruct_surface_py_f32<'py>(
 #[pyo3(name = "reconstruct_surface_f64")]
 #[pyo3(signature = (particles, *, particle_radius, rest_density,
     smoothing_length, cube_size, iso_surface_threshold, enable_multi_threading=false,
-    global_neighborhood_list=false, use_custom_grid_decomposition=false, subdomain_num_cubes_per_dim=64,
+    global_neighborhood_list=false, use_subdomain_grid=true, auto_disable_subdomain_grid=true, subdomain_num_cubes_per_dim=64,
     aabb_min = None, aabb_max = None
 ))]
 pub fn reconstruct_surface_py_f64<'py>(
@@ -182,7 +186,8 @@ pub fn reconstruct_surface_py_f64<'py>(
     iso_surface_threshold: f64,
     enable_multi_threading: bool,
     global_neighborhood_list: bool,
-    use_custom_grid_decomposition: bool,
+    use_subdomain_grid: bool,
+    auto_disable_subdomain_grid: bool,
     subdomain_num_cubes_per_dim: u32,
     aabb_min: Option<[f64; 3]>,
     aabb_max: Option<[f64; 3]>,
@@ -201,7 +206,8 @@ pub fn reconstruct_surface_py_f64<'py>(
         iso_surface_threshold,
         enable_multi_threading,
         global_neighborhood_list,
-        use_custom_grid_decomposition,
+        use_subdomain_grid,
+        auto_disable_subdomain_grid,
         subdomain_num_cubes_per_dim,
         aabb_min,
         aabb_max,