commit af1bd5d26377bd2af501bec3eb4e6943e79e38de
parent 8d423e40c0e6f2d1b200a9cb632014c43a9782f2
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Mon, 16 Mar 2026 09:30:23 +0100
sln-slab: write the tool's manual page
This is being done in preparation for the actual computation, which has
yet to be implemented. The tool continues to compute 4+1.
Diffstat:
| A | doc/sln-slab.1 | | | 125 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 125 insertions(+), 0 deletions(-)
diff --git a/doc/sln-slab.1 b/doc/sln-slab.1
@@ -0,0 +1,125 @@
+.\" 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 March 16, 2026
+.Dt SLN-SLAB 1
+.Os
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh NAME
+.Nm sln-slab
+.Nd computations of radiative transfer in a 1D homogeneous slab
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh SYNOPSIS
+.Nm
+.Op Fl hsv
+.Op Fl n Ar nrealisations
+.Op Fl T Ar thickness
+.Op Fl t Ar threads
+.Fl S Ar nu_min , Ns Ar nu_max
+.Fl a Ar accel_struct
+.Fl m Ar molparams
+.Fl l Ar lines
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh DESCRIPTION
+.Nm
+calculates the transmittance in a one-dimensional homogeneous slab of
+arbitrary thickness using a Monte Carlo algorithm that samples the
+spectral lines that make up the gas mixture.
+This computation is accelerated by sampling the lines based on the
+magnitude of their contribution to the mixture’s spectrum, so that few
+Monte Carlo runs are required to estimate the transmissivity with a high
+degree of confidence.
+The core of the proposal rests on this sampling strategy, made possible
+by constructing an acceleration structure from the set of lines in the
+mixture.
+A structure built using the
+.Xr sln-build 1
+utility and provided as input to the program.
+.Pp
+More than just a numerical simulation tool,
+.Nm
+is primarily designed to validate the aforementioned acceleration
+structure in relation to its intended use, namely radiative transfer
+calculations.
+Thus, not only could an error be returned in the event of a problem with
+the structure or its use, but the computed value can also contribute to
+this validation through its comparison with the result of a calculation
+of the same quantity performed by another radiative transfer code.
+.Pp
+The options are as follows:
+.Bl -tag -width Ds
+.\""""""""""""""""""""""""""""""""""
+.It Fl a Ar accel_struct
+An acceleration structure corresponding to the input
+.Ar lines ,
+used to accelerate their sampling based on their importance.
+This structure is generated by the
+.Xr sln-build 1
+tool.
+.\""""""""""""""""""""""""""""""""""
+.It Fl h
+Display short help and exit.
+.It Fl l Ar lines
+List of lines from which the tree was built.
+This list is in binary format as generated by the
+.Xr shtr 1
+binary, or in plain text HITRAN format, depending on whether the
+.Fl s
+option is set or not, respectively.
+.\""""""""""""""""""""""""""""""""""
+.It Fl m Ar molparams
+Isotopologue metadata in HITRAN format.
+.\""""""""""""""""""""""""""""""""""
+.It Fl n Ar nrealisations
+Number of Monte Carlo realisations.
+By default the number of realisations is 10000.
+.\""""""""""""""""""""""""""""""""""
+.It Fl S Ar nu_min , Ns Ar nu_max
+The spectral range, in cm^-1, over which the computations are performed.
+.\""""""""""""""""""""""""""""""""""
+.It Fl s
+Specifies that input lines are formatted according to the binary format
+as written by the
+.Xr shtr 1
+utility, and not according to the HITRAN format.
+This format is more compact, allowing for faster loading of line data.
+.\""""""""""""""""""""""""""""""""""
+.It Fl T Ar thickness
+Slab thickness.
+The default value is 1.
+.\""""""""""""""""""""""""""""""""""
+.It Fl t Ar threads
+Advice on the number of threads to use.
+By default,
+.Nm
+uses many threads as processor cores.
+.\""""""""""""""""""""""""""""""""""
+.It Fl v
+Make
+.Nm
+verbose.
+Multiple
+.Fl v
+options increase the verbosity.
+The maximum is 3.
+.El
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh EXIT STATUS
+.Ex -std
+.\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+.Sh SEE ALSO
+.Xr sln-build 1
