commit 46e074de899c97052262e61ede97ee2071e734ef
parent ea9cb71f99a816e9f4cf4299b91a6dc29d1b603f
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Fri, 12 Feb 2021 17:10:26 +0100
Improve man
Diffstat:
2 files changed, 16 insertions(+), 16 deletions(-)
diff --git a/cmake/CMakeLists.txt b/cmake/CMakeLists.txt
@@ -36,7 +36,7 @@ set_property(CACHE STARDIS_DOC PROPERTY STRINGS
# Generate files
###############################################################################
set(STARDIS_ARGS_DEFAULT_AMBIENT_TEMP "300")
-set(STARDIS_ARGS_DEFAULT_COMPUTE_TIME "INF, INF")
+set(STARDIS_ARGS_DEFAULT_COMPUTE_TIME "INF")
set(STARDIS_ARGS_DEFAULT_RENDERING_FOV "70") # degrees
set(STARDIS_ARGS_DEFAULT_RENDERING_IMG_HEIGHT "480")
set(STARDIS_ARGS_DEFAULT_RENDERING_IMG_WIDTH "640")
diff --git a/doc/stardis.1.txt.in b/doc/stardis.1.txt.in
@@ -89,45 +89,45 @@ MANDATORY OPTIONS
EXCLUSIVE OPTIONS
-----------------
-*-p* _x,y,z[,time-range]_::
+*-p* _x,y,z[,time[,time]]_::
Compute the temperature at the given probe at a given time. By default the
- compute time range is @STARDIS_ARGS_DEFAULT_COMPUTE_TIME@. The probe must
+ compute time is @STARDIS_ARGS_DEFAULT_COMPUTE_TIME@. The probe must
be in a medium. The probe coordinates must be in the same system as the
geometry.
-*-P* _x,y,z[,time-range]_::
+*-P* _x,y,z[,time[,time]]_::
Compute the temperature at the given probe on an interface at a given time.
- By default the compute time range is @STARDIS_ARGS_DEFAULT_COMPUTE_TIME@. The
+ By default the compute time is @STARDIS_ARGS_DEFAULT_COMPUTE_TIME@. The
probe is supposed to be on an interface and is moved to the closest point of
the closest interface before the computation start. The probe coordinates
must be in the same system as the geometry.
-*-m* _medium_name[,time-range]_::
+*-m* _medium_name[,time[,time]]_::
Compute the mean temperature in a given medium at a given time. The medium
name must be part of the system description. By default the compute time
- range is @STARDIS_ARGS_DEFAULT_COMPUTE_TIME@. The medium does not need to be
- connex.
+ is @STARDIS_ARGS_DEFAULT_COMPUTE_TIME@. The medium region does not need
+ to be connex.
-*-s* _file[,time-range]_::
+*-s* _file[,time[,time]]_::
Compute the mean temperature on a given 2D region at a given time, the region
being defined as the front sides of the triangles in the provided *STL* file.
- By default the compute time range is @STARDIS_ARGS_DEFAULT_COMPUTE_TIME@.
+ By default the compute time is @STARDIS_ARGS_DEFAULT_COMPUTE_TIME@.
These triangles are not added to the geometry, but must be part of it. The
region does not need to be connex.
-*-S* _file[,time-range]_::
+*-S* _file[,time[,time]]_::
Compute the by-triangle mean temperature on a given 2D region at a given
time, the region being defined as the front sides of the triangles in the
provided *STL* file. These triangles are not added to the geometry, but must
- be part of it. By default the compute time range is
+ be part of it. By default the compute time is
@STARDIS_ARGS_DEFAULT_COMPUTE_TIME@. The region does not need to be connex.
-*-F* _file[,time-range]_::
+*-F* _file[,time[,time]]_::
Compute the mean flux on a given 2D region at a given time, the region
being defined as the front sides of the triangles in the provided *STL* file.
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 range is
+ single-triangle level. By default the compute time is
@STARDIS_ARGS_DEFAULT_COMPUTE_TIME@. The region does not need to be connex,
but it can currently only include geometry appearing in description lines
starting with H_BOUNDARY_FOR_SOLID, H_BOUNDARY_FOR_FLUID,
@@ -166,8 +166,8 @@ EXCLUSIVE OPTIONS
Number of samples per pixel.
By default, use @STARDIS_ARGS_DEFAULT_RENDERING_SPP@ samples per pixel.
- **t=**_time-range_;;
- Rendering time range. By default _time-range_ is
+ **t=**_time[,time]_;;
+ Rendering time. By default the rendering time is
@STARDIS_ARGS_DEFAULT_RENDERING_TIME@.
**tgt=**_x_**,**_y_**,**_z_;;
