commit d65b622baa9aaa10a9cdb1afe5a3df9409dba3f5
parent b8bf49046787e791bf2f94b7b01f0fd83b2573d5
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Fri, 20 Apr 2018 11:46:50 +0200
Update the solstice-output doc of the receiver map
Diffstat:
1 file changed, 22 insertions(+), 24 deletions(-)
diff --git a/doc/solstice-output.5.txt b/doc/solstice-output.5.txt
@@ -176,7 +176,6 @@ _______
<abs-mat-loss> ::= <estimate>
<abs-atm-loss> ::= <estimate>
<cos-factor> ::= <estimate>
-<incoming-flux> ::= <estimate>
<missing-loss> ::= <estimate>
<materials-loss> ::= <estimate>
<atmospheric-loss> ::= <estimate>
@@ -336,28 +335,27 @@ Receiver map
~~~~~~~~~~~~
A receiver defined in the submitted *solstice-receiver*(5) file, can have a
-per-primitive incoming-flux estimate 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. The "definition" of the
+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 incoming-flux, 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.
+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.
+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.
[verse]
_______
@@ -387,8 +385,8 @@ VTK-RECEIVER-MAP ::= # vtk DataFile Version 2.0
<map-side-data> ::= SCALARS <side-and-flux-names> float 2
LOOKUP_TABLE default
- <incoming-flux>
- [ <incoming-flux> ... ]
+ <estimate>
+ [ <estimate> ... ]
<side-and-flux-names> ::= Front_faces_Incoming_flux
| Front_faces_Absorbed_flux
@@ -457,11 +455,11 @@ with respect to its type: the path is yellow if its first segment, i.e.
the ray starting from the sun towards a primary geometry, is occluded by a non
virtual object. If not occluded, the path can be blue or turquoise whether it
reaches a receiver or not, respectively. Finally, the path can also be red if
-it was canceled due to a topologically incoherent impact (i.e. an impact on
-a surface not at the boundary of the medium in which the rays was propagating).
-The following grammar describes the formatting of a
-*VTK-RADIATIVE-PATHS* file. Refer to the VTK format specification [2] for more
-informations on the VTK file format.
+it was canceled due to a topologically incoherent impact (i.e. an impact on a
+surface not at the boundary of the medium in which the rays was propagating).
+The following grammar describes the formatting of a *VTK-RADIATIVE-PATHS*
+file. Refer to the VTK format specification [2] for more informations on the
+VTK file format.
[verse]
_______
