commit e722187ad0ab797d322d81149392dae2f0a03e70
parent 9c5537a0345fb566521beee68af433e7da7473fe
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Fri, 12 Jan 2018 11:49:25 +0100
Add information to documentation on sun direction.
Diffstat:
2 files changed, 22 insertions(+), 9 deletions(-)
diff --git a/doc/solstice-output.5.txt b/doc/solstice-output.5.txt
@@ -78,7 +78,7 @@ _______
-------------------------------------
-<sun-direction> ::= "#--- Sun direction: <azimuth> <elevation> (<real3>)"
+<sun-direction> ::= "#--- Sun direction: <alpha> <beta> (<sun-vector>)"
<counts> ::= "<#globals> <#receivers> <#primaries>
<#samples> <#failed>"
@@ -161,8 +161,9 @@ _______
<real3> ::= REAL REAL REAL
-<azimuth> ::= REAL # Degrees in [0, 360[
-<elevation> ::= REAL # Degrees in [0, 90]
+<alpha> ::= REAL # Degrees in [0, 360[
+<beta> ::= REAL # Degrees in [0, 90]
+<sun-vector> ::= <real3>
<incoming-flux> ::= <estimate>
<in-if-no-mat-loss> ::= <estimate>
@@ -193,8 +194,9 @@ SIMULATION
----------
A *simulation-output* begins with two header lines. The first one reports the
-sun direction used in the simulation (azimuth and elevation angles, in
-degrees), and the second one lists the numbers of global, per receiver and per
+sun direction used in the simulation (two angles in degrees, plus the
+corresponding sun vector),
+and the second one lists the numbers of global, per receiver and per
primary results as well as the overall number of Monte-Carlo experiments used
by the simulation and the number of experiments that failed due to unforeseen
errors as numerical imprecisions. As soon as the number of failed experiments
diff --git a/doc/solstice.1.txt.in b/doc/solstice.1.txt.in
@@ -66,13 +66,24 @@ is used to render an image of the submitted solar facility. Note that these
three options are mutually exclusives, and once defined, they replace the
default *solstice* behaviour.
+Please note that any coordinate-related question in Solstice must be
+considered with the right-handed convention in mind.
+
OPTIONS
-------
-*-D* <__azimuth__,__elevation__[:...]>::
- List of sun directions. A direction is defined by its _azimuthal_ and
- _elevation_ angles in degrees, with _azimuth_ in [0, 360[ and _elevation_ in
- [0, 90]. Each sun direction triggers a new computation whose results are
+*-D* <__alpha__,__beta__[:...]>::
+ List of sun directions. A direction is defined by two angles in degrees. The
+ first one, here refered to as _alpha_, is an azimuthal angle in [0, 360[ and
+ the second one, here refered to as _beta_, is an elevation in [0, 90].
+ Each provided sun direction triggers a new computation whose results are
concatenated to the _output_ file.
++
+Following the right-handed convention, Solstice azimuthal rotation is
+counter-clockwise, with 0° on the X axis. Solstice elevation starts from 0° for
+directions in the XY plane, up to 90° at zenith. Thus -D0,0 -D0,90 -D0,180 and
+-D0,270 will produce solar vectors {-1,0,0} {0,-1,0} {+1,0,0} and {0,+1,0}
+respectively, while -D__alpha__,90 will produce {0,0,-1} regardless of _alpha_
+value.
*-f*::
Force overwrite of the _output_ file.
