commit b213b9a0bdd9bcf8dbc0ebad6fb11c68859d2b28
parent e11cae23aad1c9e9d4bdc4607b840d54203eabc6
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 20 Apr 2018 12:21:17 +0200
Update the doc on the per-triangle estimates
Diffstat:
2 files changed, 25 insertions(+), 24 deletions(-)
diff --git a/doc/solstice-output.5.txt b/doc/solstice-output.5.txt
@@ -335,27 +335,28 @@ Receiver map
~~~~~~~~~~~~
A receiver defined in the submitted *solstice-receiver*(5) file, can have a
-per-primitive estimate of its incoming flux and/or absorbed flux if its
-*per_primitive* flag is active. In this case, *solstice*(1) generates a
-*receiver-map* that is actually an ASCII VTK file [2] that stores the
-triangular mesh of the receiver and, for each triangle, the estimate of its
-associated incoming flux and/or absorbed flux. The "definition" of the
-receiver map is thus controlled by the discretisation of the receiver's shape,
-as described in the *solstice-input*(5) file. Note that to obtain a good
-estimate of the per-triangle fluxes, one have to ensure that the number of
-per-triangle experiments is sufficient regarding the targeted accuracy. Since
-only a small fraction of the overall sampled radiative paths reach a given
-triangle, the total number of experiments required through the *-n* option of
-*solstice*(1) should be increased significantly, as 1 or 2 order of magnitude.
-
-The number of written per-triangle flux estimates depends on the receiver's
-parameters: both front and back sides of the receiver can be active and each
-side can produce an estimate both for the incoming flux and for the absorbed
-flux. As a consequence, the output can include up to 4 different estimates
-that are written in the order: incoming front, absorbed front, incoming back,
-absorbed back. The following grammar gives a brief description of the
-formatting of a *VTK-RECEIVER-MAP*. Please refer to the VTK format
-specification [2] for more informations on the VTK file format.
+per-primitive estimate of its incoming flux density and/or absorbed flux
+density if its *per_primitive* flag is active. In this case, *solstice*(1)
+generates a *receiver-map* that is actually an ASCII VTK file [2] that stores
+the triangular mesh of the receiver and, for each triangle, the estimate of
+its associated incoming flux density and/or absorbed flux density. The
+"definition" of the receiver map is thus controlled by the discretisation of
+the receiver's shape, as described in the *solstice-input*(5) file. Note that
+to obtain a good estimate of the per-triangle flux densities, one have to
+ensure that the number of per-triangle experiments is sufficient regarding the
+targeted accuracy. Since only a small fraction of the overall sampled
+radiative paths reach a given triangle, the total number of experiments
+required through the *-n* option of *solstice*(1) should be increased
+significantly, as 1 or 2 order of magnitude.
+
+The number of written per-triangle flux density estimates depends on the
+receiver's parameters: both front and back sides of the receiver can be active
+and each side can produce an estimate both for the incoming flux density and
+for the absorbed flux density. As a consequence, the output can include up to
+4 different estimates that are written in the order: incoming front, absorbed
+front, incoming back, absorbed back. The following grammar gives a brief
+description of the formatting of a *VTK-RECEIVER-MAP*. Please refer to the VTK
+format specification [2] for more informations on the VTK file format.
[verse]
_______
diff --git a/doc/solstice-receiver.5.txt b/doc/solstice-receiver.5.txt
@@ -51,8 +51,8 @@ back facing. Finally, if the optional *per_primitive* flag is set,
*solstice*(1) will estimate the irradiance for each triangle of the receiver
and use these data to generate a receiver map as described in
*solstice-output*(5). The *per-primitive* flag can be set to *INCOMING*,
-*ABSORBED* or *INCOMING_AND_ABSORBED* to produce the incoming flux map, the
-absorbed flux map, or both.
+*ABSORBED* or *INCOMING_AND_ABSORBED* to produce the incoming flux density
+map, the absorbed flux density map, or both.
GRAMMAR
-------
@@ -64,7 +64,7 @@ _______
<receiver> ::= name: <entity-identifier>
side: <side-identifier>
- [ per_primitive: <per-primitive-mode> ]
+ [ per_primitive: <per-primitive-mode> ] # Default: NONE
<side-identifier> ::= FRONT
| BACK
