commit f704905ae0be661e2f432f55ac54b8d3be80e511
parent 17725ded63f3bb869670747b45ed00b3c0ec08f3
Author: Eduardo Fontana Lazzari <edufonlaz@gmail.com>
Date: Mon, 6 Apr 2026 17:49:08 +0200
Improve text style and fix typos in README and man pages
Special thanks to Dr. K. Loubiere for proofreading and for the
suggestions.
Diffstat:
3 files changed, 26 insertions(+), 23 deletions(-)
diff --git a/README.md b/README.md
@@ -1,26 +1,27 @@
# star-phor
-star-phor is a radiative transfer solver for photoreactors. Built upon the
-star-phor-input configuration file specification and the sphin library, it
-structures physical and geometrical data to facilitate path sampling and to
-estimate the solution of the radiative transfer equation as the expectation of
-random variables using the Monte Carlo method.
+**star-phor** is a radiative transfer solver for photoreactors. Built
+upon the **star-phor-input** configuration file specification and the
+**sphin** library, it structures physical and geometrical data to
+facilitate path sampling and to estimate the solution of the radiative
+transfer equation as the expectation of random variables using the Monte
+Carlo method.
-star-phor is capable of handling complex photoreactive scenes, and its
-computation time is independent of the geometrical complexity used to describe
-them.
+**star-phor** is capable of handling complex photoreactive
+configurations, and its computation time is independent of the
+geometrical complexity and scale ratios used to describe them.
## Requirements
- POSIX make
- C compiler (c99)
- pkg-config
-- rsys
+- [RSys](https://meso-star.com/git/rsys/log.html)
- star-phor-input
-- star-3d
-- star-sp
-- star-uniq
-- star-sf
+- [star-3d](https://meso-star.com/git/star-3d/log.html)
+- [star-sf](https://meso-star.com/git/star-sf/log.html)
+- [star-sp](https://meso-star.com/git/star-sp/log.html)
+- [star-uniq](https://meso-star.com/git/star-uniq/log.html)
## Installation
diff --git a/doc/star-phor-output.scd b/doc/star-phor-output.scd
@@ -34,10 +34,10 @@ The output of the *star-phor*(1) program consists of a list of observable
estimators. Each estimator is described on a separate line.
*star-phor* outputs are closely related to the *star-phor-input*(5) file that
-generated the simulation. For each sensor defined in the input file, star-phor
-writes a set of output values at different levels: per-volume sensor mean
-volumetric rate of energy absorption (MVREA); per radiative property MVREA
-within each specified volume; and per-sensor surface LOSSES.
+has generated the simulation. For each sensor defined in the input file,
+star-phor writes a set of output values at different levels: per-volume sensor
+mean volumetric rate of energy absorption (MVREA); per component MVREA within
+each specified volume; and per-sensor surface LOSSES.
In addition, the total estimate of each observable (MVREA or LOSSES), combining
all sensors of a given type, is also provided.
diff --git a/doc/star-phor.scd b/doc/star-phor.scd
@@ -26,15 +26,17 @@ star-phor(1) "UNIX"
# NAME
-*star-phor* - statistical solver for radiative transfer in photoreactors
+*star-phor* - statistical solver for the RTE in photoreactors
# SYNOPSIS
*star-phor* [*-fhv*] [*-n* _samples_] [*-o* _output_] [*-t* _threads_] [_file_]
# DESCRIPTION
-*star-phor* solves the radiative transfer equation in a photoreactive scene
-defined using the _star-phor-input_(5) configuration file specification.
+*star-phor* solves the radiative transfer equation (RTE) in a photoreactive
+configuration defined using the _star-phor-input_(5) configuration file
+specification. If the _file_ is not defined, the configuration is readen from
+the standard input.
Currently, *star-phor* is capable of evaluating the mean volumetric rate of
energy absorption (MVREA), as well as the total energy absorbed by a given
surface, provided that the corresponding volume or surface is defined as a
@@ -78,12 +80,12 @@ The *star-phor* utility exits 0 on success, and >0 if an error occurs.
# EXAMPLES
-Simulate radiative transfer for the system described in the _photoractor.txt_
+Simulate radiative transfer for the system described in the _photoreactor.txt_
file, according to the *star-phor-input*(5) grammar.
Make the program as detailed as possible (options *-vvv*) and use as many threads
as there are cores available on the system (default behavior).
Use 100,000 Monte Carlo realisations to estimate the sensor measurements as
-listed in the _potoreactor.txt_ input file (option *-n*).
+listed in the _photoreactor.txt_ input file (option *-n*).
Finally, write the estimated values to the _result.txt_ file, unless this file
already exists.
In this case, *star-phor* will stop without performing the calculation and
@@ -93,7 +95,7 @@ To force the file to be rewritten, the user should explicitly define the *-f*
option.
```
-star-phor -vvv -n 100000 -o result.txt potoreactor.sphin
+star-phor -vvv -n 100000 -o result.txt photoreactor.txt
```
# SEE ALSO
