diff options
Diffstat (limited to 'Docs/source/usage')
| -rw-r--r-- | Docs/source/usage/parameters.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/Docs/source/usage/parameters.rst b/Docs/source/usage/parameters.rst index 84990e698..5fae9c383 100644 --- a/Docs/source/usage/parameters.rst +++ b/Docs/source/usage/parameters.rst @@ -57,6 +57,15 @@ Overall simulation parameters printed to standard output. Currently only works if the Lorentz boost and the moving window are along the z direction. +* ``warpx.compute_max_step_from_btd`` (`integer`; 0 by default) optional + Can be useful when computing back-transformed diagnostics. If specified, + automatically calculates the number of iterations required in the boosted + frame for all back-transformed diagnostics to be completed. If ``max_step``, + ``stop_time``, or ``warpx.zmax_plasma_to_compute_max_step`` are not specified, + or the current values of ``max_step`` and/or ``stop_time`` are too low to fill + all BTD snapshots, the values of ``max_step`` and/or ``stop_time`` are + overwritten with the new values and printed to standard output. + * ``warpx.random_seed`` (`string` or `int` > 0) optional If provided ``warpx.random_seed = random``, the random seed will be determined using `std::random_device` and `std::clock()`, |