stardis

commit 7e46ab5920805708ffc082e260137cf5e06ffa88
parent 64634982242a4612cd62a6789e1dc7faeab7b63a
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date:   Fri,  5 Feb 2021 09:13:41 +0100

Man additions

Diffstat:
M
doc/stardis-input.5.txt
 | 
6
++++--
M
doc/stardis.1.txt.in
 | 
5
++++-

2 files changed, 8 insertions(+), 3 deletions(-)
diff --git a/doc/stardis-input.5.txt b/doc/stardis-input.5.txt
@@ -133,11 +133,13 @@ _______
 <solid-fluid-connect> ::= "SOLID_FLUID_CONNECTION" <bound-name> <emissivity> \
                           <specular-fraction> <hc> <triangles>
 
-<solid-solid-connect> ::= "SOLID_SOLID_CONNECTION" <bound-name>  \
+<solid-solid-connect> ::= "SOLID_SOLID_CONNECTION" <bound-name> \
                           <contact-resistance> <triangles>
+
 -------------------------------------
 
-<medium-name>         ::= STRING # no space allowed
+<medium-name>         ::= STRING # no space allowed, must not be parsable as a
+                                 # number, including INF and others
 
 <lambda>              ::= REAL # conductivity in W/(m.K); in ]0, INF)
 
diff --git a/doc/stardis.1.txt.in b/doc/stardis.1.txt.in
@@ -97,9 +97,12 @@ EXCLUSIVE OPTIONS
 
 *-P* _x,y,z[,time-range][,medium_name]_::
   Compute the temperature at the given probe on an interface at a given time.
+  If the probe is on an interface where a thermal contact resistance is
+  defined it is mandatory to provide a medium name, as the temperature differs
+  between the two sides.
   By default the compute time range 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
+  the closest interface before the computation starts. The probe coordinates
   must be in the same system as the geometry.
 
 *-m* _medium_name[,time-range]_::