Skip to content

Commit cd57c85

Browse files
committed
Update some comments
1 parent 810291b commit cd57c85

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

pysplashsurf/pysplashsurf/__init__.py

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -552,12 +552,13 @@ def reconstruction_pipeline(
552552
553553
enable_multi_threading: bool
554554
Multi-threading flag
555+
556+
sph_normals: bool
557+
Flag to compute normals using SPH interpolation instead of geometry-based normals.
555558
556559
mesh_smoothing_weights: bool
557560
Flag to compute mesh smoothing weights
558-
559-
sph_normals: bool
560-
Flag to compute normals using SPH
561+
This implements the method from “Weighted Laplacian Smoothing for Surface Reconstruction of Particle-based Fluids” (Löschner, Böttcher, Jeske, Bender; 2023).
561562
562563
mesh_smoothing_weights_normalization: float
563564
Normalization factor for the mesh smoothing weights
@@ -570,28 +571,30 @@ def reconstruction_pipeline(
570571
571572
mesh_cleanup: bool
572573
Flag to perform mesh cleanup
574+
This implements the method from “Compact isocontours from sampled data” (Moore, Warren; 1992)
573575
574576
decimate_barnacles: bool
575577
Flag to perform barnacle decimation
578+
For details see “Weighted Laplacian Smoothing for Surface Reconstruction of Particle-based Fluids” (Löschner, Böttcher, Jeske, Bender; 2023).
576579
577580
keep_vertices: bool
578-
Flag to keep vertices
581+
Flag to keep any vertices without connectivity resulting from mesh cleanup or decimation step
579582
580583
compute_normals: bool
581584
Flag to compute normals
582585
If set to True, the normals will be computed and stored in the mesh.
583586
584587
output_raw_normals: bool
585-
Flag to output the raw normals
588+
Flag to output the raw normals in addition to smoothed normals if smoothing of normals is enabled
586589
587590
output_mesh_smoothing_weights: bool
588-
Flag to store the mesh smoothing weights
591+
Flag to store the mesh smoothing weights if smoothing weights are computed.
589592
590593
mesh_aabb_clamp_vertices: bool
591594
Flag to clamp the vertices of the mesh to the AABB
592595
593596
subdomain_grid: bool
594-
Enable spatial decomposition using a regular grid-based approach
597+
Enables spatial decomposition using a regular grid-based approach
595598
596599
subdomain_num_cubes_per_dim: int
597600
Each subdomain will be a cube consisting of this number of MC cube cells along each coordinate axis

0 commit comments

Comments
 (0)