aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
Diffstat (limited to 'Docs/source/running_cpp')
-rw-r--r--Docs/source/running_cpp/parameters.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
index 818972b9c..13f68b513 100644
--- a/Docs/source/running_cpp/parameters.rst
+++ b/Docs/source/running_cpp/parameters.rst
@@ -1833,6 +1833,26 @@ Reduced Diagnostics
using the histogram reduced diagnostics
are given in ``Examples/Tests/initial_distribution/``.
+ * ``ParticleExtrema``
+ This type computes the minimum and maxmium values of
+ particle position, momentum, gamma, weight,
+ and the :math:`\chi` parameter for QED species.
+
+ ``<reduced_diags_name>.species`` must be provided,
+ such that the diagnostics are done for this species only.
+
+ The output columns are
+ minimum and maximum position :math:`x`, :math:`y`, :math:`z`;
+ minimum and maximum momentum :math:`p_x`, :math:`p_y`, :math:`p_z`;
+ minimum and maximum gamma :math:`\gamma`;
+ minimum and maximum weight :math:`w`;
+ minimum and maximum :math:`\chi`.
+
+ Note that when the QED parameter :math:`\chi` is computed,
+ field gather is carried out at every output,
+ so the time of the diagnostic may be long
+ depending on the simulation size.
+
* ``<reduced_diags_name>.frequency`` (`string`) optional (default ``1``)
Using the `Intervals Parser`_ syntax, this string defines the timesteps at which reduced
diagnostics are written to file.