diff options
Diffstat (limited to 'Docs/source/usage/parameters.rst')
| -rw-r--r-- | Docs/source/usage/parameters.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/Docs/source/usage/parameters.rst b/Docs/source/usage/parameters.rst index 36c6dc3b2..f87795a77 100644 --- a/Docs/source/usage/parameters.rst +++ b/Docs/source/usage/parameters.rst @@ -2159,6 +2159,18 @@ BackTransformed Diagnostics (with support for Plotfile/openPMD output) * ``<diag_name>.num_snapshots_lab`` (`integer`) Only used when ``<diag_name>.diag_type`` is ``BackTransformed``. The number of lab-frame snapshots that will be written. + Only this option or ``intervals`` should be specified; + a run-time error occurs if the user attempts to set both ``num_snapshots_lab`` and ``intervals``. + +* ``<diag_name>.intervals`` (`string`) + Only used when ``<diag_name>.diag_type`` is ``BackTransformed``. + Using the `Intervals parser`_ syntax, this string defines the lab frame times at which data is dumped, + given as multiples of the step size ``dt_snapshots_lab`` or ``dz_snapshots_lab`` described below. + Example: ``btdiag1.intervals = 10:11,20:24:2`` and ``btdiag1.dt_snapshots_lab = 1.e-12`` + indicate to dump at lab times ``1e-11``, ``1.1e-11``, ``2e-11``, ``2.2e-11``, and ``2.4e-11`` seconds. + Note that the stop interval, the second number in the slice, must always be specified. + Only this option or ``num_snapshots_lab`` should be specified; + a run-time error occurs if the user attempts to set both ``num_snapshots_lab`` and ``intervals``. * ``<diag_name>.dt_snapshots_lab`` (`float`, in seconds) Only used when ``<diag_name>.diag_type`` is ``BackTransformed``. |