Changes between Version 191 and Version 192 of doc/app/particle_parameters

Timestamp:

May 18, 2022 8:33:59 AM (2 years ago)

Author:

raasch

Comment:

--

doc/app/particle_parameters

@@ -685 +685 @@
 |----------------
 {{{#!td style="vertical-align:top"
-[=#pts_id_file '''pts_id_file''']
-}}}
-{{{#!td style="vertical-align:top"
-C*64
-}}}
-{{{#!td style="vertical-align:top"
-
-}}}
-{{{#!td
-
-}}}
-|----------------
-{{{#!td style="vertical-align:top"
 [=#pts_increment '''pts_increment''']
 }}}
@@ -704 +691 @@
 }}}
 {{{#!td style="vertical-align:top"
-1
-}}}
-{{{#!td
-
+0
+}}}
+{{{#!td
+Parameter for steering the amount of output of time series data of individual particles.
+
+By default, output of time series data of individual particles is switched off. Setting '''pts_increment''' = ''1'', time series data for each particle will be written, for '''pts_increment''' = ''2'' every second particle will be written, etc.. Be aware that low values of '''pts_increment''' may create huge output and may slow down the model performance significally.
+
+Instead of giving an increment, the number of particles to be scheduled for output can be chosen as a percentage of the total number of simulated particles (see [#pts_percentag pts_percentage]).
+
+It is not allowed to set both '''pts_increment''' and [#pts_percentage pts_percentage] at the same time.
 }}}
 |----------------
@@ -717 +710 @@
 }}}
 {{{#!td style="vertical-align:top"
-100.0
-}}}
-{{{#!td
-
+0.0
+}}}
+{{{#!td
+Parameter for steering the amount of output of time series data of individual particles.
+
+By default, output of time series data of individual particles is switched off. Setting '''pts_percentage''' = ''100'', time series data for each particle will be written, for '''pts_percentage''' = ''50'' only half of all particles will be written, etc.. Be aware that high values of '''pts_percentage''' may create huge output and may slow down the model performance significally.
+
+Instead of giving a percentage, the number of particles to be scheduled for output can be chosen via an increment (see [#pts_increment pts_increment]).
+
+It is not allowed to set both '''pts_percentage''' and [#pts_increment pts_increment] at the same time.
 }}}
 |----------------