stardis

Perform coupled heat transfer calculations
git clone git://git.meso-star.fr/stardis.git
Log | Files | Refs | README | LICENSE

stardis-output.5 (36171B)


      1 .\" Copyright (C) 2018-2025 |Méso|Star> (contact@meso-star.com)
      2 .\"
      3 .\" This program is free software: you can redistribute it and/or modify
      4 .\" it under the terms of the GNU General Public License as published by
      5 .\" the Free Software Foundation, either version 3 of the License, or
      6 .\" (at your option) any later version.
      7 .\"
      8 .\" This program is distributed in the hope that it will be useful,
      9 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
     10 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
     11 .\" GNU General Public License for more details.
     12 .\"
     13 .\" You should have received a copy of the GNU General Public License
     14 .\" along with this program. If not, see <http://www.gnu.org/licenses/>.
     15 .Dd April 12, 2024
     16 .Dt STARDIS-OUTPUT 5
     17 .Os
     18 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     19 .\" Name and short description
     20 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     21 .Sh NAME
     22 .Nm stardis-output
     23 .Nd output format of
     24 .Xr stardis 1
     25 results
     26 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     27 .\" Detailed description
     28 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     29 .Sh DESCRIPTION
     30 .Nm
     31 describes the output format of the
     32 .Xr stardis 1
     33 program.
     34 Any
     35 .Xr stardis 1
     36 result is written to standard output, even though some additional
     37 informations can be written in files.
     38 .Pp
     39 The type of the data that are generated depends on the options used when
     40 .Xr stardis 1 is invoked.
     41 When invoked with one of the basic computation options
     42 .Pq Fl p , Fl P , Fl m , Fl s No or Fl F ,
     43 .Xr stardis 1
     44 outputs a single Monte Carlo result.
     45 On the opposite,
     46 .Xr stardis 1
     47 ouputs compound results when invoked with
     48 option
     49 .Fl S
     50 or
     51 .Fl R .
     52 Additionally, options
     53 .Fl g
     54 and
     55 .Fl G
     56 make
     57 .Xr stardis 1
     58 compute and output a Green function and possibly information on heat
     59 paths' ends.
     60 Most of the complex data output is in VTK format.
     61 .Pp
     62 Note that some special options
     63 .Pq Fl v , Fl h No or Fl d
     64 that does not involve any computation produce output including
     65 information on the
     66 .Xr stardis 1
     67 software
     68 .Pq their ouputs will not be described thereafter
     69 or the provided thermal system.
     70 .Pp
     71 Any physical quantity in output is in the International System of Units
     72 .Pq second, metre, kilogram, kelvin
     73 except the coordinates that are in same system as the geometry.
     74 .Pp
     75 In what follows, some lines end with a backslash
     76 .Pq Li \e .
     77 This is used as a convenience to continue a description next line.
     78 However, this trick cannot be used in actual description files and
     79 actual description lines must be kept single-line.
     80 Text introduced by the sharp character
     81 .Pq Li #
     82 in descriptions is a comment and is not part of the description.
     83 .Pp
     84 The output format is as follows:
     85 .Bl -column (******************) (::=) ()
     86 .It Ao Va output Ac Ta ::= Ta Aq Va mc-estimate
     87 .It Ta \& \& | Ta Aq Va green-function
     88 .It Ta \& \& | Ta Aq Va geometry-dump
     89 .It Ta \& \& | Ta Aq Va infrared-image
     90 .It Ta \& \& | Ta Aq Va heat-paths
     91 .El
     92 .Pp
     93 The following sections describe in detail each of these possible
     94 outputs.
     95 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     96 .\" Single Monte Carlo estimate
     97 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     98 .Sh MONTE CARLO ESTIMATE
     99 When
    100 .Xr stardis 1
    101 is used to calculate a single Monte Carlo estimate, either a temperature
    102 or a flux, the estimate is output first to standard output, possibly
    103 followed by some of the heat paths involved in the computation if option
    104 .Fl D
    105 was used too.
    106 Two different formats are possible: a raw, numbers only format
    107 .Pq the default
    108 or an extended format that mixes numbers and their descriptions
    109 .Pq if option Fl e No is used .
    110 .Bl -column (******************) (::=) ()
    111 .It Ao Va mc-estimate Ac Ta ::= Ta Ao Va probe-temp Ac # Options Fl P No or Fl p
    112 .It Ta \& \& | Ta Ao Va medium-temp Ac # Option Fl m
    113 .It Ta \& \& | Ta Ao Va mean-temp Ac # Option Fl s
    114 .It Ta \& \& | Ta Ao Va mean-flux Ac # Option Fl F
    115 .It Ta \& \& | Ta Ao Va flux-density Ac # Option Fl f
    116 .It \  Ta Ta
    117 .\" Probe temperature
    118 .It Ao Va probe-temp Ac Ta ::= Ta Ao Va probe-temp-raw Ac | Ao Va probe-temp-ext Ac
    119 .It Ao Va probe-temp-raw Ac Ta ::= Ta Ao Va estimate Ac Ao Va failures Ac
    120 .It Ao Va probe-temp-ext Ac Ta ::= Ta Li Temperature at Ao Va position Ac Ao Va time Ac \e
    121 .It Ta Ta Ao Va estimate-temp-ext Ac Ao Va failures-ext Ac
    122 .It \  Ta Ta
    123 .\" Medium temperature
    124 .It Ao Va medium-temp Ac Ta ::= Ta Ao Va medium-temp-raw Ac | Ao Va medium-temp-ext Ac
    125 .It Ao Va medium-temp-raw Ac Ta ::= Ta Ao Va estimate Ac Ao Va failures Ac
    126 .It Ao Va medium-temp-ext Ac Ta ::= Ta Li Temperature in medium Ao Va medium-name Ac \e
    127 .It Ta Ta Ao Va time Ac Ao Va estimate-temp-ext Ac Ao Va failures-ext Ac
    128 .It \  Ta Ta
    129 .\" Mean temperature
    130 .It Ao Va mean-temp Ac Ta ::= Ta Ao Va mean-temp-raw Ac | Ao Va mean-temp-ext Ac
    131 .It Ao Va mean-temp-raw Ac Ta ::= Ta Ao Va estimate Ac Ao Va failures Ac
    132 .It Ao Va mean-temp-ext Ac Ta ::= Ta Li Temperature at boundary Ao Va stl-path Ac \e
    133 .It Ta Ta Ao Va time Ac Ao Va estimate-temp-ext Ac Ao Va failures-ext Ac
    134 .It \  Ta Ta
    135 .\" Mean flux
    136 .It Ao Va mean-flux Ac Ta ::= Ta Ao Va mean-flux-raw Ac | Ao Va mean-flux-ext Ac
    137 .It Ao Va flux-density Ac Ta ::= Ta Ao Va flux-density-raw Ac | Ao Va flux-density-ext Ac
    138 .It Ao Va mean-flux-raw Ac Ta ::= Ta Ao Va estimate Ac Ao Va estimate Ac Ao Va estimate Ac \e
    139 .It Ta Ta Ao Va estimate Ac Ao Va estimate Ac Ao Va failures Ac
    140 .It Ao Va flux-density-raw Ac Ta ::= Ta Ao Va estimate Ac Ao Va estimate Ac Ao Va estimate Ac \e
    141 .It Ta Ta Ao Va estimate Ac Ao Va estimate Ac Ao Va failures Ac
    142 .It Ao Va mean-flux-ext Ac Ta ::= Ta Li Temperature at boundary Ao Va stl-path Ac \e
    143 .It Ta Ta Ao Va time Ac Ao Va estimate-temp-ext Ac
    144 .It Ta Ta Li Convective flux at boundary Ao Va stl-path Ac \e
    145 .It Ta Ta Ao Va time Ac Ao Va estimate-flux-ext Ac
    146 .It Ta Ta Li Radiative flux at boundary Ao Va stl-path Ac \e
    147 .It Ta Ta Ao Va time Ac Ao Va estimate-flux-ext Ac
    148 .It Ta Ta Li Imposed flux at boundary Ao Va stl-path Ac \e
    149 .It Ta Ta Ao Va time Ac Ao Va estimate-flux-ext Ac
    150 .It Ta Ta Li Total flux at boundary Ao Va stl-path Ac \e
    151 .It Ta Ta Ao Va time Ac Ao Va estimate-flux-ext Ac
    152 .It Ta Ta Ao Va failures-ext Ac
    153 .It Ao Va flux-density-ext Ac Ta ::= Ta Li Temperature at Ao Va position Ac Ao Va time Ac \e
    154 .It Ta Ta Ao Va estimate-temp-ext Ac
    155 .It Ta Ta Li Convective flux density at Ao Va position Ac Ao Va time Ac \e
    156 .It Ta Ta Ao Va estimate-f-dsity-ext Ac
    157 .It Ta Ta Li Radiative flux density at Ao Va position Ac Ao Va time Ac \e
    158 .It Ta Ta Ao Va estimate-f-dsity-ext Ac
    159 .It Ta Ta Li Imposed flux density at Ao Va position Ac Ao Va time Ac \e
    160 .It Ta Ta Ao Va estimate-f-dsity-ext Ac
    161 .It Ta Ta Li Total flux density at Ao Va position Ac Ao Va time Ac \e
    162 .It Ta Ta Ao Va estimate-f-dsity-ext Ac
    163 .It Ta Ta Ao Va failures-ext Ac
    164 .It \  Ta Ta
    165 .\" Miscellaneous
    166 .It Ao Va estimate Ac Ta ::= Ta Ao Va expected-value Ac Ao Va standard-error Ac
    167 .It Ao Va estimate-temp-ext Ac Ta ::= Ta Ao Va expected-value Ac Li K +/- Ao Va standard-error Ac
    168 .It Ao Va estimate-flux-ext Ac Ta ::= Ta Ao Va expected-value Ac Li W +/- Ao Va standard-error Ac
    169 .It Ao Va estimate-f-dsity-ext Ac Ta ::= Ta Ao Va expected-value Ac Li W/m² +/- Ao Va standard-error Ac
    170 .It Ao Va expected-value Ac Ta ::= Ta Vt real
    171 .It Ao Va standard-error Ac Ta ::= Ta Vt real
    172 .It \  Ta Ta
    173 .It Ao Va failures Ac Ta ::= Ta Ao Va error-count Ac Ao Va success-count Ac
    174 .It Ao Va error-count Ac Ta ::= Ta Vt integer
    175 .It Ao Va success-count Ac Ta ::= Ta Vt integer
    176 .It \  Ta Ta
    177 .It Ao Va position Ac Ta ::= Ta [ Vt real , Vt real , Vt real ]
    178 .It Ao Va time Ac Ta ::= Ta Li at t= Ns Vt real
    179 .It Ta \& \& | Ta Li with t in [ Vt real , Vt real ]
    180 .It Ao Va medium-name Ac Ta ::= Ta Vt string
    181 .It Ao Va stl-path Ac Ta ::= Ta Pa path
    182 .El
    183 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    184 .\" Green function
    185 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    186 .Sh GREEN FUNCTION
    187 The Green function is generated, either in binary or ascii format, when
    188 a green-compatible
    189 .Xr stardis 1
    190 simulation option is used in conjuction with option
    191 .Fl G
    192 for a binary output, or option
    193 .Fl g
    194 for an ascii output.
    195 For every successful heat path sampled carrying out the simulation, the
    196 solver records all the elements of the path history relevant to link the
    197 various imposed temperature, flux and volumic power values to the
    198 simulation result.
    199 The output is made of tables containing the different media and
    200 boundaries and their imposed temperature, flux and volumic power values,
    201 followed by the heat paths' history.
    202 Also, option
    203 .Fl G
    204 make it possible to output heat paths' end information on an ascii, csv
    205 formated file.
    206 .Bl -column (******************) (::=) ()
    207 .It Ao Va green-function Ac Ta ::= Ta Ao Va green-ascii Ac No # Option Fl g
    208 .It Ta \& \& | Ta Ao Va green-binary Ac Oo Ao Va paths Ac Oc No # Option Fl G
    209 .El
    210 .Pp
    211 The Monte Carlo estimate and standard deviation for a given set of settings can
    212 be computed as the mean and standard deviation of the samples of the Green
    213 function computed using these settings.
    214 Each sample can be computed as follows:
    215 .Bl -bullet -compact -offset indent
    216 .It
    217 get the temperature of the ending boundary, medium or Trad
    218 .It
    219 add the temperature gain of each power term
    220 .It
    221 add the temperature gain of each flux term
    222 .El
    223 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    224 .Ss ASCII format
    225 Beyond the file format described below,
    226 .Xr stardis 1
    227 could write comments
    228 .Pq characters behind the hash mark Pq Li #
    229 or blank lines
    230 .Pq lines without any characters or composed only of spaces and tabs .
    231 These are not part of the file format and should be ignored.
    232 .Pp
    233 The ASCII file format of a Green function is as follows:
    234 .Bl -column (******************) (::=) ()
    235 .It Ao Va green-ascii Ac Ta ::= Ta Li ---BEGIN GREEN---
    236 .It Ta Ta Aq Va time-range
    237 .It Ta Ta Ao Va #solids Ac Ao Va #fluids Ac \e
    238 .It Ta Ta Ao Va #dirichlet-boundaries Ac \e
    239 .It Ta Ta Ao Va #robin-boundaries Ac \e
    240 .It Ta Ta Ao Va #neumann-boundaries Ac \e
    241 .It Ta Ta Ao Va #successes Ac Ao Va #failures Ac
    242 .It Ta Ta Aq Va solid
    243 .It Ta Ta ...
    244 .It Ta Ta Aq Va fluid
    245 .It Ta Ta ...
    246 .It Ta Ta Aq Va dirichlet-boundary
    247 .It Ta Ta ...
    248 .It Ta Ta Aq Va robin-boundary
    249 .It Ta Ta ...
    250 .It Ta Ta Aq Va neumann-boundary
    251 .It Ta Ta ...
    252 .It Ta Ta Aq Va rad-temp
    253 .It Ta Ta Aq Va samples
    254 .It \  Ta Ta
    255 .It Ao Va time-rad Ac Ta ::= Ta Vt real Vt real
    256 .It Ao Va #solids Ac Ta ::= Ta Vt integer
    257 .It Ao Va #fluids Ac Ta ::= Ta Vt integer
    258 .It Ao Va #dirichlet-boundaries Ac Ta ::= Ta Vt integer
    259 .It Ao Va #robin-boundaries Ac Ta ::= Ta Vt integer
    260 .It Ao Va #neumann-boundaries Ac Ta ::= Ta Vt integer
    261 .It Ao Va #successes Ac Ta ::= Ta Vt integer
    262 .It Ao Va #failures Ac Ta ::= Ta Vt integer
    263 .It \  Ta Ta
    264 .It Ao Va solid Ac Ta ::= Ta Ao Va green-id Ac Ao Va name Ac Ao Va lambda Ac Ao Va rho Ac Ao Va cp Ac \e
    265 .It Ta Ta Ao Va power Ac Ao Va initial-temp Ac Ao Va imposed-temp Ac
    266 .It Ao Va fluid Ac Ta ::= Ta Ao Va green-id Ac Ao Va name Ac Ao Va rho Ac Ao Va cp Ac \e
    267 .It Ta Ta Ao Va initial-temp Ac Ao Va imposed-temp Ac
    268 .It Ao Va lambda Ac Ta ::= Ta Vt real No # Conductivity > 0 [W/m/K]
    269 .It Ao Va rho Ac Ta ::= Ta Vt real No # Volumic mass > 0 [kg/m^3]
    270 .It Ao Va cp Ac Ta ::= Ta Vt real No # Capacity > 0 [J/K/kg]
    271 .It Ao Va power Ac Ta ::= Ta Vt real No # Volumic power [W/m^3]
    272 .It Ao Va initial-temp Ac Ta ::= Ta Vt real No # Temperature [K]
    273 .It Ao Va imposed-temp Ac Ta ::= Ta Vt real No # Temperature [K]
    274 .It \  Ta Ta
    275 .It Ao Va dirichlet-boundary Ac Ta ::= Ta Ao Va green-id Ac Ao Va name Ac Ao Va temp Ac
    276 .It Ao Va robin-boundary Ac Ta ::= Ta Ao Va green-id Ac Ao Va name Ac Ao Va temp-ref Ac \e
    277 .It Ta Ta Ao Va emissivity Ac Ao Va specular-fraction Ac Ao Va hc Ac \e
    278 .It Ta Ta Ao Va temp Ac
    279 .It Ao Va neumann-boundary Ac Ta ::= Ta Ao Va green-id Ac Ao Va name Ac Ao Va flux Ac
    280 .It Ao Va emissivity Ac Ta ::= Ta Vt real No # \&In [0,1]
    281 .It Ao Va specular-fraction Ac Ta ::= Ta Vt real No # \&In [0,1]
    282 .It Ao Va hc Ac Ta ::= Ta Vt real No # Convective coefficient [W/m^2/K]
    283 .It Ao Va temp Ac Ta ::= Ta Vt real No # Temperature [K]
    284 .It Ao Va temp-ref Ac Ta ::= Ta Vt real No # Reference temperature [K]
    285 .It Ao Va flux Ac Ta ::= Ta Vt real No # [W/m^2]
    286 .It \  Ta Ta
    287 .It Ao Va rad-temp Ac Ta ::= Ta Ao Va green-id Ac Ao Va Trad Ac Ao Va Trad-ref Ac
    288 .It Ao Va Trad Ac Ta ::= Ta Vt real No # Radiative temperature [K]
    289 .It Ao Va Trad-ref Ac Ta ::= Ta Vt real No # Reference temperature [K]
    290 .It \  Ta Ta
    291 .It Ao Va sample Ac Ta ::= Ta Ao Va end-type Ac Ao Va green-id Ac \e
    292 .It Ta Ta Ao Va #power-terms Ac Ao Va #flux-terms Ac \e
    293 .It Ta Ta Ao Va power-term Ac ... Ao Va flux-term Ac ...
    294 .It Ao Va end-type Ac Ta ::= Ta Aq Va end-dirichlet
    295 .It Ta \& \& | Ta Aq Va end-robin
    296 .It Ta \& \& | Ta Aq Va end-Trad
    297 .It Ta \& \& | Ta Ao Va end-fluid Ac No # Fluid temperature
    298 .It Ta \& \& | Ta Ao Va end-solid Ac No # Solid temperature
    299 .It Ao Va end-dirichlet Ac Ta ::= Ta Li T
    300 .It Ao Va end-robin Ac Ta ::= Ta Li H
    301 .It Ao Va end-Trad Ac Ta ::= Ta Li R
    302 .It Ao Va end-fluid Ac Ta ::= Ta Li F
    303 .It Ao Va end-solid Ac Ta ::= Ta Li S
    304 .It Ao Va #power-terms Ac Ta ::= Ta Vt integer
    305 .It Ao Va #flux-terms Ac Ta ::= Ta Vt integer
    306 .It Ao Va power-term Ac Ta ::= Ta Ao Va green-id Ac Ao Va factor Ac
    307 .It Ao Va flux-term Ac Ta ::= Ta Ao Va green-id Ac Ao Va factor Ac
    308 .It Ao Va factor Ac Ta ::= Ta Vt real
    309 .It \  Ta Ta
    310 .It Ao Va green-id Ac Ta ::= Ta Vt integer
    311 .It Ao Va name Ac Ta ::= Ta Vt string
    312 .El
    313 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    314 .Ss Binary format
    315 Binary Green outputs are formated according to the various C types from the
    316 .Pa stardis-green.h
    317 header file.
    318 The output begins with a header
    319 .Pq of type Vt struct green_file_header
    320 that includes counts, followed by descriptions
    321 .Pq of type Vt struct green_description
    322 and samples.
    323 Thereafter is the format of binary Green outputs.
    324 This output is produced by
    325 .Sy fwrite
    326 calls and does not take care of endianness.
    327 .Pp
    328 The binary file format of a Green function is as follows:
    329 .Bl -column (******************) (::=) ()
    330 .It Ao Va green-binary Ac Ta ::= Ta Li GREEN_BIN_FILE\&:
    331 .It Ta Ta Aq Va file_format_version
    332 .It Ta Ta Aq Va #descriptions
    333 .It Ta Ta Aq Va #solids
    334 .It Ta Ta Aq Va #fluids
    335 .It Ta Ta Aq Va #robin-boundaries
    336 .It Ta Ta Aq Va #dirichlet-boundaries
    337 .It Ta Ta Aq Va #neumann-boundaries
    338 .It Ta Ta Aq Va #solid-fluid-connects
    339 .It Ta Ta Aq Va #solid-solid-connects
    340 .It Ta Ta Aq Va #successes
    341 .It Ta Ta Aq Va #failures
    342 .It Ta Ta Aq Va Trad
    343 .It Ta Ta Aq Va Trad-ref
    344 .It Ta Ta Aq Va time-range
    345 .It Ta Ta Ao Va description Ac ...
    346 .It Ta Ta Ao Va sample Ac ...
    347 .It \  Ta Ta
    348 .It Ao Va file_format_version Ac Ta ::= Ta Vt unsigned
    349 .It Ao Va #descriptions Ac Ta ::= Ta Vt unsigned
    350 .It Ao Va #solids Ac Ta ::= Ta Vt unsigned
    351 .It Ao Va #fluids Ac Ta ::= Ta Vt unsigned
    352 .It Ao Va #robin-boundaries Ac Ta ::= Ta Vt unsigned
    353 .It Ao Va #dirichlet-boundaries Ac Ta ::= Ta Vt unsigned
    354 .It Ao Va #neumann-boundaries Ac Ta ::= Ta Vt unsigned
    355 .It Ao Va #solid-fluid-connects Ac Ta ::= Ta Vt unsigned
    356 .It Ao Va #solid-solid-connects Ac Ta ::= Ta Vt unsigned
    357 .It Ao Va #successes Ac Ta ::= Ta Vt size_t
    358 .It Ao Va #failures Ac Ta ::= Ta Vt size_t
    359 .It Ao Va Trad Ac Ta ::= Ta Vt double No # Radiative temperature
    360 .It Ao Va Trad-ref Ac Ta ::= Ta Vt double No # Reference radiative temperature
    361 .It Ao Va time-range Ac Ta ::= Ta Vt double[2]
    362 .It \  Ta Ta
    363 .It Ao Va description Ac Ta ::= Ta Vt struct green_description
    364 .It \  Ta Ta
    365 .It Ao Va sample Ac Ta ::= Ta Ao Va sample-header Ac
    366 .It Ta Ta Ao Va power-id Ac ...
    367 .It Ta Ta Ao Va flux-id Ac ...
    368 .It Ta Ta Ao Va power-weight Ac ...
    369 .It Ta Ta Ao Va flux-weight Ac ...
    370 .It Ao Va sample-header Ac Ta ::= Ta Vt struct green_sample_header
    371 .It Ao Va power-id Ac Ta ::= Ta Vt unsigned
    372 .It Ao Va flux-id Ac Ta ::= Ta Vt unsigned
    373 .It Ao Va power-weight Ac Ta ::= Ta Vt double
    374 .It Ao Va flux-weight Ac Ta ::= Ta Vt double
    375 .El
    376 .Pp
    377 Binary Green function can be followed by partial information on the
    378 sampled paths.
    379 The output data are restricted to paths' ends.
    380 .Bl -column (******************) (::=) ()
    381 .It Ao Va paths Ac Ta ::= Ta Li \&"End\&"\&, \&"End ID\&"\&, \&"X\&"\&, \&"Y\&"\&, \&"Z\&"\&, \e
    382 .It Ta Ta Li \&"Elapsed Time\&"
    383 .It Ta Ta Ao Va path-end Ac
    384 .It Ta Ta ...
    385 .It \  Ta Ta
    386 .It Ao Va path-end Ac Ta ::= Ta \
    387 Ao Va end-name Ac Ns Li \&, \
    388 Ao Va end-id Ac Ns Li \&, \
    389 Ao Va x Ac Ns Li \&, \
    390 Ao Va y Ac Ns Li \&, \
    391 Ao Va z Ac Ns Li \&, \e
    392 .It Ta Ta Ao Va elapsed-time Ac
    393 .It Ao Va end-name Ac Ta ::= Ta Vt string No # Boundary name or TRAD
    394 .It Ao Va end-id Ac Ta ::= Ta Vt integer
    395 .It Ao Va x Ac Ta ::= Ta Vt real
    396 .It Ao Va y Ac Ta ::= Ta Vt real
    397 .It Ao Va z Ac Ta ::= Ta Vt real
    398 .It Ao Va elapsed-time Ac Ta ::= Ta Vt real No # [s]
    399 .El
    400 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    401 .\" Geometry
    402 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    403 .Sh GEOMETRY DUMP
    404 A
    405 .Aq Va geometry-dump
    406 is generated when
    407 .Xr stardis 1
    408 is invoked with option
    409 .Fl d .
    410 In this mode,
    411 .Xr stardis 1
    412 outputs the system geometry, as submitted in
    413 .Xr stardis-input 5
    414 description, to standard output in VTK format.
    415 The output geometry is
    416 .Em not
    417 the concatenation of the various geometry files
    418 used in
    419 .Xr stardis-input 5
    420 description.
    421 It is the result of a deduplication process that removes duplicate and
    422 degenerated triangles from the submited geometry.
    423 Additionaly, as permitted by the VTK format, the output geometry is
    424 decorated with many different properties provided to help users
    425 understand the description processing, including possible errors.
    426 .Pp
    427 If errors are detected, some optional error-related data fields are
    428 included in the geometry file.
    429 Some errors report a by-triangle error status, other errors report a
    430 by-enclosure error status.
    431 .Pp
    432 Also, holes in the geometry, if any, are reported in geometry dumps.
    433 A hole is defined by its frontier that is a collection of triangles
    434 surrounding the hole.
    435 Such triangles are detected as having their 2 sides in the same
    436 enclosure, but with a different medium on each side.
    437 .Pp
    438 Media information is provided in two different flavours.
    439 First the medium on front and back sides of triangles can be found
    440 through the
    441 .Li Front_medium
    442 and
    443 .Li Back_medium
    444 fields.
    445 These fields use the special value
    446 .Sy INT_MAX
    447 for sides with no defined medium, as one can expect on boundary
    448 triangles.
    449 On the other hand, medium information provided by the
    450 Enclosures_internal_media field displays the id of the medium created to
    451 hold boundary information for boundary triangles.
    452 In either case, media numbering information can be found in log messages
    453 if option
    454 .Fl V Ar 3
    455 is used in conjunction with the
    456 .Fl d
    457 dump option.
    458 .Pp
    459 The VTK layout is as follows:
    460 .Bl -column (******************) (::=) ()
    461 .It Ao Va geometry-dump Ac Ta ::= Ta Li # vtk DataFile Version 2.0
    462 .It Ta Ta Ao Va description Ac
    463 .It Ta Ta Li ASCII
    464 .It Ta Ta Li DATASET POLYDATA
    465 .It Ta Ta Aq Va vertices
    466 .It Ta Ta Aq Va triangles
    467 .It Ta Ta Li CELL_DATA Ao Va #triangles Ac
    468 .It Ta Ta Aq Va front-media
    469 .It Ta Ta Aq Va back-media
    470 .It Ta Ta Aq Va interfaces
    471 .It Ta Ta Aq Va unique-ids
    472 .It Ta Ta Aq Va user-ids
    473 .It Ta Ta Op Aq Va merge-conflicts
    474 .It Ta Ta Op Aq Va property-conflicts
    475 .It Ta Ta Aq Va file-ids
    476 .It Ta Ta Aq Va boundaries
    477 .It Ta Ta Op Aq Va compute-region
    478 .It Ta Ta Aq Va encl-or-overlaps
    479 .It \  Ta Ta
    480 .It Ao Va description Ac Ta ::= Ta Vt string No # Up to 256 characters
    481 .El
    482 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    483 .Ss Geometry
    484 .Bl -column (******************) (::=) ()
    485 .It Ao Va vertices Ac Ta ::= Ta Li POINTS Ao Va #vertices Ac Li double
    486 .It Ta Ta Ao Va x Ac Ao Va y Ac Ao Va z Ac
    487 .It Ta Ta ...
    488 .It Ao Va triangles Ac Ta ::= Ta Li POLYGONS Ao Va #triangles Ac Ao Va #triangles*4 Ac
    489 .It Ta Ta Li 3 Ao Va vertex-id Ac Ao Va vertex-id Ac Ao Va vertex-id Ac
    490 .It Ta Ta ...
    491 .El
    492 .Pp
    493 List triangle indices
    494 .Em after
    495 .Xr stardis 1
    496 deduplication:
    497 .Bl -column (******************) (::=) ()
    498 .It Ao Va unique-ids Ac Ta ::= Ta Li SCALARS Unique_ID unsigned_int 1
    499 .It Ta Ta Li LOOKUP_TABLE default
    500 .It Ta Ta Ao Va triangle-id Ac No # \&In Bq 0, Ao Va #triangles Ac
    501 .It Ta Ta ... # Up to Aq Va #triangles
    502 .El
    503 .Pp
    504 List triangle indices
    505 .Em before
    506 deduplication to let the caller indentify his geometry as submitted to
    507 .Xr stardis 1 :
    508 .Bl -column (******************) (::=) ()
    509 .It Ao Va user-ids Ac Ta ::= Ta Li SCALARS User_ID unsigned_int 1
    510 .It Ta Ta Li LOOKUP_TABLE default
    511 .It Ta Ta Ao Va triangle-id Ac
    512 .It Ta Ta ... # Up to Aq Va #triangles
    513 .El
    514 .Pp
    515 List the file identifier in which each triangle first appeared:
    516 .Bl -column (******************) (::=) ()
    517 .It Ao Va file-ids Ac Ta ::= Ta Li SCALARS Created_at_sg3d_geometry_add \e
    518 .It Ta Ta Li unsigned_int 1
    519 .It Ta Ta Li LOOKUP_TABLE default
    520 .It Ta Ta Aq Va file-rank
    521 .It Ta Ta ... # Up to Aq Va #triangles
    522 .It \  Ta Ta
    523 .It Ao Va #vertices Ac Ta ::= Ta Vt integer
    524 .It Ao Va #triangles Ac Ta ::= Ta Vt integer
    525 .It Ao Va #triangles*4 Ac Ta ::= Ta Vt integer
    526 .It Ao Va vertex-id Ac Ta ::= Ta Vt integer No # \&In Bq 0, Ao Va #vertices Ac
    527 .It Ao Va triangle-id Ac Ta ::= Ta Vt integer
    528 .It Ao Va x Ac Ta ::= Ta Vt real
    529 .It Ao Va y Ac Ta ::= Ta Vt real
    530 .It Ao Va z Ac Ta ::= Ta Vt real
    531 .It Ao Va file-rank Ac Ta ::= Ta Vt integer
    532 .El
    533 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    534 .Ss Properties
    535 .Bl -column (******************) (::=) ()
    536 .It Ao Va front-media Ac Ta ::= Ta Li SCALARS Front_medium unsigned_int 1
    537 .It Ta Ta Li LOOKUP_TABLE default
    538 .It Ta Ta Ao Va medium-id Ac | Ao Va undef-medium Ac
    539 .It Ta Ta ... # Up to Aq Va #triangles
    540 .It Ao Va back-media Ac Ta ::= Ta Li SCALARS Back_medium unsigned_int 1
    541 .It Ta Ta Li LOOKUP_TABLE default
    542 .It Ta Ta Ao Va medium-id Ac | Ao Va undef-medium Ac
    543 .It Ta Ta ... # Up to Aq Va #triangles
    544 .It Ao Va interfaces-media Ac Ta ::= Ta Li SCALARS Interface unsigned_int 1
    545 .It Ta Ta Li LOOKUP_TABLE default
    546 .It Ta Ta Ao Va interface-id Ac
    547 .It Ta Ta ... # Up to Aq Va #triangles
    548 .It Ao Va boundaries Ac Ta ::= Ta Li SCALARS Boundaries unsigned_int 1
    549 .It Ta Ta Li LOOKUP_TABLE default
    550 .It Ta Ta Aq Va boundary-id
    551 .It Ta Ta ... # Up to Aq Va #triangles
    552 .It \  Ta Ta
    553 .It Ao Va medium-id Ac Ta ::= Ta Vt integer
    554 .It Ao Va undef-medium Ac Ta ::= Ta Sy INT_MAX
    555 .It Ao Va interface-id Ac Ta ::= Ta Vt integer
    556 .It Ao Va boundary-id Ac Ta ::= Ta Vt integer
    557 .El
    558 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    559 .Ss Compute region
    560 Define which triangles are members of the surface on which
    561 .Xr stardis 1
    562 performs the calculation
    563 .Pq options Fl F , Fl S No or Fl s :
    564 .Bl -column (******************) (::=) ()
    565 .It Ao Va compute-region Ac Ta ::= Ta Li SCALARS Compute_region unsigned_int 1
    566 .It Ta Ta Li LOOKUP_TABLE default
    567 .It Ta Ta Aq Va region-membership
    568 .It Ta Ta ... # Up to Aq Va #triangles
    569 .It Ao Va region-membership Ac Ta ::= Ta Li 0 No # Not member
    570 .It Ta \& \& | Ta Li 1 No # The front side is member
    571 .It Ta \& \& | Ta Li 2 No # The back side is member
    572 .It Ta \& \& | Ta Li 3 No # Both sides are members
    573 .It Ta \& \& | Ta Sy INT_MAX No # Error: must not be member
    574 .El
    575 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    576 .Ss Check description problems
    577 Define which triangles have an invalid media definition when merging
    578 partitions:
    579 .Bl -column (******************) (::=) ()
    580 .It Ao Va merge-conflicts Ac Ta ::= Ta Li SCALARS Merge_conflict int 1
    581 .It Ta Ta Li LOOKUP_TABLE default
    582 .It Ta Ta Aq Va merge-conflict-id
    583 .It Ta Ta ... # Up to Aq Va #triangles
    584 .It Ao Va merge-conflict-id Ac Ta ::= Ta Li 0 No # \&No conflict
    585 .It Ta \& \& | Ta Li 1 No # Conflict
    586 .El
    587 .Pp
    588 Define which triangles have an invalid limit condition or an invalid
    589 connection and report what is wrong:
    590 .Bl -column (******************) (::=) ()
    591 .It Ao Va property-conflicts Ac Ta ::= Ta Li SCALARS Property_conflict int 1
    592 .It Ta Ta Aq Va prop-conflict-id
    593 .It Ta Ta ...
    594 .It Ao Va prop-conflict-id Ac Ta ::= Ta Li 0 No # \&No conflict
    595 .It Ta \& \& | Ta Li 1 No # Robin btw 2 defined fluids
    596 .It Ta \& \& | Ta Li 2 No # Robin btw 2 undefined fluids
    597 .It Ta \& \& | Ta Li 3 No # Robin on fluid applied to solid
    598 .It Ta \& \& | Ta Li 4 No # Robin btw 2 defined solids
    599 .It Ta \& \& | Ta Li 5 No # Robin btw 2 undefined solids
    600 .It Ta \& \& | Ta Li 6 No # Robin on solid applied to fluid
    601 .It Ta \& \& | Ta Li 7 No # Robin&Neumann btw 2 defined media
    602 .It Ta \& \& | Ta Li 8 No # Robin&Neumann btw 2 undefined media
    603 .It Ta \& \& | Ta Li 9 No # Robin&Neumann applied to fluid
    604 .It Ta \& \& | Ta Li 10 No # Dirichlet btw 2 defined solids
    605 .It Ta \& \& | Ta Li 11 No # Dirichlet btw 2 undefined solids
    606 .It Ta \& \& | Ta Li 12 No # Dirichlet on solid applied to fluid
    607 .It Ta \& \& | Ta Li 13 No # Neumann btw 2 defined media
    608 .It Ta \& \& | Ta Li 14 No # Neumann btw 2 undefined media
    609 .It Ta \& \& | Ta Li 15 No # Neumann applied to fluid
    610 .It Ta \& \& | Ta Li 16 No # Solid/fluid btw 2 solids
    611 .It Ta \& \& | Ta Li 17 No # Solid/fluid btw 2 fluids
    612 .It Ta \& \& | Ta Li 18 No # Solid/fluid used as boundary
    613 .It Ta \& \& | Ta Li 19 No # Solid/fluid btw 2 undefined media
    614 .It Ta \& \& | Ta Li 20 No # \&No connection btw fluid/fluid
    615 .It Ta \& \& | Ta Li 21 No # \&No connection btw solid/fluid
    616 .It Ta \& \& | Ta Li 22 No # \&No boundary around fluid
    617 .It Ta \& \& | Ta Li 23 No # \&No boundary around solid
    618 .It Ta \& \& | Ta Li 24 No # Invalid part of a compute surface
    619 .El
    620 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    621 .Ss Enclosure
    622 .Bl -column (******************) (::=) ()
    623 .It Ao Va encl-or-overlaps Ac Ta ::= Ta Ao Va encl-information Ac
    624 .It Ta \& \& | Ta Ao Va overlappings Ac
    625 .It \  Ta Ta
    626 .It Ao Va encl-information Ac Ta ::= Ta Oo Ao Va holes Ac Oc No # If any
    627 .It Ta Ta Aq Va enclosures
    628 .It \  Ta Ta
    629 .It Ao Va enclosures Ac Ta ::= Ta Li FIELD FieldData 2
    630 .It Ta Ta Ao Va enclosures-geoms Ac
    631 .It Ta Ta Ao Va enclosures-media Ac
    632 .El
    633 .Pp
    634 Report which triangles surround a hole:
    635 .Bl -column (******************) (::=) ()
    636 .It Ao Va holes Ac Ta ::= Ta Li SCALARS Hole_frontiers unsigned_int 1
    637 .It Ta Ta Li LOOKUP_TABLE default
    638 .It Ta Ta Aq Va hole-membership
    639 .It Ta Ta ... # Up to Aq Va #triangles
    640 .It Ao Va hole-membership Ac Ta ::= Ta Li 0 No # Not surrounding a hole
    641 .It Ta Ta Li 1 No # Surrounding a hole
    642 .El
    643 .Pp
    644 List the enclosures to which the triangle belongs and report the
    645 validity status of the enclosures:
    646 .Bl -column (******************) (::=) ()
    647 .It Ao Va enclosures-geoms Ac Ta ::= Ta Li Enclosures Ao Va #enclosures Ac \e
    648 .It Ta Ta Ao Va #triangles Ac Li unsigned_char
    649 .It Ta Ta Ao Va encl-status Ac ... # Up to Aq Va #enclosures
    650 .It Ta Ta ... # Up to Aq Va #triangles
    651 .It Ao Va encl-status Ac Ta ::= Ta Li 0 No # Not part of the enclosure
    652 .It Ta \& \& | Ta Li 1 No # Enclosure is valid
    653 .It Ta \& \& | Ta Li 3 No # More than 1 medium
    654 .It Ta \& \& | Ta Li 5 No # Triangles with undef medium
    655 .It Ta \& \& | Ta Li 7 No # More than 1 medium including undef
    656 .El
    657 .Pp
    658 List the media that the triangle surrounds for each enclosure and report
    659 media description problems:
    660 .Bl -column (******************) (::=) ()
    661 .It Ao Va enclosures-media Ac Ta ::= Ta Li Enclosures_internal_media Ao Va #enclosures Ac \e
    662 .It Ta Ta Ao Va #triangles Ac  Li unsigned_char
    663 .It Ta Ta Ao Va encl-media Ac ... # Up to Aq Va #enclosures
    664 .It Ta Ta ... # Up to Aq Va #triangles
    665 .It Ao Va encl-media Ac Ta ::= Ta Ao Va medium-id Ac No # Medium of the enclosure
    666 .It Ta \& \& | Ta Sy INT_MAX No # Not part of the enclosure
    667 .It Ta \& \& | Ta Sy INT_MAX Ns Li -1 No # Error: \&in the enclosure
    668 .It Ta \& \& | Ta Sy INT_MAX Ns Li -2 No # Error: medium missing
    669 .El
    670 .Pp
    671 Report problems of triangle overlap:
    672 .Bl -column (******************) (::=) ()
    673 .It Ao Va overlappings Ac Ta ::= Ta Li SCALARS Overlapping_triangles \e
    674 .It Ta Ta unsigned_int 1
    675 .It Ta Ta Li LOOKUP_TABLE default
    676 .It Ta Ta Ao Va overlapping-status Ac
    677 .It Ta Ta ... # Up to Aq Va #triangles
    678 .It Ao Va overlapping-status Ac Ta ::= Ta Li 0 No # Doesn't overlap another triangle
    679 .It Ta \& \& | Ta Li 1 No # Error: overlaps another triangle
    680 .El
    681 .Bl -column (******************) (::=) ()
    682 .It Ao Va #enclosures Ac Ta ::= Ta Vt integer
    683 .El
    684 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    685 .\" Infrared image
    686 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    687 .Sh INFRARED IMAGE
    688 When invoked with option
    689 .Fl R ,
    690 .Xr stardis 1
    691 calculates an infrared image of the system and write it to standard
    692 output.
    693 Depending on the
    694 .Cm fmt
    695 sub-option, this file can be either in
    696 .Xr htrdr-image 5
    697 format or in VTK format.
    698 .Bl -column (******************) (::=) ()
    699 .It Ao Va infrared-image Ac Ta ::= Ta Ao Va infrared-image-ht Ac # Option Fl R Cm fmt=HT
    700 .It Ta \& \& | Ta Ao Va infrared-image-vtk Ac # Option Fl R Cm fmt=VTK
    701 .El
    702 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    703 .Ss htrdr-image format
    704 The
    705 .Xr htrdr-image 5
    706 layout of an infrared image is as follows:
    707 .Bl -column (******************) (::=) ()
    708 .It Ao Va infrared-image-ht Ac Ta ::= Ta Ao Va definition Ac
    709 .It Ta Ta Aq Va pixel
    710 .It Ta Ta ... # Up to number of pixels
    711 .It \  Ta Ta
    712 .It Ao Va definition Ac Ta ::= Ta Ao Va width Ac Ao Va height Ac
    713 .It Ao Va width Ac Ta ::= Ta Vt integer
    714 .It Ao Va height Ac Ta ::= Ta Vt integer
    715 .It \  Ta Ta
    716 .It Ao Va pixel Ac Ta ::= Ta Ao Va temperature Ac Li 0 0 0 0 Ao Va time Ac
    717 .It Ao Va temperature Ac Ta ::= Ta Ao Va estimate Ac
    718 .It Ao Va time Ac Ta ::= Ta Ao Va estimate Ac # Time per realisation
    719 .It \  Ta Ta
    720 .It Ao Va estimate Ac Ta ::= Ta Ao Va expected-value Ac Ao Va standard-error Ac
    721 .It Ao Va expected-value Ac Ta ::= Ta Vt real
    722 .It Ao Va standard-error Ac Ta ::= Ta Vt real
    723 .El
    724 .Pp
    725 See
    726 .Xr htpp 1
    727 to convert images in
    728 .Xr htrdr-image 5
    729 format into a regular image.
    730 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    731 .Ss VTK format
    732 An infrared VTK image is an XY plane.
    733 By convention, the origin
    734 .Pq 0,0
    735 pixel is at the top-left corner of the image.
    736 The result not only includes the computed temperature image, but also
    737 includes a per-pixel computation time image as well as a per-pixel path
    738 error count image and per-pixel standard deviation images for both
    739 temperature and computation time.
    740 .Pp
    741 The VTK layout of an infrared image is as follows:
    742 .Bl -column (******************) (::=) ()
    743 .It Ao Va infrared-image-vtk Ac Ta ::= Ta Li # vtk DataFile Version 2.0
    744 .It Ta Ta Ao Va description Ac
    745 .It Ta Ta Li DATASET STRUCTURED_POINTS
    746 .It Ta Ta Li DIMENSIONS Ao Va width Ac Ao Va height Ac Li 1
    747 .It Ta Ta Li ORIGIN 0 0 0
    748 .It Ta Ta Li SPACING 1 1 1
    749 .It Ta Ta Li POINT_DATA Ao Va #pixels Ac
    750 .It Ta Ta Aq Va temp
    751 .It Ta Ta Aq Va temp-stderr
    752 .It Ta Ta Aq Va time
    753 .It Ta Ta Aq Va time-stderr
    754 .It Ta Ta Aq Va failures-count
    755 .It \  Ta Ta
    756 .It Ao Va temp Ac Ta ::= Ta Li SCALARS temperature_estimate float 1
    757 .It Ta Ta Li LOOKUP_TABLE default
    758 .It Ta Ta Vt real
    759 .It Ta Ta ... # Up to Aq Va #pixels
    760 .It \  Ta Ta
    761 .It Ao Va temp-stderr Ac Ta ::= Ta Li SCALARS temperature_std_dev float 1
    762 .It Ta Ta Li LOOKUP_TABLE default
    763 .It Ta Ta Vt real
    764 .It Ta Ta ... # Up to Aq Va #pixels
    765 .It \  Ta Ta
    766 .It Ao Va time Ac Ta ::= Ta Li SCALARS computation_time float 1
    767 .It Ta Ta Li LOOKUP_TABLE default
    768 .It Ta Ta Vt real
    769 .It Ta Ta ... # Up to Aq Va #pixels
    770 .It \  Ta Ta
    771 .It Ao Va time-stderr Ac Ta ::= Ta Li SCALARS computation_time_std_dev float 1
    772 .It Ta Ta Li LOOKUP_TABLE default
    773 .It Ta Ta Vt real
    774 .It Ta Ta ... # Up to Aq Va #pixels
    775 .It \  Ta Ta
    776 .It Ao Va failures-count Ac Ta ::= Ta Li SCALARS failures_count \e
    777 .It Ta Ta Li unsigned_long_long 1
    778 .It Ta Ta Li LOOKUP_TABLE default
    779 .It Ta Ta Vt integer
    780 .It Ta Ta ... # Up to Aq Va #pixels
    781 .It \  Ta Ta
    782 .It Ao Va #pixels Ac Ta ::= Ta Vt integer No # = Ao Va width Ac * Ao Va height Ac
    783 .It Ao Va width Ac Ta ::= Ta Vt integer
    784 .It Ao Va height Ac Ta ::= Ta Vt integer
    785 .It Ao Va description Ac Ta ::= Ta Vt string No # Up to 256 characters
    786 .El
    787 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    788 .\" Heath paths
    789 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    790 .Sh HEAT PATHS
    791 When the
    792 .Xr stardis 1
    793 option
    794 .Fl D
    795 is used in conjunction with an option that computes a result, some of
    796 the heat paths
    797 .Pq successful paths, erroneous paths, or both
    798 sampled during the simulation are written to files.
    799 Each path is written in VTK format, one VTK file per path.
    800 The path description can include vertices' time if it makes sense, that
    801 is if the computation time is not
    802 .Sy INF .
    803 .Pp
    804 Due to the branching nature of non-linear Monte Carlo algorithms, paths
    805 are made of strips.
    806 With a Picard order of 1
    807 .Pq option Fl o Ar 1 ,
    808 there is only a single strip.
    809 With higher orders, the number of strips can be greater than 1.
    810 As a result, the whole path is a tree: past the first strip, each strip
    811 can start from any vertex of one of the previous strips.
    812 This tree, when displaying the
    813 .Li Branch_id
    814 field, starts with id 0, then increments each time a non-linearity leads
    815 to the creation of a new strip
    816 .Pq to fetch a temperature .
    817 .Pp
    818 The VTK layout of a path is as follows:
    819 .Bl -column (******************) (::=) ()
    820 .It Ao Va heat-path Ac Ta ::= Ta Li # vtk DataFile Version 2.0
    821 .It Ta Ta Aq Va description
    822 .It Ta Ta Li ASCII
    823 .It Ta Ta Li DATASET POLYDATA
    824 .It Ta Ta Aq Va vertices
    825 .It Ta Ta Aq Va strips
    826 .It Ta Ta Li CELL_DATA Aq Va #strips
    827 .It Ta Ta Aq Va status
    828 .It Ta Ta Li POINT_DATA Aq Va #vertices
    829 .It Ta Ta Aq Va segment-types
    830 .It Ta Ta Aq Va weights
    831 .It Ta Ta Aq Va branch-ids
    832 .It Ta Ta Oo Ao Va vertices-time Ac Oc # If not steady
    833 .It \  Ta Ta
    834 .It Ao Va description Ac Ta ::= Ta Vt string No # Up to 256 characters
    835 .It Ao Va #vertices Ac Ta ::= Ta Vt integer
    836 .It Ao Va #strips Ac Ta ::= Ta Vt integer
    837 .El
    838 .Pp
    839 List the vertices of the main trajectory and its branches:
    840 .Bl -column (******************) (::=) ()
    841 .It Ao Va vertices Ac Ta ::= Ta Li POINTS Ao Va #vertices Ac Li double
    842 .It Ta Ta Ao Va x Ac Ao Va y Ac Ao Va z Ac
    843 .It Ta Ta ... # Up to Aq Va #vertices
    844 .It Ao Va x Ac Ta ::= Ta Vt real
    845 .It Ao Va y Ac Ta ::= Ta Vt real
    846 .It Ao Va z Ac Ta ::= Ta Vt real
    847 .El
    848 .Pp
    849 List the main trajectory and branches of the path:
    850 .Bl -column (******************) (::=) ()
    851 .It Ao Va strips Ac Ta ::= Ta  Li LINES Ao Va #strips Ac Ao Va strip-list-size Ac
    852 .It Ta Ta Ao Va #strip-vertices Ac Ao Va vertex-id  Ac ...
    853 .It Ta Ta ... # Up to Aq Va #strips
    854 .It Ao Va strip-list-size Ac Ta ::= Ta Vt integer No # vertices per strip + Ao Va #strips Ac
    855 .It Ao Va vertex-id Ac Ta ::= Ta Vt integer No # \&In [0 , Ao Va #vertices Ac Ns [
    856 .El
    857 .Pp
    858 Status of the path:
    859 .Bl -column (******************) (::=) ()
    860 .It Ao Va status Ac Ta ::= Ta Li SCALARS Path_Failure unsigned_char 1
    861 .It Ta Ta Li 0 | Li 1 No # 0: Success; 1: Failure
    862 .It Ta Ta ... # Up to Aq Va #strips
    863 .El
    864 .Pp
    865 List the type of heat transfert to which each path vertex belongs:
    866 .Bl -column (******************) (::=) ()
    867 .It Ao Va segment-types Ac Ta ::= Ta Li SCALARS Segment_Type unsigned_char 1
    868 .It Ta Ta Li LOOKUP_TABLE default
    869 .It Ta Ta Aq Va segment-type
    870 .It Ta Ta ... # Up to Aq Va #vertices
    871 .It Ao Va segment-type Ac Ta ::= Ta Li 0 No # Conduction
    872 .It Ta \& \& | Ta Li 1 No # Convection
    873 .It Ta \& \& | Ta Li 2 No # Radiative
    874 .El
    875 .Pp
    876 Monte Carlo weight along the path:
    877 .Bl -column (******************) (::=) ()
    878 .It Ao Va weights Ac Ta ::= Ta Li SCALARS Weight double 1
    879 .It Ta Ta Li LOOKUP_TABLE default
    880 .It Ta Ta Vt real
    881 .It Ta Ta ... # Up to Aq Va #vertices
    882 .El
    883 .Pp
    884 List the identifier of the main path and its branches with respect to
    885 the branch depth:
    886 .Bl -column (******************) (::=) ()
    887 .It Ao Va branch-ids Ac Ta ::= Ta Li SCALARS Branch_id int 1
    888 .It Ta Ta Li LOOKUP_TABLE default
    889 .It Ta Ta Vt integer No # \&In [0 , Picard_order[
    890 .It Ta Ta ... # Up to Aq Va #vertices
    891 .El
    892 .Pp
    893 Rewinded time along the path:
    894 .Bl -column (******************) (::=) ()
    895 .It Ao Va vertices-time Ac Ta ::= Ta Li SCALARS Time double 1
    896 .It Ta Ta Li LOOKUP_TABLE default
    897 .It Ta Ta Vt real No # Time [s]
    898 .It Ta Ta ... # Up to Aq Va #vertices
    899 .El
    900 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    901 .\" External references
    902 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
    903 .Sh SEE ALSO
    904 .Xr htpp 1 ,
    905 .Xr stardis 1 ,
    906 .Xr htrdr-image 5 ,
    907 .Xr stardis-input 5
    908 .Sh STANDARDS
    909 .Rs
    910 .%B The VTK User's Guide
    911 .%O Simple Legacy Formats
    912 .%I Kitware, Inc
    913 .%N 11
    914 .%D 2010
    915 .%P 470--482
    916 .Re