diff options
| author |  Ryan Sandberg <RSandberg@lbl.gov>
| 2023-02-22 11:27:31 -0800 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2023-02-22 11:27:31 -0800 |
| commit | e90af8435b64228c4f1d8c83c971a266b668304c (patch) | |
| tree | eeb3a0e8074399e78a54519a8014d9aef66e3263 /Docs/source/usage/parameters.rst | |
| parent | c510ded86e5eef9bdb8a3c952a5e08b4f50c3692 (diff) | |
| download | WarpX-e90af8435b64228c4f1d8c83c971a266b668304c.tar.gz WarpX-e90af8435b64228c4f1d8c83c971a266b668304c.tar.zst WarpX-e90af8435b64228c4f1d8c83c971a266b668304c.zip | |
Add option to increase `max_step` or `stop_time` to fill BTD (#3693)
* add option to increase max_step to fill BTD
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* make sure code compiles locally
* allow for unspecified max step if setting by BTD
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* clarify docs, match default max_step value
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Apply suggestions from code review
shortening flag name
* add example input script, fix bugf
* check stop_time and max_step
* account for stop time
* Fix logic, improve documentation
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
---------
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Diffstat (limited to 'Docs/source/usage/parameters.rst')
| -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()`, |