commit b48a33661021b60dde935a798fd13063e0191021
parent 1c1a9207c58cea551c7e5c61edffbc8b3f20099a
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Sat, 2 May 2020 08:18:04 +0200
Additions to sgreen-input(5) documentation.
Diffstat:
1 file changed, 29 insertions(+), 30 deletions(-)
diff --git a/doc/sgreen-input.5.txt b/doc/sgreen-input.5.txt
@@ -24,25 +24,22 @@ sgreen-input - settings description for sgreen(1)
DESCRIPTION
-----------
-*sgreen-input* is the format used by the *sgreen*(1) program to describe a
+*sgreen-input* is the format used by the *sgreen*(1) program to describe
settings when applying a Green function. It relies on a line-based ad-hoc
syntax.
A settings file is composed of lines of text, each one describing the settings
-to apply for a Green function call. Each line contains *variable = value" pairs
+to apply for a Green function call. Each line contains *variable = value* pairs
in any number (at least one pair for a line to be meaningful). A list of all
legit variable names can be found in the Green function summary, as produced
by option *-s*.
GRAMMAR
-------
-In what follows, some lines end in *\*. This is used as a convenience to
-continue a description next line. However, this trick cannot be used in
-actual description files and actual description lines must be kept single-line.
-Also, text appearing between quote marks has to be used verbatim in the input,
-except the quote characters. Finally, text introduced by the *#* character in
-descriptions, when not verbatim, is a comment and is not part of the
-description.
+In what follows, text appearing between quote marks has to be used verbatim in
+the input, except the quote characters. Also, text introduced by the *#*
+character in descriptions, when not verbatim, is a comment and is not part of
+the description.
[verse]
_______
@@ -68,33 +65,35 @@ _______
______________
-TRIANGLE SIDES
---------------
-Side descriptions in side specifiers rely on the following convention: we
-first consider the direct triangle's normal (right-hand rule), then we define
-the BACK side of a triangle to be the side this normal comes out from. That
-means that a closed set of triangles with normals pointing outside should be
-used with the FRONT side specifier to describe inside medium.
-
NAMES
-----
-Names, either file names, medium names or boundary names, are a sequence of
-one or ore ASCII characters, including numbers and special characters like
-*.* *_* *-* as one may consider using in standard file names, *without any
-spacing* either escaped or not. Two different description lines cannot use
-the same name.
+Except the name AMBIENT, that refers to the ambient radiative temperature and
+is always a legit name in settings, the list of names that can be used to form
+settings is the list of medium and boundary case-sensitive names defined in the
+*stardis-input*(5) files used when creating the Green function applied to the
+settings.
+
+UNITS
+-----
+Any physical quantity involved in settings files is expected in the
+International System of Units (metre, kelvin, Watt).
EXAMPLES
--------
-Define a solid named Cube with a h boundary. The cube geometry is read from
-the file cube.stl and the solid medium properties are lambda=0.1, rho=25, cp=2.
-The numerical parameter delta, that is used for solid conductive walks, is
-0.05. The initial temperature of the cube is 0°K and its volumic power is 0.
-The boundary properties are emisivity=0, specular-fraction=0, h=10 and
-external-temperature = 100°K.
+Apply a Green function with *AMBIENT* radiative temperature set to 0 K.
+.......
+AMBIENT = 0
+.......
+
+First apply a Green function with volumic power in medium *AL* set to 100 W/m^3^
+and temperature of the *Left* boundary set to 300 K. Then apply it with the
+same variables set to 120 and 350 respectively. Finally, apply it whith the
+same variables set to 140 and 360 respectively and temperature of the *Right*
+boundary set to 380 K.
.......
-SOLID Cube 0.1 25 2 0.05 0 0 FRONT cube.stl
-H_BOUNDARY_FOR_SOLID HdT 0 0 10 100 cube.stl
+AL.VP=100 Left.T=300
+AL.VP=120 Left.T=350
+AL.VP=140 Left.T=360 Right=380
.......
SEE ALSO
