commit 71652469aeaed31962a3e725fb73eac3273d1bd2
parent 3c7b963441c4742e89a61202fcfcc955565d62f3
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 10 May 2017 22:30:38 +0200
Document the primary parameter in the solstice-input man
Diffstat:
1 file changed, 13 insertions(+), 6 deletions(-)
diff --git a/doc/solstice-input.5.ronn b/doc/solstice-input.5.ronn
@@ -537,12 +537,19 @@ its ancestors with its own name. This naming convention is used in the
- name: level2
An entity encapsulates either a `geometry` or a `pivot`. The former is a
-collection of `objects`, i.e. `shapes` with their associated `material`. The
-latter is used to control the dynamic positioning of the child entities with
-respect to some constraints defined by the pivot type, and the sun directions
-submitted by `solstice`(1). Each entity can also have a list of `anchors`. An
-anchor is used to define a position relative to the entity into which it is
-declared.
+collection of `objects` i.e. `shapes` with their associated `material` and an
+optional `transformation`. The latter is used to control the dynamic
+positioning of the child entities with respect to some constraints defined by
+the pivot type, and the sun directions submitted by `solstice`(1). Each entity
+can also have a list of `anchors`. An anchor is used to define a position
+relative to the entity into which it is declared.
+
+For geometric entity one have to define if the encapsulated geometry is
+`primary`, i.e. it is directly lit by the sun and it is used to concentrate the
+solar flux as, for instance, a primary mirror. One can define all the solar
+plant geometric entity as primary but a well designed solar plant where only
+primary mirrors are tagged as primary will drastically reduce the convergence
+speed of the `solstice`(1) simulations.
### Template
