Merge branch '42-documentation-for-geometry-acting-as-particle-termination' into 'master'

Resolve "Documentation for Geometry acting as particle termination"

Closes #42

See merge request OPAL/documentation/manual!61

control.asciidoc

@@ -216,8 +216,8 @@ ENABLEHDF5::
   If true (default), HDF5 read and write is enabled.
 ASCIIDUMP::
   If true, instead of HDF5, ASCII output is generated for the following
-  elements: Probe, Collimator, Monitor, Stripper and global
-  losses.
+  elements: Probe, Collimator, Monitor, Stripper, Geometry,
+  Beam stripping losses and global losses.
 BOUNDPDESTROYFQ::
   The frequency to do `boundp_destroy` to delete lost particles. Default
   10

elements.asciidoc

@@ -1464,6 +1464,11 @@ BSCALE:
   Scale factor for the magnetic field map.
 SYMMETRY::
   Defines symmetrical fold number of the B field map data.
+GEOMETRY::
+  Defines the boundary geometry in order to use it for
+  particle termination (see Chapter link:geometry#chp.geometry[Geometry]).
+  The particles hitting on the `GEOMETRY` will be deleted, and they are recorded in the
+  HDF5 file _<GEOM>.h5_ (or ASCII if link:control#sec.control.option[`ASCIIDUMP`] is true).
 FMLOWE::
   Minimal energy [GeV] the fieldmap can accept. Used in `GAUSSMATCHED` distribution.
 FMHIGHE::

geometry.asciidoc

@@ -13,9 +13,10 @@ endif::[]
 == Geometry
 
 At present the `GEOMETRY` command is still an *experimental feature*
-which is not to be used by the general user. It can only be used to
-specify boundaries for the `SAAMG` Solver. The command can be used in two
-modes:
+which is not to be used by the general user. It can be used to act as
+a terminator for particles that cross the geometry surface and to specify
+boundaries conditions for the `SAAMG` field solver. The command can be
+used in two modes:
 
 1.  specify a H5hut file holding the surface mesh of a complicated
 boundary geometry
@@ -68,5 +69,11 @@ Name: GEOMETRY, TOPO=ELLIPTIC, LENGTH=1.0, A=0.005, B=0.005;
 ----
 
 The geometry element must later be passed to the link:fieldsolvers#sec.fieldsolvers.fieldsolvercmd[fieldsolver command].
+If only particle termination is desired, any solver can be used and
+it is not necessary to specify the geometry in the field solver command.
+
+In the link:track#sec.track.particles[`RUN` command] the boundary geometry has
+always to be specified in order to load it and use it for particle termination.
+
 
 // EOF
\ No newline at end of file

track.asciidoc

@@ -186,18 +186,18 @@ METHOD::
   be used. For the time being the following methods are known:
 +
   * `PARALLEL-T`
-    This method puts _OPAL_ in _OPAL-t_ mode see Chapter link:opalt#chp.opalt[_OPAL-t_].
+    This method puts _OPAL_ in _OPAL-t_ mode (see Chapter link:opalt#chp.opalt[_OPAL-t_]).
   * `CYCLOTRON-T`
-    This method puts _OPAL_ in _OPAL-cycl_ mode see Chapter link:opalcycl#chp.opalcycl[_OPAL-cycl_].
+    This method puts _OPAL_ in _OPAL-cycl_ mode (see Chapter link:opalcycl#chp.opalcycl[_OPAL-cycl_]).
   * `STATISTICAL-ERRORS`
     This is a method to let _OPAL_ run multiple times in parallel while
     adding imperfections to alignment and other physical quantities.
 FIELDSOLVER::
-  The field solver to be used see Chapter link:fieldsolvers#chp.fieldsolvers[Field Solver].
+  The field solver to be used (see Chapter link:fieldsolvers#chp.fieldsolvers[Field Solver]).
 DISTRIBUTION::
-  The particle distribution to be used see Chapter link:distribution#chp.distribution[Distribution].
+  The particle distribution to be used (see Chapter link:distribution#chp.distribution[Distribution]).
 BEAM::
-  The particle beam see Chapter link:beam-command#chp.beam-command[Beam Command] to be used is specified.
+  The particle beam (see Chapter link:beam-command#chp.beam-command[Beam Command]) to be used is specified.
 TURNS::
   The number of turns (integer) to be tracked (default: 1, namely single
   bunch).
@@ -235,6 +235,11 @@ MB_ETA::
   The scale parameter for binning in multi-bunch mode (default: 0.01). Only
   used in `MB_BINNING=GAMMA`. Only available in _OPAL-cycl_.
 +
+BOUNDARYGEOMETRY::
+  The boundary geometry specification is used for
+  particle termination (see Chapter link:geometry#chp.geometry[Geometry]).
+
++
 TRACKBACK::
   The particles are tracked backward in time if `TRUE`.
   Only available in _OPAL-t_. Default is `FALSE`.