Skip to content

Commit fd8eb28

Browse files
committed
Fix readme
1 parent 2fef639 commit fd8eb28

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,12 +71,12 @@ The following sections mainly focus on the CLI of `splashsurf`. For more informa
7171

7272
## Introduction
7373

74-
This is CLI to run a fast marching cubes based surface reconstruction for SPH fluid simulations (e.g., performed with [SPlisHSPlasH](https://github.com/InteractiveComputerGraphics/SPlisHSPlasH)).
75-
The output of this tool is the reconstructed triangle surface mesh of the fluid.
76-
At the moment, it supports computing normals on the surface using SPH gradients and interpolating scalar and vector particle attributes to the surface.
74+
The `splashsurf` CLI provides a "fast" marching cubes based surface reconstruction for particle data from SPH fluid simulations (e.g., performed with [SPlisHSPlasH](https://github.com/InteractiveComputerGraphics/SPlisHSPlasH)).
75+
The output of this tool is a (closed) triangle mesh of the fluid's surface.
76+
At the moment, it supports computing normals on the surface using SPH gradients and interpolating scalar and vector attributes defined on the particles to the surface.
7777
To get rid of the typical bumps from SPH simulations, it supports a weighted Laplacian smoothing approach [detailed below](#weighted-surface-smoothing).
7878
As input, it supports reading particle positions from `.vtk`/`.vtu`, `.bgeo`, `.ply`, `.json` and binary `.xyz` (i.e., files containing a binary dump of a particle position array) files.
79-
Required parameters to perform a reconstruction are the kernel radius and particle radius (to compute the volume of particles) used for the original SPH simulation as well as the marching cubes resolution (a default iso-surface threshold is pre-configured).
79+
Required parameters to perform a reconstruction are the kernel radius (its compact support) and particle radius (to compute the volume of particles) used for the original SPH simulation as well as the marching cubes resolution (a default iso-surface threshold is pre-configured).
8080

8181
## Domain decomposition
8282

@@ -91,7 +91,7 @@ To improve on this situation `splashsurf` utilizes a domain decomposition approa
9191
Since version 0.10.0, `splashsurf` implements a domain decomposition approach called the "subdomain grid" approach, toggled with the `--subdomain-grid=on` flag (default since version 0.11.0).
9292
Here, the goal is to divide the fluid domain into subdomains with a fixed number of marching cubes cells, by default `64x64x64` cubes.
9393
For each subdomain, a dense 3D array is allocated for the marching cubes cells.
94-
Of course, only subdomains that contain fluid particles are actually allocated.
94+
Of course, only subdomains that contain any fluid particles are actually allocated.
9595
For subdomains that contain only a tiny number of fluid particles (less than 5% of the largest subdomain), a hashmap is used instead to not waste too much storage.
9696
As most domains are dense, however, the marching cubes triangulation per subdomain is very fast as it can make full use of cache locality.
9797
The triangulation per subdomain can be performed in parallel.

splashsurf/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,12 @@ The following sections mainly focus on the CLI of `splashsurf`. For more informa
6464

6565
## Introduction
6666

67-
This is CLI to run a fast marching cubes based surface reconstruction for SPH fluid simulations (e.g., performed with [SPlisHSPlasH](https://github.com/InteractiveComputerGraphics/SPlisHSPlasH)).
68-
The output of this tool is the reconstructed triangle surface mesh of the fluid.
69-
At the moment, it supports computing normals on the surface using SPH gradients and interpolating scalar and vector particle attributes to the surface.
67+
The `splashsurf` CLI provides a "fast" marching cubes based surface reconstruction for particle data from SPH fluid simulations (e.g., performed with [SPlisHSPlasH](https://github.com/InteractiveComputerGraphics/SPlisHSPlasH)).
68+
The output of this tool is a (closed) triangle mesh of the fluid's surface.
69+
At the moment, it supports computing normals on the surface using SPH gradients and interpolating scalar and vector attributes defined on the particles to the surface.
7070
To get rid of the typical bumps from SPH simulations, it supports a weighted Laplacian smoothing approach [detailed below](#weighted-surface-smoothing).
7171
As input, it supports reading particle positions from `.vtk`/`.vtu`, `.bgeo`, `.ply`, `.json` and binary `.xyz` (i.e., files containing a binary dump of a particle position array) files.
72-
Required parameters to perform a reconstruction are the kernel radius and particle radius (to compute the volume of particles) used for the original SPH simulation as well as the marching cubes resolution (a default iso-surface threshold is pre-configured).
72+
Required parameters to perform a reconstruction are the kernel radius (its compact support) and particle radius (to compute the volume of particles) used for the original SPH simulation as well as the marching cubes resolution (a default iso-surface threshold is pre-configured).
7373

7474
## Domain decomposition
7575

@@ -84,7 +84,7 @@ To improve on this situation `splashsurf` utilizes a domain decomposition approa
8484
Since version 0.10.0, `splashsurf` implements a domain decomposition approach called the "subdomain grid" approach, toggled with the `--subdomain-grid=on` flag (default since version 0.11.0).
8585
Here, the goal is to divide the fluid domain into subdomains with a fixed number of marching cubes cells, by default `64x64x64` cubes.
8686
For each subdomain, a dense 3D array is allocated for the marching cubes cells.
87-
Of course, only subdomains that contain fluid particles are actually allocated.
87+
Of course, only subdomains that contain any fluid particles are actually allocated.
8888
For subdomains that contain only a tiny number of fluid particles (less than 5% of the largest subdomain), a hashmap is used instead to not waste too much storage.
8989
As most domains are dense, however, the marching cubes triangulation per subdomain is very fast as it can make full use of cache locality.
9090
The triangulation per subdomain can be performed in parallel.

0 commit comments

Comments
 (0)