commit 040a53193c3e6ada35ab60b45dba8875d6001a94
parent a38700cf2c758f8015e531026a10fd1367835294
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Thu, 18 Jul 2024 10:56:41 +0200
Update stardis man page typesettin,g
Replace the deprecated macro Li with Ql.
Always use a display block to list commands instead of the literal entry
used on one line listings.
And finally, fix typos.
Diffstat:
| M | doc/stardis.1.in | | | 64 | +++++++++++++++++++++++++++++++++++++++++----------------------- |
1 file changed, 41 insertions(+), 23 deletions(-)
diff --git a/doc/stardis.1.in b/doc/stardis.1.in
@@ -12,12 +12,14 @@
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program. If not, see <http://www.gnu.org/licenses/>.
-.Dd June 17, 2024
+.Dd July 18, 2024
.Dt STARDIS 1
.Os
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.Sh NAME
.Nm stardis
.Nd statistical solving of coupled thermal systems
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.Sh SYNOPSIS
.Nm
.Op Fl eghiv
@@ -42,6 +44,7 @@
.Op Fl X Pa output_rng
.Op Fl x Pa input_rng
.Fl M Pa system
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.Sh DESCRIPTION
.Nm
solves coupled thermal systems: conductive, convective and radiative transfers
@@ -172,9 +175,9 @@ and
Actual file names are produced by appending
.Ar files_name_prefix
and the path rank starting at index
-.Li 00000000 ,
+.Ql 00000000 ,
and possibly followed by
-.Li _err
+.Ql _err
for failure paths
.Pq e.g. Pa prefix00000000.vtk , Pa prefix00000001_err.vtk
.It Fl d Ar file_base_name
@@ -245,7 +248,7 @@ Each line of this file describes a probe point using the same grammar as
that used to describe a single interface probe
.Pq see Fl P No option .
In addition to this syntax, characters behind the hash mark
-.Pq Li #
+.Pq Ql #
are considered comments and are therefore ignored, as are empty lines,
i.e. lines with no characters at all or composed solely of spaces and
tabs.
@@ -303,7 +306,7 @@ The probe coordinates must be in the same system as the geometry.
.It Fl R Ar rendering_opt Ns Op : Ns Ar rendering_opt No ...
Render an infrared image of the system through a pinhole camera.
One can use all-default sub-options by simply providing the colon character
-.Pq Li \&:
+.Pq Ql \&:
alone as an argument.
Please note that the camera position must be outside the geometry or in a fluid.
.Pp
@@ -382,11 +385,15 @@ uses many threads as processor cores.
.It Fl V Ar verbosity_level
Set the verbosity level.
Possible values are
-.Li 0 Pq no message ,
-.Li 1 Pq error messages only ,
-.Li 2 error and warning messages ,
+.Ql 0
+.Pq no message ,
+.Ql 1
+.Pq error messages only ,
+.Ql 2
+.Pq error and warning messages ,
and
-.Li 3 Pq error, warning and informative messages .
+.Ql 3
+.Pq error, warning and informative messages .
All the messages are written to standard error.
Default is @STARDIS_ARGS_DEFAULT_VERBOSE_LEVEL@.
.It Fl v
@@ -402,8 +409,10 @@ Used in conjunction with the
option, this can be used to ensure statistical independence between subsequent
computations.
.El
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.Sh EXIT STATUS
.Ex -std
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.Sh EXAMPLES
Preprocess the system as described in
.Pa scene 5.txt
@@ -413,8 +422,9 @@ and write its geometry in the file
.Pa scene.vtk .
Verbosity level is set to
.Ar 3 :
-.Pp
-.Dl stardis -M "scene 5.txt" -F edge.stl -d -V 3 > scene.vtk
+.Bd -literal -offset Ds
+stardis -M "scene 5.txt" -F edge.stl -d -V 3 > scene.vtk
+.Ed
.Pp
Compute the temperature at the probe point
.Ar 0 , Ns Ar 0.5 , Ns Ar 0
@@ -423,8 +433,9 @@ The system is read from the file
.Pa model.txt
and the number of samples is set to
.Ar 1000000 :
-.Pp
-.Dl stardis -M model.txt -p 0,0.5,0 -n 1000000
+.Bd -literal -offset Ds
+ stardis -M model.txt -p 0,0.5,0 -n 1000000
+.Ed
.Pp
Compute the mean temperature in the medium
.Ar med05
@@ -434,8 +445,9 @@ The system is read from the file
.Pa model.txt
and the result is output with extended format
.Pq option Fl e :
-.Pp
-.Dl stardis -M model.txt -m med05,100 -e
+.Bd -literal -offset Ds
+stardis -M model.txt -m med05,100 -e
+.Ed
.Pp
Compute the temperature at the probe point
.Ar 0 , Ns Ar 0 , Ns Ar 0
@@ -447,8 +459,9 @@ and
.Pa bounds.txt ,
and the number of samples is set to
.Ar 1000000 :
-.Pp
-.Dl stardis -M media.txt -M bounds.txt -p 0,0,0,2500 -n 1000000
+.Bd -literal -offset Ds
+stardis -M media.txt -M bounds.txt -p 0,0,0,2500 -n 1000000
+.Ed
.Pp
Compute the mean temperature at the probe point
.Ar 1 , Ns Ar 2.5 , Ns Ar 0
@@ -457,8 +470,9 @@ over the
time range.
The system is read from the file
.Pa model.txt :
-.Pp
-.Dl stardis -M model.txt -p 1,2.5,0,50,5000
+.Bd -literal -offset Ds
+stardis -M model.txt -p 1,2.5,0,50,5000
+.Ed
.Pp
Compute 3 probe temperatures, ensuring statistical independence:
.Bd -literal -offset Ds
@@ -475,8 +489,9 @@ on several hosts defined in the my_hosts file.
Render the system as described in
.Pa scene.txt
with default settings:
-.Pp
-.Dl mpirun --hostfile my_hosts stardis -M scene.txt -R\&:
+.Bd -literal -offset Ds
+mpirun --hostfile my_hosts stardis -M scene.txt -R\&:
+.Ed
.Pp
Render the system as described in
.Pa scn.txt
@@ -519,8 +534,10 @@ and the Green function is written to the
file and the heat paths' ends are written to the
.Pa probe_ends.csv
file:
-.Pp
-.Dl stardis -M model.txt -p 0,0,0 -G probe.green,probe_ends.csv
+.Bd -literal -offset Ds
+stardis -M model.txt -p 0,0,0 -G probe.green,probe_ends.csv
+.Ed
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.Sh SEE ALSO
.Xr htpp 1 ,
.Xr mpirun 1 ,
@@ -593,6 +610,7 @@ solutions of heat equations
.%P 1--13
.%D 1949
.Re
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.Sh STANDARDS
.Rs
.%B The VTK User's Guide
