diff options
| author |  Axel Huebl <axel.huebl@plasma.ninja>
| 2021-11-02 10:46:49 -0700 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2021-11-02 17:46:49 +0000 |
| commit | 3b09e5199b0cd880f9a30d0eb433ca600c2096ec (patch) | |
| tree | 1efe3220abde94380c51f6d65375fd5a8a058d08 /Docs/source/usage/parameters.rst | |
| parent | 6d2d756feb3b3abc4834d8a062e6e601709f1107 (diff) | |
| download | WarpX-3b09e5199b0cd880f9a30d0eb433ca600c2096ec.tar.gz WarpX-3b09e5199b0cd880f9a30d0eb433ca600c2096ec.tar.zst WarpX-3b09e5199b0cd880f9a30d0eb433ca600c2096ec.zip | |
Diagnostics Interval: Non-Optional Input (#2507)
The defaults were `0` (diags) and `1` (reduced diags). These defaults
can lead to user-mistakes (forgetting the parameter) and neither `0`
nor every step `1` are sensible defaults. Thus, require the user to
set this parameter in all cases.
Diffstat (limited to 'Docs/source/usage/parameters.rst')
| -rw-r--r-- | Docs/source/usage/parameters.rst | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/Docs/source/usage/parameters.rst b/Docs/source/usage/parameters.rst index 40639aa37..1fa959795 100644 --- a/Docs/source/usage/parameters.rst +++ b/Docs/source/usage/parameters.rst @@ -1761,10 +1761,9 @@ In-situ capabilities can be used by turning on Sensei or Ascent (provided they a Name of each diagnostics. example: ``diagnostics.diags_names = diag1 my_second_diag``. -* ``<diag_name>.intervals`` (`string` optional, default `0`) +* ``<diag_name>.intervals`` (`string`) Using the `Intervals parser`_ syntax, this string defines the timesteps at which data is dumped. Use a negative number or 0 to disable data dumping. - This is ``0`` (disabled) by default. example: ``diag1.intervals = 10,20:25:1``. Note that by default the last timestep is dumped regardless of this parameter. This can be changed using the parameter ``<diag_name>.dump_last_timestep`` described below. @@ -2325,7 +2324,7 @@ Reduced Diagnostics so the time of the diagnostic may be long depending on the simulation size. -* ``<reduced_diags_name>.intervals`` (`string`) optional (default ``1``) +* ``<reduced_diags_name>.intervals`` (`string`) Using the `Intervals Parser`_ syntax, this string defines the timesteps at which reduced diagnostics are written to file. |