Update changelog, bump versions, update some help strings

Author: w1th0utnam3

CHANGELOG.md

@@ -1,12 +1,25 @@
 ## Master
 
- - Lib: Implemented an own `profile!` macro that also works in multi-threaded code, i.e. with together with `rayon`
- - CLI: The CLI now also prints detailed profiling/timing output when running in parallel with domain decomposition thanks to the new `profile` macro
-
 ### Short-term goals
- - Investigate and fix artifacts with domain decomposition in large, flat surfaces
  - Implement export of surface normals via the CLI
 
+## Version 0.6.0
+
+This release fixes a couple of bugs that may lead to inconsistent surface reconstructions when using domain decomposition (i.e. reconstructions with artificial bumps exactly at the subdomain boundaries, especially on flat surfaces). Currently there are no other known bugs and the domain decomposed approach appears to be really fast and robust.
+
+In addition the CLI now reports more detailed timing statistics for multi-threaded reconstructions.
+
+Otherwise this release contains just some small changes to command line parameters.
+
+ - Lib: Add a `ParticleDensityComputationStrategy` enum to the `SpatialDecompositionParameters` struct. In order for domain decomposition to work consistently, the per particle densities have to be evaluated to a consistent value between domains. This is especially important for the ghost particles. Previously, this resulted inconsistent density values on boundaries if the ghost particle margin was not at least 2x the compact support radius (as this ensures that the inner ghost particles actually have the correct density). This option is now still available as the `IndependentSubdomains` strategy. The preferred way, that avoids the 2x ghost particle margin is the `SynchronizeSubdomains` where the density values of the particles in the subdomains are first collected into a global storage. This can be faster as the previous method as this avoids having to collect a double-width ghost particle layer. In addition there is the "playing it safe" option, the `Global` strategy, where the particle densities are computed in a completely global step before any domain decomposition. This approach however is *really* slow for large quantities of particles. For more information, read the documentation on the `ParticleDensityComputationStrategy` enum.
+ - Lib: Fix bug where the workspace storage was not cleared correctly leading to inconsistent results depending on the sequence of processed subdomains
+ - Lib: Fix bug in the octree splitting where ghost particles of a parent node were actually classified as non-ghost particles in the child node, leading to many subsequent splits
+ - Lib: Change AABB's `contains_point` method such that it now considers the AABB as "open" to its max value, i.e. it checks if the point is in the half-open set `[min, max[`
+ - Lib: Implemented an own `profile!` macro that also works in multi-threaded code, i.e. with together with `rayon`
+ - CLI: The CLI now also prints detailed profiling/timing output when running in parallel with domain decomposition thanks to the new `profile` macro
+ - CLI: Add `--domain-min` and `--domain-max` flags to the `convert` subcommand that allows to filter out particles
+ - CLI: Remove the `--splash-detection-radius` flag as it did not work for a couple of releases
+
 ## Version 0.5.1
 
  - Lib: Fixed bug in triangulation that resulted in at most 4 out 5 possible triangles being emitted. This resulted in holes in surface meshes in some cases.

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "splashsurf"
-version = "0.5.0"
+version = "0.6.0"
 authors = ["Fabian Löschner <loeschner@cs.rwth-aachen.de>"]
 license = "MIT"
 description = "Command-line tool for surface reconstruction of SPH particle data"
@@ -13,7 +13,7 @@ homepage = "https://github.com/w1th0utnam3/splashsurf"
 repository = "https://github.com/w1th0utnam3/splashsurf"
 
 [dependencies]
-splashsurf_lib = { path = "../splashsurf_lib", version = "0.5", features = ["vtk_extras", "profiling"] }
+splashsurf_lib = { path = "../splashsurf_lib", version = "0.6", features = ["vtk_extras", "profiling"] }
 structopt = "0.3"
 log = "0.4"
 fern = "0.6"

splashsurf/Cargo.toml

@@ -21,7 +21,7 @@ pub struct ReconstructSubcommandArgs {
     /// Path to the input file where the particle positions are stored (supported formats: VTK, binary f32 XYZ, PLY, BGEO)
     #[structopt(short = "-i", long, parse(from_os_str))]
     input_file: Option<PathBuf>,
-    /// Path to a sequence of particle files that should be processed, use `{}` in the filename to indicated a placeholder
+    /// Path to a sequence of particle files that should be processed, use `{}` in the filename to indicate a placeholder
     #[structopt(
         name = "input_sequence_pattern",
         short = "-s",
@@ -47,7 +47,7 @@ pub struct ReconstructSubcommandArgs {
     /// The cube edge length used for marching cubes in multiplies of the particle radius, corresponds to the cell size of the implicit background grid
     #[structopt(long)]
     cube_size: f64,
-    /// The iso-surface threshold for the density, i.e. value of the reconstructed density that indicates the fluid surface (in multiplies of the rest density)
+    /// The iso-surface threshold for the density, i.e. the normalized value of the reconstructed density level that indicates the fluid surface (in multiplies of the rest density)
     #[structopt(long, default_value = "0.6")]
     surface_threshold: f64,
     /// Whether to enable the use of double precision for all computations
@@ -72,13 +72,13 @@ pub struct ReconstructSubcommandArgs {
     /// Whether to enable spatial decomposition using an octree (faster) instead of a global approach
     #[structopt(long, default_value = "on", possible_values = &["on", "off"], case_insensitive = true)]
     octree_decomposition: Switch,
-    /// Whether to enable stitching of the disconnected local meshes when spatial decomposition is enabled (slower, but without stitching meshes will not be closed)
+    /// Whether to enable stitching of the disconnected local meshes resulting from the reconstruction when spatial decomposition is enabled (slower, but without stitching meshes will not be closed)
     #[structopt(long, default_value = "on", possible_values = &["on", "off"], case_insensitive = true)]
     octree_stitch_subdomains: Switch,
-    /// The maximum number of particles for leaf nodes of the octree, default is to compute it based on number of threads and particles
+    /// The maximum number of particles for leaf nodes of the octree, default is to compute it based on the number of threads and particles
     #[structopt(long)]
     octree_max_particles: Option<usize>,
-    /// Safety factor applied to the kernel compact support radius when it's used as a margin to collect ghost particles in the leaf nodes
+    /// Safety factor applied to the kernel compact support radius when it's used as a margin to collect ghost particles in the leaf nodes when performing the spatial decomposition
     #[structopt(long)]
     octree_ghost_margin_factor: Option<f64>,
     /// Whether to compute particle densities in a global step before domain decomposition (slower)

splashsurf/src/reconstruction.rs

@@ -1,6 +1,6 @@
 [package]
 name = "splashsurf_lib"
-version = "0.5.1"
+version = "0.6.0"
 authors = ["Fabian Löschner <loeschner@cs.rwth-aachen.de>"]
 license = "MIT"
 description = "Library for surface reconstruction of SPH particle data"