commit d90cfabc52ea3c213a382d73c8e657c49792163f
parent ef8fe3f37c7ca8d209fd7c3be13b92e321f2eb72
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Thu, 5 Feb 2026 17:10:50 +0100
Add the manual page for the sln-mixture file format
Diffstat:
3 files changed, 99 insertions(+), 12 deletions(-)
diff --git a/Makefile b/Makefile
@@ -160,6 +160,7 @@ clean: clean_test clean_utils
lint:
mandoc -Tlint -Wwarning doc/sln-build.1
+ mandoc -Tlint doc/sln-mixture.5
################################################################################
# Tests
diff --git a/doc/sln-mixture.5 b/doc/sln-mixture.5
@@ -0,0 +1,98 @@
+.\" Copyright (C) 2022, 2026 |Méso|Star> (contact@meso-star.com)
+.\" Copyright (C) 2026 Université de Lorraine
+.\" Copyright (C) 2022 Centre National de la Recherche Scientifique
+.\" Copyright (C) 2022 Université Paul Sabatier
+.\"
+.\" This program is free software: you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation, either version 3 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.\" GNU General Public License for more details.
+.\"
+.\" 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 5, 2026
+.Dt SLN-MIXTURE 5
+.Os
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh NAME
+.Nm sln-mixture
+.Nd description of a gaz mixture
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh DESCRIPTION
+.Nm
+is a file format whose purpose is to define the list of molecules in a
+gas mixture, their concentration, the cutoff of their spectroscopic
+line, and, possibly, the abundance of their isotopes if their default
+abundance is not suitable for the mixture.
+.Pp
+A
+.Nm
+file is not sufficient on its own.
+It is implicitly defined in relation to an isotope metadata file listing
+the other parameters of the molecules
+.Pq molar mass, degeneracy factor, etc. ,
+and the list of their isotopes with their default abundance.
+In a
+.Nm
+file, isotope identifiers must therefore correspond to those defined in
+the metadata file.
+Similarly, the list of isotopic abundances listed for a molecule must
+respect the order of the molecule's isotopes as defined in these
+metadata.
+.Pp
+.Nm
+is a text file format.
+Characters behind the hash mark
+.Pq Li #
+are considered comments and are therefore ignored, as well as empty lines,
+i.e. lines without any characters or composed only of spaces and tabs.
+.Pp
+The file format is as follows:
+.Bl -column (concentration) (::=) ()
+.It Ao Va mixture Ac Ta ::= Ta
+.Aq Va molecule
+.Aq Va concentration
+.Aq Va cutoff
+.It \ Ta Ta Op Ao Va isotope-list Ac
+.It Ao Va isotope-list Ac Ta ::= Ta Ao Va isotope-id Ac Ao Va abundance Ac
+.It \ Ta Ta ...
+.It \ Ta Ta
+.It Ao Va molecule Ac Ta ::= Ta Vt string No # molecule name
+.It Ao Va concentration Ac Ta ::= Ta Vt real No # Bq mol/mol
+.It Ao Va cutoff Ac Ta ::= Ta Vt real No # Bq cm^-1
+.It Ao Va isotope-id Ac Ta ::= Ta Vt integer
+.It Ao Va abundance Ac Ta ::= Ta Vt real
+.El
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh EXAMPLES
+Configure a gas mixture composed of H2O, CO2, and O3 molecules.
+Their respective concentrations are 1.9e-2 mol/mol, 2.87e-4 mol/mol, and
+6.15e-6 mol/mol.
+Truncate the influence of spectroscopic lines at 25 cm^-1 from their
+center, except for CO2 lines, which are cut at 50 cm^-1.
+Use the default abundance of isotopes for each molecule, except for H2O,
+whose abundances are redefined to consider only the first three
+isotopes:
+.Bd -literal -offset Ds
+# molecule concentration [mol/mol] cutoff [cm^-1]
+H2O 1.9E-2 25
+ # isotope-id abundance
+ 161 9.97E-01
+ 181 2.00E-03
+ 171 1.00E-03
+
+# molecule concentration [mol/mol] cutoff [cm^-1]
+CO2 2.87E-4 50
+O3 6.15E-6 25
+.Ed
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh SEE ALSO
+.Rs
+.%T The HITRAN Database
+.%U https://hitran.org/
+.Re
diff --git a/doc/sln-mixture.txt b/doc/sln-mixture.txt
@@ -1,12 +0,0 @@
-<mixture> ::= <molecule> <concentration> <cutoff>
- [ <isotope-list> ]
-<isotope-list> ::= <isotope-id> <abundance>
- ...
-
-EXAMPLE
-
- # Molecule concentration [mol/mol] cutoff [cm^-1
- H2O 0.3 25
- # Isotope Abundance
- 161 9.97E-01
- ...
