atrtp

Thermodynamic properties of a medium in combustion
git clone git://git.meso-star.fr/atrtp.git
Log | Files | Refs | README | LICENSE

atrtp.5 (3937B)


      1 .\" Copyright (C) 2020-2023 |Méso|Star> (contact@meso-star.com)
      2 .\" Copyright (C) 2020, 2021 Centre National de la Recherche Scientifique
      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 August 30, 2023
     17 .Dt ATRTP 5
     18 .Os
     19 .Sh NAME
     20 .Nm atrtp
     21 .Nd AsToRia: Thermodynamic Properties
     22 .Sh DESCRIPTION
     23 .Nm
     24 is a binary file format to store a set of thermodynamic porperties for each
     25 node of a volumetric mesh representing a medium in combustion.
     26 An
     27 .Nm
     28 file begins by a header that describes the data layout followed by a list of
     29 per node properties.
     30 .Pp
     31 The header consist of 2 integers.
     32 The first integer is a power of two
     33 .Pq usually 4096
     34 that defines the size of the memory page in bytes
     35 .Pq Va pagesize
     36 on which the thermodynamic properties are aligned.
     37 By aligning data to
     38 .Va pagesize ,
     39 and depending on system requirements, memory mapping can be used to
     40 automatically load/unload pages on demand
     41 .Pq see Xr mmap 2 .
     42 The other integer stores the number of elements in the list.
     43 In the following, we'll call it
     44 .Va #nodes ,
     45 for "number of nodes", in reference to the mesh nodes to which these properties
     46 will be attached.
     47 .Pp
     48 Fill bytes follow the file header to align thermodynamic
     49 properties to
     50 .Va pagesize .
     51 Properties are then listed with 8 double-precision floating-point numbers per
     52 element (i.e. per node).
     53 The data per node are as follows:
     54 .Bl -dash -offset indent -compact
     55 .It
     56 The pressure in Pascal
     57 .It
     58 The temperature in Kelvin
     59 .It
     60 The molar fraction of H2O in mol(H2O)/mol(mixture)
     61 .It
     62 The molar fraction of CO2 in mol(CO2)/mol(mixture)
     63 .It
     64 The molar fraction of CO in mol(CO)/mol(mixture)
     65 .It
     66 The volumic fraction of soot in m^3(soot)/m^3
     67 .It
     68 The number of soot primary particules per agregate
     69 .It
     70 The soot primary particles diameter in nm
     71 .El
     72 .Pp
     73 Finally, fill bytes are added to align the overall file size to
     74 .Va pagesize .
     75 .Pp
     76 Data are encoded with respect to the little endian bytes ordering, i.e. least
     77 significant bytes are stored first.
     78 .Pp
     79 The file format is as follows:
     80 .Bl -column (thermo-props) (::=) ()
     81 .It Ao Va atrtp Ac Ta ::= Ta Ao Va pagesize Ac Ao Va #nodes Ac
     82 .It Ta Ta Aq Va padding
     83 .It Ta Ta Aq Va thermo-props
     84 .It Ta Ta Aq Va padding
     85 .It Ao Va pagesize Ac Ta ::= Ta Vt uint64_t
     86 .It Ao Va #nodes Ac Ta ::= Ta Vt uint64_t
     87 .It \  Ta Ta
     88 .It Ao Va padding Ac Ta ::= Ta Op Vt int8_t ...
     89 # Ensure alignment on
     90 .Va pagesize
     91 .It \  Ta Ta
     92 .It Ao Va thermo-props Ac Ta ::= Ta Ao Va thermo-prop Ac Va ...
     93 .It Ao Va thermo-prop Ac Ta ::= Ta Ao Va pressure Ac
     94 # In Pascal
     95 .It Ta Ta Ao Va temperature Ac
     96 .It Ta Ta Ao Va xH2O Ac # Molar fraction of H2O
     97 .It Ta Ta Ao Va xCO2 Ac # Molar fraction of CO2
     98 .It Ta Ta Ao Va xCO Ac # Molar fraction of CO
     99 .It Ta Ta Ao Va vf-soot Ac # Volumic fraction of soot
    100 .It Ta Ta Ao Va np-soot Ac # Soot particles per agregate
    101 .It Ta Ta Ao Va dp-soot Ac # Soot particles diameter
    102 .It \  Ta Ta
    103 .It Ao Va pressure Ac Ta ::= Ta Vt double
    104 # In Pascal
    105 .It Ao Va temperature Ac Ta ::= Ta Vt double
    106 # In Kelvin
    107 .It Ao Va xH2O Ac Ta ::= Ta Vt double
    108 # In mol(H2O)/mol(mixture)
    109 .It Ao Va xCO2 Ac Ta ::= Ta Vt double
    110 # In mol(CO2)/mol(mixture)
    111 .It Ao Va xCO Ac Ta ::= Ta Vt double
    112 # In mol(CO)/mol(mixture)
    113 .It Ao Va vf-soot Ac Ta ::= Ta Vt double
    114 # In m^3(soot)/m^3
    115 .It Ao Va np-soot Ac Ta ::= Ta Vt double
    116 .It Ao Va dp-soot Ac Ta ::= Ta Vt double
    117 # In nm
    118 .El
    119 .Sh SEE ALSO
    120 .Xr mmap 2