aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
authorGravatar MaxThevenet <mthevenet@lbl.gov> 2019-08-19 09:36:04 -0700
committerGravatar GitHub <noreply@github.com> 2019-08-19 09:36:04 -0700
commitc023286720c7ae8aa2913efc461240a81e8b2bd9 (patch)
tree28f02960c445d979f2de1af5c38e5a5e17c90452 /Docs/source/running_cpp
parentcb961e301035b744de69abc6cd4205fa424ecf3e (diff)
parentada7e94c1d4938c800919a9611b94ee6e8e5584e (diff)
downloadWarpX-c023286720c7ae8aa2913efc461240a81e8b2bd9.tar.gz
WarpX-c023286720c7ae8aa2913efc461240a81e8b2bd9.tar.zst
WarpX-c023286720c7ae8aa2913efc461240a81e8b2bd9.zip
Merge pull request #270 from ECP-WarpX/dz_snapshot
[mini-PR] User can specify time interval OR distance between snapshots
Diffstat (limited to 'Docs/source/running_cpp')
-rw-r--r--Docs/source/running_cpp/parameters.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
index 2bb9b7850..d411cc0a1 100644
--- a/Docs/source/running_cpp/parameters.rst
+++ b/Docs/source/running_cpp/parameters.rst
@@ -703,6 +703,13 @@ 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). ``dt_snapshots_lab`` is then computed by
+ ``dt_snapshots_lab = dz_snapshots_lab/c``. 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.