Prepare release

Author: w1th0utnam3

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 The following changes are present in the `main` branch of the repository and are not yet part of a release:
 
+ - No major changes since last release
+
+## Version 0.9.2
+
  - Lib: In the `UniformCartesianCubeGrid3d::from_aabb` constructor, re-align the min-coordinate of the AABB to multiples of the cube size by default. This way multiple frames of an animation will be automatically consistent in terms of marching cubes grid alignment without having to manually specify an AABB for the entire simulation.
 
 ## Version 0.9.1

README.md

@@ -231,7 +231,7 @@ The file format is inferred from the extension of output filename.
 
 ### The `reconstruct` command
 ```
-splashsurf-reconstruct (v0.9.0) - Reconstruct a surface from particle data
+splashsurf-reconstruct (v0.9.2) - Reconstruct a surface from particle data
 
 Usage: splashsurf.exe reconstruct [OPTIONS] --particle-radius <PARTICLE_RADIUS> --smoothing-length <SMOOTHING_LENGTH> --cube-size <CUBE_SIZE> <--input-file <INPUT_FILE>|--input-sequence <INPUT_SEQUENCE>>
 

splashsurf/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "splashsurf"
-version = "0.9.1"
+version = "0.9.2"
 authors = ["Fabian Löschner <[email protected]>"]
 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.9", features = ["vtk_extras", "profiling", "io"] }
+splashsurf_lib = { path = "../splashsurf_lib", version = "0.9.2", features = ["vtk_extras", "profiling", "io"] }
 clap = { version = "4.3", features = ["derive"] }
 log = "0.4"
 fern = "0.6"

splashsurf/README.md

@@ -64,17 +64,17 @@ By default, a domain decomposition of the particle set is performed using octree
 The implementation first computes the density of each particle using the typical SPH approach with a cubic kernel.
 This density is then evaluated or mapped onto a sparse grid using spatial hashing in the support radius of each particle.
 This implies that memory is only allocated in areas where the fluid density is non-zero. This is in contrast to a naive approach where the marching cubes background grid is allocated for the whole domain.
-The marching cubes reconstruction is performed only in the narrow band of grid cells where the density values cross the surface threshold. Cells completely in the interior of the fluid are skipped. For more details, please refer to the [readme of the library]((https://github.com/w1th0utnam3/splashsurf/blob/main/splashsurf_lib/README.md)).
+The marching cubes reconstruction is performed only in the narrowband of grid cells where the density values cross the surface threshold. Cells completely in the interior of the fluid are skipped. For more details, please refer to the [readme of the library]((https://github.com/w1th0utnam3/splashsurf/blob/main/splashsurf_lib/README.md)).
 Finally, all surface patches are stitched together by walking the octree back up, resulting in a closed surface.
 
 ## Notes
 
-Due the use of hash maps and multi-threading (if enabled), the output of this implementation is not deterministic.
-In the future, flags may be added to switch the internal data structures to use binary trees for debugging purposes.
-
-Note that for small numbers of fluid particles (i.e. in the low thousands or less) the multi-threaded implementation may have worse performance due to the task based parallelism and the additional overhead of domain decomposition and stitching.
+For small numbers of fluid particles (i.e. in the low thousands or less) the multithreaded implementation may have worse performance due to the task based parallelism and the additional overhead of domain decomposition and stitching.
 In this case, you can try to disable the domain decomposition. The reconstruction will then use a global approach that is parallelized using thread-local hashmaps.
-For larger quantities of particles the decomposition approach will be faster, however.
+For larger quantities of particles the decomposition approach is expected to be always faster.
+
+Due to the use of hash maps and multi-threading (if enabled), the output of this implementation is not deterministic.
+In the future, flags may be added to switch the internal data structures to use binary trees for debugging purposes.
 
 As shown below, the tool can handle the output of large simulations.
 However, it was not tested with a wide range of parameters and may not be totally robust against corner-cases or extreme parameters.
@@ -95,7 +95,7 @@ Good settings for the surface reconstruction depend on the original simulation a
 - `particle-radius`: should be a bit larger than the particle radius used for the actual simulation. A radius around 1.4 to 1.6 times larger than the original SPH particle radius seems to be appropriate.
 - `smoothing-length`: should be set around `1.2`. Larger values smooth out the iso-surface more but also artificially increase the fluid volume.
 - `surface-threshold`: a good value depends on the selected `particle-radius` and `smoothing-length` and can be used to counteract a fluid volume increase e.g. due to a larger particle radius. In combination with the other recommended values a threshold of `0.6` seemed to work well.
-- `cube-size` i.e. marching cubes resolution of less than `1.0`, e.g. start with `0.5` and increase/decrease it if the result is not smooth enough or the reconstruction takes too long.
+- `cube-size` usually should not be chosen larger than `1.0` to avoid artifacts (e.g. single particles decaying into rhomboids), start with a value in the range of `0.75` to `0.5` and decrease/increase it if the result is too coarse or the reconstruction takes too long.
 
 ### Benchmark example
 For example:
@@ -225,7 +225,7 @@ The file format is inferred from the extension of output filename.
 
 ### The `reconstruct` command
 ```
-splashsurf-reconstruct (v0.9.0) - Reconstruct a surface from particle data
+splashsurf-reconstruct (v0.9.2) - Reconstruct a surface from particle data
 
 Usage: splashsurf.exe reconstruct [OPTIONS] --particle-radius <PARTICLE_RADIUS> --smoothing-length <SMOOTHING_LENGTH> --cube-size <CUBE_SIZE> <--input-file <INPUT_FILE>|--input-sequence <INPUT_SEQUENCE>>
 

splashsurf_lib/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "splashsurf_lib"
-version = "0.9.0"
+version = "0.9.2"
 authors = ["Fabian Löschner <[email protected]>"]
 license = "MIT"
 description = "Library for surface reconstruction of SPH particle data"