commit f80c1d73750d0523cb9d25e06f2e517b940a4b29
parent 4ffcdc5fe6da68fc774c7f316672d424f4cfd70c
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Wed, 27 May 2020 14:37:04 +0200
Improve documentation
Diffstat:
2 files changed, 29 insertions(+), 15 deletions(-)
diff --git a/doc/stardis-input.5.txt b/doc/stardis-input.5.txt
@@ -46,8 +46,13 @@ of option *-M*.
UNITS
-----
Any physical quantity involved in descriptions is expected in the
-International System of Units (second, metre, kilogram, kelvin); the same
-applies to *stardis(1)* outputs as described in *stardis-output(5)*.
+International System of Units (second, metre, kilogram, kelvin, watt, joule);
+the same applies to *stardis(1)* outputs as described in *stardis-output(5)*.
+
+However, the geometry provided to *stardis*(1) can be described in any unit,
+multiple of meters or not, with the scaling factor provided through option
+*-f*. The constraint this feature sets to stardis input is that the product
+delta*scaling_factor must be in meters.
GRAMMAR
-------
@@ -110,24 +115,24 @@ _______
<medium-name> ::= STRING # no space allowed
-<lambda> ::= REAL # in ]0, INF)
+<lambda> ::= REAL # conductivity in W/(m.K); in ]0, INF)
-<rho> ::= REAL # in ]0, INF)
+<rho> ::= REAL # volumic mass,in kg/m3; in ]0, INF)
-<cp> ::= REAL # in ]0, INF)
+<cp> ::= REAL # capacity, in J/(kg.K) or kg.m2/(s2.K); in ]0, INF)
<delta> ::= "AUTO" # delta is automatically set to V/6A (V and A being
# respectively the solid volume and its boundary area)
- | REAL # in [0, INF)
+ | REAL # delta*scale_factor in m; in [0, INF)
-<initial-temp> ::= REAL # in [0, INF)
+<initial-temp> ::= REAL # in K; in [0, INF)
<imposed-temperature> ::= "UNKNOWN" # temperature has to be solved
- | REAL # in [0, INF)
+ | REAL # in K; in [0, INF)
-<outside-temperature> ::= REAL # in [0, INF)
+<outside-temperature> ::= REAL # in K; in [0, INF)
-<volumic-power> ::= REAL # in (-INF , INF)
+<volumic-power> ::= REAL # in W/m3; in (-INF , INF)
<triangle-sides> ::= <side-specifier> <file-name> [ <triangle-sides> ]
@@ -137,9 +142,9 @@ _______
<specular-fraction> ::= REAL # in [0, 1]
-<hc> ::= REAL # in [0, INF)
+<hc> ::= REAL # in W/(m2.K); in [0, INF)
-<flux> ::= REAL # in (-INF , INF)
+<flux> ::= REAL # in W/m2; in (-INF , INF)
<triangles> ::= <file-name> [ <triangles> ]
diff --git a/doc/stardis.1.txt.in b/doc/stardis.1.txt.in
@@ -200,9 +200,13 @@ options -g or -G.
or -s without options -g or -G).
**-f** _factor_::
- Rescale the geometry by the given *factor* before sending it to the solver,
- expected length unit being meter. Default rescale *factor*
- is @STARDIS_ARGS_DEFAULT_SCALE_FACTOR@.
+ Define the scaling factor to apply to the geometry to have it expressed
+ in meters (e.g. 1e-3 if the geometry is in mm). Default scaling *factor* is
+ @STARDIS_ARGS_DEFAULT_SCALE_FACTOR@.
++
+If this option is used, any input data provided to stardis must be scaled
+accordingly (see *stardis-input*(5)). Also, if option *-p* or *-P* is used to
+provide a probe point, this point must be in the same unit as the geometry.
*-g*::
Compute the Green function at steady state and write in ASCII to _standard
@@ -277,7 +281,12 @@ named error_path_00000000.vtk, error_path_00000001.vtk, ...
$ stardis -M scene.txt -R t=10000:spp=2:img=800x600 -D error,error_path_
+Compute the temperature at the probe point *0, 0.5, 0* at steady state, in a
+model whose dimensions are in mm, including the coordinates of the probe point.
+The system is read from the file *model.txt*:
+ $ stardis -M model.txt -p 0,0.5,0 -f 0.001
+
COPYRIGHT
---------
Copyright © 2018-2020 |Meso|Star>. License GPLv3+: GNU GPL
