star-phor

Radiative transfer solver for photoreactors.
git clone https://www.edstar.cnrs.fr/git/star-phor.git
Log | Files | Refs | README | LICENSE

star-phor.scd (4200B)

      1 star-phor(1) "UNIX"
      2 
      3 ; Copyright (C) 2024-2026 Centre National de la Recherche Scientifique
      4 ; Copyright (C) 2024-2026 Clermont Auvergne INP
      5 ; Copyright (C) 2024-2026 INSA Lyon
      6 ; Copyright (C) 2024-2026 Institut Mines Télécom Albi-Carmaux
      7 ; Copyright (C) 2024-2026 Institut National Polytechnique de Toulouse
      8 ; Copyright (C) 2024-2026 |Méso|Star> (contact@meso-star.com)
      9 ; Copyright (C) 2024-2026 PhotonLyX (info@photonlyx.com)
     10 ; Copyright (C) 2024-2026 Université de Lorraine
     11 ; Copyright (C) 2024-2026 Université Paul Sabatier
     12 ; Copyright (C) 2024-2026 Université Toulouse - Jean Jaurès
     13 ; 
     14 ; This program is free software: you can redistribute it and/or modify
     15 ; it under the terms of the GNU General Public License as published by
     16 ; the Free Software Foundation, either version 3 of the License, or
     17 ; (at your option) any later version.
     18 ; 
     19 ; This program is distributed in the hope that it will be useful,
     20 ; but WITHOUT ANY WARRANTY; without even the implied warranty of
     21 ; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
     22 ; GNU General Public License for more details.
     23 ; 
     24 ; You should have received a copy of the GNU General Public License
     25 ; along with this program. If not, see <http://www.gnu.org/licenses/>.
     26 
     27 # NAME
     28 
     29 *star-phor* - statistical solver for the RTE in photoreactors
     30 
     31 # SYNOPSIS
     32 *star-phor* [*-fhv*] [*-n* _samples_] [*-o* _output_] [*-t* _threads_] [_file_]
     33 
     34 # DESCRIPTION
     35 
     36 *star-phor* solves the radiative transfer equation (RTE) in a photoreactive
     37 configuration defined using the _star-phor-input_(5) configuration file
     38 specification. If the _file_ is not defined, the configuration is readen from
     39 the standard input.
     40 Currently, *star-phor* is capable of evaluating the mean volumetric rate of
     41 energy absorption (MVREA), as well as the total energy absorbed by a given
     42 surface, provided that the corresponding volume or surface is defined as a
     43 sensor in the configuration file. Results are written according to the
     44 _star-phor-output_(5) specification.
     45 
     46 *star-phor* employs state-of-the-art Monte Carlo techniques to compute these
     47 quantities, benefiting from the inherent advantages of the method, such as a
     48 computational cost independent of geometrical complexity, scale ratios, and
     49 phenomenological complexity. Parallelism is also implemented.
     50 
     51 Options are as follows:
     52 
     53 *-f*
     54 	Force overwriting of the _output_ file if it already exists.
     55 
     56 *-h*
     57 	Output short help and exit.
     58 
     59 *-n* _samples_count_
     60 	By default, the number of realisations is 10000.
     61 
     62 *-o* _output_
     63 	File in which the simulation results will be written. If none is
     64 	specified, star-phor will write to the standard output.
     65 
     66 *-t* _threads_count_
     67 	Advice on the number of threads to use.  By default, star-phor uses all
     68 	available threads.
     69 
     70 *-v*
     71 	Make star-phor verbose. Multiple *-v* options increase the verbosity. The
     72 	maximum is 3. Possible values are ‘0’ (no message), ‘1’ (*-v*; error
     73 	messages only), ‘2’ (*-vv*; error and warning messages), and ‘3’
     74 	(*-vvv*; error, warning and informative messages). All the messages are
     75 	written to standard error. Default is 0.
     76 
     77 # EXIT STATUS
     78 
     79 The *star-phor* utility exits 0 on success, and >0 if an error occurs.
     80 
     81 # EXAMPLES
     82 
     83 Simulate radiative transfer for the system described in the _photoreactor.txt_
     84 file, according to the *star-phor-input*(5) grammar.
     85 Make the program as detailed as possible (options *-vvv*) and use as many threads
     86 as there are cores available on the system (default behavior).
     87 Use 100,000 Monte Carlo realisations to estimate the sensor measurements as
     88 listed in the _photoreactor.txt_ input file (option *-n*).
     89 Finally, write the estimated values to the _result.txt_ file, unless this file
     90 already exists.
     91 In this case, *star-phor* will stop without performing the calculation and
     92 return an error.
     93 This behavior prevents previous results from being accidentally overwritten.
     94 To force the file to be rewritten, the user should explicitly define the *-f*
     95 option.
     96 
     97 ```
     98 star-phor -vvv -n 100000 -o result.txt photoreactor.txt
     99 ```
    100 
    101 # SEE ALSO
    102 _star-phor-input_(5), _sphin_(1)
    103 
    104 # HISTORY
    105 
    106 *star-phor* has been developed thanks to the funding of the ECOCHEM
    107 project (ProjetIA-22-PESP-0006) belonging to the *PEPR SPLEEN*.