commit 650dee22729faaba606f71deedd1cdec24cdb3b8
parent 85c79ef8fa7af34d24066933566921453cc5ca42
Author: Jeremi Dauchet <jeremi.dauchet@sigma-clermont.fr>
Date: Fri, 13 Feb 2026 15:22:24 +0100
ASCII art in star-phor-input man page examples
First draft during a 5 min break.
Diffstat:
1 file changed, 52 insertions(+), 20 deletions(-)
diff --git a/doc/star-phor-input.5.scd b/doc/star-phor-input.5.scd
@@ -206,20 +206,36 @@ 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. The volume and surface are
-composed by several .stl files each. In the following example, the top
-and the bottom surface of the cube are light sources, which emit 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 volume of the cube is defined as the union
-of these two surfaces with the side walls. 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. Here, the volume of the cube is defined
-as a sensor, with a unit response function, enabling for instance to
+1. The example below describes a simple photoreactive system composed of a cube,
+in which only absorption takes place. The volume and surface are composed by
+several .stl files each. In the following example, the top and the bottom
+surface of the cube are light sources, which emit 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
+volume of the cube is defined as the union of these two surfaces with the side
+walls. 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. 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.
+ +-------------------+
+ /| /|
+ / | source / |
+ / | /|\ / |
+ / | v v v / |
+ / | / |
++-------------------+ |
+| | | |
+| | | |
+| +-------------|-----+
+| / | /
+| / ^ ^ ^ | /
+| / \|/ | /
+| / source | /
+|/ |/
++-------------------+
+
```
volume: "reaction volume"
geometry: FRONT cube_top.stl
@@ -241,14 +257,30 @@ surface: "light sources"
direction: LAMBERT
```
-2. 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.
+2. 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.
+
+ + +-------------------+
+ /| /| /|
+ / | / | / |
+ / | / | / |
+ / | / | / |
+ / | / | / |
++ | +-------------------+ |
+| LED | | | | |
+| | | | | |
+| + | +-------------|-----+
+| / | / | /
+| / | / | /
+| / | / | /
+| / | / | /
+|/ |/ |/
++ +-------------------+
```
volume: "reaction volume"
