commit c051aefa80b722bd76dbb957fb4f9c2745588141
parent abf2490b5dc5e5c91f9583eb7ce22a40d84928fd
Author: Thomas Vourc'h <thomas.vourc-h@sigma-clermont.fr>
Date: Mon, 9 Feb 2026 12:11:58 +0100
Modification of the man of star-phor-input, sphin and sphin-lit.
In particular, examples in star-phor-input have been detailed to make more
explicit the physical configuration, to make easier the association between the
model configuration and the star-phor-input format.
Diffstat:
3 files changed, 23 insertions(+), 14 deletions(-)
diff --git a/doc/sphin-lint.1.scd b/doc/sphin-lint.1.scd
@@ -48,13 +48,13 @@ The options are as follows:
# EXAMPLES
-Load a photoreactive system description from a local file:
+Load and check a photoreactive system description from a local file:
```
sphin-lint photoreactive_description_file.txt
```
-Load a photoreactive system description from the standard input:
+Load and check photoreactive system description from the standard input:
```
cat photoreactive_description_file.txt | sphin-lint
diff --git a/doc/sphin.3.scd b/doc/sphin.3.scd
@@ -47,7 +47,7 @@ method.
In other words, the library is designed to be independent of a solver but
nevertheless aims to provide all the data (geometric and physical) necessary for
a numerical simulation.
-The data is said to be unstructured with regard to a resolution method.
+The data is thus said to be unstructured with regard to a resolution method.
A deterministic solver would therefore be responsible for meshing the
integration domains, while a statistical solver would have to build structures
capable of accelerating random access to the system data.
diff --git a/doc/star-phor-input.5.scd b/doc/star-phor-input.5.scd
@@ -50,10 +50,11 @@ Properties are specified either as a single-line entry or as a multi-line block,
where each line corresponds to a distinct property.
Single-line properties are declared using the "keyword: value" syntax. No
-additional content other than comments is allowed after the value. Both the key
-and the value must appear on the same line. The colon (:) character is reserved
-as a separator in the input file and therefore cannot be used in the names of
-volumes, surfaces, or prop_rad elements.
+additional content other than comments is allowed after the value. Note that the
+value can refer to a file. Both the key and the value must appear on the same
+line. The colon (:) character is reserved as a separator in the input file and
+therefore cannot be used in the names of volumes, surfaces, or prop_rad
+elements.
The star-phor-input format does not enforce a specific order for property
declarations. However, when encountering a keyword that does not belong to the
@@ -202,15 +203,21 @@ The syntax rules enabling the description of a photoreactor are as follows:
# EXAMPLES
1. The example below describes a simple photoreactive system composed of a cube,
-in which only absorption takes place. Cube walls have diffuse reflectivity. A
-LED panel emits light with a defined flux density, and a surface base reflects
-light with specular reflectivity.
+in which only absorption takes place. Absorption is due to the specie "chemical
+1", with a concentration of 1 mol/m^3, and whose absorption cross section is
+provided in the file "sigma_a.txt" in m^2/mol for wavelengths in nm. Cube walls
+have a reflectivity of 10%, with a diffuse (Lambertian) distribution. A LED
+panel emits light with a defined flux density (total flux 200e-6 mol/m^2/s),
+with a spectrum defined in "spectrum.txt". Emission directions follow a
+Lambertian distribution. The surface base reflects light with specular
+reflectivity of 0.9. Here, the volume of the cube is defined as a sensor, with a
+unit response function, enabling for instance to compute the number of photons
+absorbed within the cube per second.
```
# Keyword name
-volume: "reaction volume"
- geometry: FRONT cube.stl
- prop_rad: "chemical 1" SCATTERER
+volume: "reaction volume" geometry: FRONT cube.stl prop_rad: "chemical 1"
+SCATTERER
concentration: 1 mol/m^3
cross_sections:
abs_cross_sec: sigma_a.txt nm m^2/mol
@@ -241,7 +248,9 @@ surface: "reflecting base"
```
2. The example below describes a volume and a surface source composed by several
-.stl files each.
+.stl files each. In the following example, the top and the bottom surface of the
+cube are light sources. The volume of the cube is defined as the union of these
+two surfaces with the side walls.
```
# Keyword name
