commit 99f2ca567044cdf52273b631f5c40d2e42df309b
parent f4a5bb788db2517c4a968e43098ce93c9e1b89ac
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Wed, 19 Feb 2025 15:17:37 +0100
Fix the man page for option -F
The main difference is the way flux sign is determined
Diffstat:
1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/doc/stardis.1.in b/doc/stardis.1.in
@@ -199,12 +199,11 @@ Use extended format to output Monte Carlo results.
Can only be used in conjunction with options that compute a single Monte-Carlo
.Pq Fl F , Fl m , Fl P , Fl p No or Fl s No without options Fl g No or Fl G .
.It Fl F Pa surface Ns Op , Ns Ar time Ns Op , Ns Ar time
-Compute the mean flux on a given 2D surface at a given time, the surface
-being defined as the front sides of the triangles in the provided STL
-file.
+Compute the mean flux on a given 2D surface at a given time, the surface being
+defined by the triangles in a STL file.
+The flux can only be computed on a solid-fluid interface and is accounted
+positive from the solid to the fluid.
These triangles are not added to the geometry, but must be part of it.
-Flux is accounted positive when going from the front side to the back
-side, at a single-triangle level.
By default the compute time is @STARDIS_ARGS_DEFAULT_COMPUTE_TIME@.
The surface does not need to be connex.
.It Fl G Pa green_bin Ns Op , Ns Pa green_ascii
