stardis

commit 4b4cb83a7b33243b93abafe6337ec5080df2aea0
parent 61c7f4327bcff7a8da4908d20ec6a171c1cda58b
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Tue, 27 Feb 2024 08:54:22 +0100

Update to stardis-input man page

The rule describing the ambient radiative temperature was not listed in
the boundary conditions sub-section, even though it is. This commit
moves it to the correct section. Note that this rule has been renamed
from <rad-time> to <rad-temp> without the 's' because, even though
radiative temperature is defined by a temperature and a reference
temperature, it still describes a single boundary condition, namely _a_
radiative temperature.

Diffstat:
M
doc/stardis-input.5.in
 | 
16
++++++++--------

1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/doc/stardis-input.5.in b/doc/stardis-input.5.in
@@ -12,7 +12,7 @@
 .\"
 .\" 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 February 19, 2024
+.Dd February 27, 2024
 .Dt STARDIS-INPUT 5
 .Os
 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
@@ -128,18 +128,11 @@ The file format is as follows:
 .It Ta \& \& | Ta Ao Va boundary-condition Ac Op Ao Va comment Ac
 .It Ta \& \& | Ta Ao Va scaling Ac Op Ao Va comment Ac
 # At most once
-.It Ta \& \& | Ta Ao Va rad-temps Ac Op Ao Va comment Ac
-# At most once
 .It \  Ta Ta
 .It Ao Va comment Ac Ta ::= Ta Li # Vt string
 .It Ao Va program Ac Ta ::= Ta Li PROGRAM Ao Va prog-name Ac Ao Va lib-path Ac Op Ao Va args Ac
 .It Ao Va scaling Ac Ta ::= Ta Li SCALE Vt real
 # Geometry scaling in ]0, INF)
-.It \  Ta Ta
-.It Ao Va rad-temps Ac Ta ::= Ta Li TRAD Ao Va temp Ac Ao Va Tref Ac
-# Radiative temperatures
-.It Ao Va temp Ac Ta ::= Ta Vt real No # Temperature > 0 [K]
-.It Ao Va Tref Ac Ta ::= Ta Vt real No # Reference temperature > 0 [K]
 .El
 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 .Ss Media
@@ -220,6 +213,7 @@ that changes at
 .It Ta \& \& | Ta Aq Va robin
 .It Ta \& \& | Ta Aq Va neumann
 .It Ta \& \& | Ta Aq Va robin-neumann
+.It Ta \& \& | Ta Ao Va rad-temp Ac No # \&At most once
 .It \  Ta Ta
 .\" Dirichlet
 .It Ao Va dirichlet  Ac Ta ::= Ta Ao Va dirichlet-const Ac | Ao Va dirichlet-prog Ac
@@ -259,6 +253,12 @@ that changes at
 .It Ao Va robin-neumann-prog Ac Ta ::= Ta Li HF_BOUNDARY_FOR_SOLID_PROG Ao Va bound-name Ac \e
 .It Ta Ta Ao Va prog-desc Ac
 .It \  Ta Ta
+.\" Radiative temperature
+.It Ao Va rad-temp Ac Ta ::= Ta Li TRAD Ao Va temp Ac Ao Va Tref Ac
+# Radiative temperatures
+.It \  Ta Ta
+.It Ao Va temp Ac Ta ::= Ta Vt real No # Temperature > 0 [K]
+.It Ao Va Tref Ac Ta ::= Ta Vt real No # Reference temperature > 0 [K]
 .It Ao Va flux Ac Ta ::= Ta Vt real No # [W/m^2]
 .It Ao Va outside-temp Ac Ta ::= Ta Vt real No # Temperature > 0 [K]
 .El