solstice

commit 989c06f43dd68d9e9f533424c5f72f79f377bdf0
parent f97ee6a416365eee0cef694f6851487bb0d71a83
Author: Vincent Forest <vincent.forest@meso-star.com>
Date:   Wed, 27 Sep 2017 14:32:42 +0200

Ensure that the text width of the "output" doc is 80 columns

This is actually useful for grammar rules that are formatted as it is
and that, without this constraint, can exceed the width of the output
man page.

Diffstat:
M
doc/solstice-output.5.txt
 | 
51
++++++++++++++++++++++++++-------------------------

1 file changed, 26 insertions(+), 25 deletions(-)
diff --git a/doc/solstice-output.5.txt b/doc/solstice-output.5.txt
@@ -112,10 +112,10 @@ _______
 <front>               ::= <side>
 <back>                ::= <side>
 
-<side>                ::= "<incoming-flux> <in-if-no-mat-loss> <in-if-no-atm-loss>
-                           <in-mat-loss> <in-atm-loss>
-                           <absorbed-flux> <abs-if-no-mat-loss> <abs-if-no-atm-loss>
-                           <abs-mat-loss> <abs-atm-loss>
+<side>                ::= "<incoming-flux> <in-if-no-mat-loss>
+                           <in-if-no-atm-loss> <in-mat-loss> <in-atm-loss>
+                           <absorbed-flux> <abs-if-no-mat-loss>
+                           <abs-if-no-atm-loss> <abs-mat-loss> <abs-atm-loss>
                            <efficiency>"
 
 -------------------------------------
@@ -141,10 +141,10 @@ _______
 <rcvXprim-front>      ::= <rcvXprim-side>
 <rcvXprim-back>       ::= <rcvXprim-side>
 
-<rcvXprim-side>       ::= "<incoming-flux> <in-if-no-mat-loss> <in-if-no-atm-loss>
-                           <in-mat-loss> <in-atm-loss>
-                           <absorbed-flux> <abs-if-no-mat-loss> <abs-if-no-atm-loss>
-                           <abs-mat-loss> <abs-atm-loss>"
+<rcvXprim-side>       ::= "<incoming-flux> <in-if-no-mat-loss>
+                           <in-if-no-atm-loss> <in-mat-loss> <in-atm-loss>
+                           <absorbed-flux> <abs-if-no-mat-loss>
+                           <abs-if-no-atm-loss> <abs-mat-loss> <abs-atm-loss>"
 
 -------------------------------------
 
@@ -212,20 +212,21 @@ the exact number of lines being part of the headers. Currently this number is
 7. Each global result is a pair of real numbers: the expected value and its
 standard error. The global results are, in this order:
 
-- *potential-flux*: maximum flux that all the primary
-  geometries could intercept if properly oriented and flat-shaped;
-- *absorbed-flux*: absorbed part of the flux reaching any
-  receiver geometry. At most equal to the potential flux;
+- *potential-flux*: maximum flux that all the primary geometries could
+  intercept if properly oriented and flat-shaped;
+- *absorbed-flux*: absorbed part of the flux reaching any receiver geometry.
+  At most equal to the potential flux;
 - *cos-factor*: cos of the angle between the sun direction and the normal of
   the primary surfaces (average cos over all primary geometries);
-- *shadow-loss*: potential flux intercepted by another geometry before reaching
-  a primary geometry;
+- *shadow-loss*: potential flux intercepted by another geometry before
+  reaching a primary geometry;
 - *missing-loss*: part of the flux that reaches a primary geometry, follows a
-  radiative path, but is not absorbed; this flux could have bounced on geometries,
-  including receivers, but without being absorbed;
-- *materials-loss*: total flux absorbed by non-receivers along radiative paths;
-  includes both surface and volume absorption;
-- *atmospheric-loss*: total flux extinction by the atmosphere along radiative paths.
+  radiative path, but is not absorbed; this flux could have bounced on
+  geometries, including receivers, but without being absorbed;
+- *materials-loss*: total flux absorbed by non-receivers along radiative
+  paths; includes both surface and volume absorption;
+- *atmospheric-loss*: total flux extinction by the atmosphere along radiative
+  paths.
 
 This results can be used to check conservation of energy:
 
@@ -275,9 +276,9 @@ side are meaningless (invalid -1 value).
 Per primary results
 ~~~~~~~~~~~~~~~~~~~
 
-Following the per-receiver results, the output includes various per-primary result
-lines, one line per primary geometry, the exact number of lines being part of
-the headers. Each line contains:
+Following the per-receiver results, the output includes various per-primary
+result lines, one line per primary geometry, the exact number of lines being
+part of the headers. Each line contains:
 
 - *primary-name*: name of the primary geometry, i.e. *entity-identifier* of
   the entity in in which the primary geometry is  defined (see the
@@ -294,9 +295,9 @@ the headers. Each line contains:
 Per receiver and per primary results
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Following the per-primary results, the output includes various result lines, each
-describing the contribution of a primary geometry to a given receiver. The
-total number of such lines is the number of receivers times the number of
+Following the per-primary results, the output includes various result lines,
+each describing the contribution of a primary geometry to a given receiver.
+The total number of such lines is the number of receivers times the number of
 primary geometries. Each line contains:
 
 - *receiver-id*: identifier of the involved receiver;