star-gas

Load and structure gas data
git clone git://git.meso-star.fr/star-gas.git
Log | Files | Refs | README | LICENSE

sgas-lint.1 (3083B)

      1 .\" Copyright (C) 2025, 2026 |Méso|Star> (contact@meso-star.com)
      2 .\" Copyright (C) 2025, 2026 Université de Lorraine
      3 .\"
      4 .\" This program is free software: you can redistribute it and/or modify
      5 .\" it under the terms of the GNU General Public License as published by
      6 .\" the Free Software Foundation, either version 3 of the License, or
      7 .\" (at your option) any later version.
      8 .\"
      9 .\" This program is distributed in the hope that it will be useful,
     10 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
     11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
     12 .\" GNU General Public License for more details.
     13 .\"
     14 .\" You should have received a copy of the GNU General Public License
     15 .\" along with this program. If not, see <http://www.gnu.org/licenses/>.
     16 .Dd March 3, 2026
     17 .Dt SGAS-LINT 1
     18 .Os
     19 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     20 .Sh NAME
     21 .Nm sgas-lint
     22 .Nd check gas data loading and structuring
     23 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     24 .Sh SYNOPSIS
     25 .Nm
     26 .Op Fl hv
     27 .Fl m Ar mesh
     28 .Op Ar therm_props_list
     29 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     30 .Sh DESCRIPTION
     31 .Nm
     32 loads the data that describe a gas and structures them to accelerate the
     33 spatio-temporal queries of its thermodynamic properties.
     34 In fact, it checks the behaviour of the Star-Gas library on which it
     35 relies, and in doing so checks that the loading and structuring of input
     36 data works as expected.
     37 .Pp
     38 Input data are the volumetric gas
     39 .Ar mesh
     40 and a set of time variable thermodynamic properties listed in the
     41 .Ar therm_props_list
     42 file.
     43 If
     44 .Ar therm_props_list
     45 is not set, the list of thermodynamic properties is read from the
     46 standard input.
     47 .Pp
     48 These properties are listed in a simple text format, where each line
     49 consists of at least two fields separated by at least one space.
     50 The first field is a real number representing the time at which the
     51 thermodynamic properties are defined, followed by the path to an
     52 .Xr atrtp 5
     53 file defining the values of these properties.
     54 .Pp
     55 Properties must be listed in chronological order.
     56 Empty lines are ignored, as are comments, i.e., text following
     57 the hash sign
     58 .Pq # .
     59 .Pp
     60 The path to an
     61 .Xr atrtp 5
     62 file is expanded and can therefore be
     63 composed of variables.
     64 .Pp
     65 Here is an example file:
     66 .Bd -literal -offset Ds
     67 37    "${DATA_PATH}/37.00/therm_props.atrtp"
     68 37.12 "${DATA_PATH}/37.12/therm_props.atrtp"
     69 37.24 "${DATA_PATH}/37.24/therm_props.atrtp"
     70 37.36 "${DATA_PATH}/37.36/therm_props.atrtp"
     71 .Ed
     72 .Pp
     73 The options are as follow:
     74 .Bl -tag -width Ds
     75 .\""""""""""""""""""""""""""""""""""
     76 .It Fl h
     77 Display short help and exit.
     78 .\""""""""""""""""""""""""""""""""""
     79 .It Fl m Ar mesh
     80 Tetrahedral gas mesh in
     81 .Xr smsh 5
     82 format.
     83 .\""""""""""""""""""""""""""""""""""
     84 .It Fl v
     85 Make
     86 .Nm
     87 verbose.
     88 Multiple
     89 .Fl v
     90 options increase the verbosity.
     91 The maximum is 3.
     92 .El
     93 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     94 .Sh EXIT
     95 .Ex -std
     96 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     97 .Sh SEE ALSO
     98 .Xr atrtp 5 ,
     99 .Xr smsh 5