aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
authorGravatar Yinjian Zhao <yinjianzhao@lbl.gov> 2020-12-01 10:57:40 -0700
committerGravatar GitHub <noreply@github.com> 2020-12-01 09:57:40 -0800
commitfad0f17927d494957f21d6f799895cde6a4cefa3 (patch)
treed8b359091b049141798b43324a10fdf2a0687480 /Docs/source/running_cpp
parent68f4dd87d2814058ac34ca08061c7c27f42fda7e (diff)
downloadWarpX-fad0f17927d494957f21d6f799895cde6a4cefa3.tar.gz
WarpX-fad0f17927d494957f21d6f799895cde6a4cefa3.tar.zst
WarpX-fad0f17927d494957f21d6f799895cde6a4cefa3.zip
Adding Particle Extrema Reduced Diagnostics (#1316)
* Update inputs_3d * Add XZ and RZ * Add chi * add units * fix mass * Apply suggestions from code review * fix compute of gamma for photon * can compile * update * add doc Co-authored-by: Luca Fedeli <luca.fedeli.88@gmail.com>
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.