aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
authorGravatar MaxThevenet <mthevenet@lbl.gov> 2019-08-14 11:23:42 -0700
committerGravatar MaxThevenet <mthevenet@lbl.gov> 2019-08-14 11:23:42 -0700
commit64f3cc66744a913cdba77d915d30b146ff889441 (patch)
treed48afe06aee3912aa80078fd876c1495b4fb6708 /Docs/source/running_cpp
parent18275dffc9155cb68b4eaf0b60afeb4e2e1cf499 (diff)
downloadWarpX-64f3cc66744a913cdba77d915d30b146ff889441.tar.gz
WarpX-64f3cc66744a913cdba77d915d30b146ff889441.tar.zst
WarpX-64f3cc66744a913cdba77d915d30b146ff889441.zip
add doc
Diffstat (limited to 'Docs/source/running_cpp')
-rw-r--r--Docs/source/running_cpp/parameters.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
index 790956474..733d90d32 100644
--- a/Docs/source/running_cpp/parameters.rst
+++ b/Docs/source/running_cpp/parameters.rst
@@ -703,6 +703,11 @@ Diagnostics and output
The time interval inbetween the lab-frame snapshots (where this
time interval is expressed in the laboratory frame).
+* ``warpx.dz_snapshots_lab`` (`float`, in meters)
+ Only used when ``warpx.do_boosted_frame_diagnostic`` is ``1``.
+ Distance between the lab-frame snapshots (expressed in the laboratory
+ frame). Either `dt_snapshots_lab` or `dz_snapshot_lab` is required.
+
* ``warpx.do_boosted_frame_fields`` (`0 or 1`)
Whether to use the **back-transformed diagnostics** for the fields.