You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
8
8
@@ -28,10 +28,11 @@ then be fed into 3D rendering software such as [Blender](https://www.blender.org
28
28
The result might look something like this (please excuse the lack of 3D rendering skills):
29
29
30
30
<palign="center">
31
-
<imgsrc="https://raw.githubusercontent.com/w1th0utnam3/w1th0utnam3.github.io/master/splashsurf.gif"alt="Rendered water animation"width="96%">
31
+
<imgsrc="https://raw.githubusercontent.com/w1th0utnam3/w1th0utnam3.github.io/main/splashsurf.gif"alt="Rendered water animation"width="96%">
32
32
</p>
33
33
34
34
**Contents**
35
+
-[!splashsurf logo](#)
35
36
-[The `splashsurf` CLI](#the-splashsurf-cli)
36
37
-[Introduction](#introduction)
37
38
-[Notes](#notes)
@@ -54,7 +55,7 @@ The result might look something like this (please excuse the lack of 3D renderin
54
55
55
56
# The `splashsurf` CLI
56
57
57
-
The following sections mainly focus on the CLI of `splashsurf`. For more information on the library, see the [corresponding readme](https://github.com/w1th0utnam3/splashsurf/blob/master/splashsurf_lib) in the `splashsurf_lib` subfolder or the [`splashsurf_lib` crate](https://crates.io/crates/splashsurf_lib) on crates.io.
58
+
The following sections mainly focus on the CLI of `splashsurf`. For more information on the library, see the [corresponding readme](https://github.com/w1th0utnam3/splashsurf/blob/main/splashsurf_lib) in the `splashsurf_lib` subfolder or the [`splashsurf_lib` crate](https://crates.io/crates/splashsurf_lib) on crates.io.
58
59
59
60
## Introduction
60
61
@@ -67,7 +68,7 @@ By default, a domain decomposition of the particle set is performed using octree
67
68
The implementation first computes the density of each particle using the typical SPH approach with a cubic kernel.
68
69
This density is then evaluated or mapped onto a sparse grid using spatial hashing in the support radius of each particle.
69
70
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.
70
-
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/master/splashsurf_lib/README.md)).
71
+
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)).
71
72
Finally, all surface patches are stitched together by walking the octree back up, resulting in a closed surface.
8
8
9
-
CLI for surface reconstruction of particle data from SPH simulations, written in Rust.
9
+
CLI for surface reconstruction of particle data from SPH simulations, written in Rust. For a the library used by the CLI see the [`splashsurf_lib`](https://crates.io/crates/splashsurf_lib) crate.
10
10
11
11
<palign="center">
12
-
<imgsrc="https://raw.githubusercontent.com/w1th0utnam3/splashsurf/master/example_particles.png"alt="Image of the original particle data"width="32%"> <imgsrc="https://raw.githubusercontent.com/w1th0utnam3/splashsurf/master/example_coarse.png"alt="Image of a coarse reconstructed surface mesh"width="32%"> <imgsrc="https://raw.githubusercontent.com/w1th0utnam3/splashsurf/master/example_fine.png"alt="Image of a fine reconstructed surface mesh"width="32%">
12
+
<imgsrc="https://raw.githubusercontent.com/w1th0utnam3/splashsurf/main/example_particles.png"alt="Image of the original particle data"width="32%"> <imgsrc="https://raw.githubusercontent.com/w1th0utnam3/splashsurf/main/example_coarse.png"alt="Image of a coarse reconstructed surface mesh"width="32%"> <imgsrc="https://raw.githubusercontent.com/w1th0utnam3/splashsurf/main/example_fine.png"alt="Image of a fine reconstructed surface mesh"width="32%">
13
13
</p>
14
14
15
15
`splashsurf` is a tool to reconstruct surfaces meshes from SPH particle data.
@@ -22,10 +22,11 @@ then be fed into 3D rendering software such as [Blender](https://www.blender.org
22
22
The result might look something like this (please excuse the lack of 3D rendering skills):
23
23
24
24
<palign="center">
25
-
<imgsrc="https://raw.githubusercontent.com/w1th0utnam3/w1th0utnam3.github.io/master/splashsurf.gif"alt="Rendered water animation"width="96%">
25
+
<imgsrc="https://raw.githubusercontent.com/w1th0utnam3/w1th0utnam3.github.io/main/splashsurf.gif"alt="Rendered water animation"width="96%">
26
26
</p>
27
27
28
28
**Contents**
29
+
-[!splashsurf logo](#)
29
30
-[The `splashsurf` CLI](#the-splashsurf-cli)
30
31
-[Introduction](#introduction)
31
32
-[Notes](#notes)
@@ -48,7 +49,7 @@ The result might look something like this (please excuse the lack of 3D renderin
48
49
49
50
# The `splashsurf` CLI
50
51
51
-
The following sections mainly focus on the CLI of `splashsurf`. For more information on the library, see the [corresponding readme](https://github.com/w1th0utnam3/splashsurf/blob/master/splashsurf_lib) in the `splashsurf_lib` subfolder or the [`splashsurf_lib` crate](https://crates.io/crates/splashsurf_lib) on crates.io.
52
+
The following sections mainly focus on the CLI of `splashsurf`. For more information on the library, see the [corresponding readme](https://github.com/w1th0utnam3/splashsurf/blob/main/splashsurf_lib) in the `splashsurf_lib` subfolder or the [`splashsurf_lib` crate](https://crates.io/crates/splashsurf_lib) on crates.io.
52
53
53
54
## Introduction
54
55
@@ -61,7 +62,7 @@ By default, a domain decomposition of the particle set is performed using octree
61
62
The implementation first computes the density of each particle using the typical SPH approach with a cubic kernel.
62
63
This density is then evaluated or mapped onto a sparse grid using spatial hashing in the support radius of each particle.
63
64
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.
64
-
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/master/splashsurf_lib/README.md)).
65
+
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)).
65
66
Finally, all surface patches are stitched together by walking the octree back up, resulting in a closed surface.
-**vtk-extras**:Enablesconveniencetraitsandhelperfunctionstoconvertthemeshtypesreturnedbythelibraryto [`vtkio`](https://crates.io/crates/vtkio) data structures (in particular [`UnstructuredGridPiece`](https://docs.rs/vtkio/latest/vtkio/model/struct.UnstructuredGridPiece.html)) that can be used to easily write the meshes to VTK files (e.g. for viewing them with [Paraview](https://www.paraview.org/)). Check out the documentation of `vtkio` or the [corresponding io module](https://github.com/w1th0utnam3/splashsurf/blob/master/splashsurf/src/io/vtk_format.rs) of the `splashsurf` CLI for reference.
31
+
-**vtk-extras**:Enablesconveniencetraitsandhelperfunctionstoconvertthemeshtypesreturnedbythelibraryto [`vtkio`](https://crates.io/crates/vtkio) data structures (in particular [`UnstructuredGridPiece`](https://docs.rs/vtkio/latest/vtkio/model/struct.UnstructuredGridPiece.html)) that can be used to easily write the meshes to VTK files (e.g. for viewing them with [Paraview](https://www.paraview.org/)). Check out the documentation of `vtkio` or the [corresponding io module](https://github.com/w1th0utnam3/splashsurf/blob/main/splashsurf/src/io/vtk_format.rs) of the `splashsurf` CLI for reference.
32
32
-**profiling**:Enablesprofilingofthelibraryusing [`coarse-prof`](https://crates.io/crates/coarse-prof). Several functions in the library will use the [`profile!`](https://docs.rs/coarse-prof/latest/coarse_prof/macro.profile.html) macro with the function name as an argument to record their runtime. The user of the library can then obtain the profiling data using the functions provided by the `coarse-prof` crate. Note that profiling using this crate might reduce performance for surface reconstructions with a very small number of particles (i.e. only a few hundred).
0 commit comments