diff options
| author |  NeilZaim <49716072+NeilZaim@users.noreply.github.com>
| 2020-09-25 10:27:28 +0200 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2020-09-25 10:27:28 +0200 |
| commit | fc898a05abd9fc2cba6f087e865415379174bab9 (patch) | |
| tree | db6dd209d3a10a894badfd657bca64b62e10d4d2 /Docs/source/running_cpp | |
| parent | 6f0fbb9a685717070ffbf363d96a81343890526c (diff) | |
| download | WarpX-fc898a05abd9fc2cba6f087e865415379174bab9.tar.gz WarpX-fc898a05abd9fc2cba6f087e865415379174bab9.tar.zst WarpX-fc898a05abd9fc2cba6f087e865415379174bab9.zip | |
Add CI test and documentation for leveling thinning algorithm (#1327)
* First working version of tests
* Add comments to test
* Add test in WarpX-test.ini and initial checksum json file
* Add resampling to input parameters doc
* Uncomment lines about checksum in analysis script + Fix minor typos
* Add momentum in plotfiles (for checksum) + Fix minor typoes
* Remove particle_theta from checksum json file
* Remove rho from checksum json file
* Fix syntax error in checksum json file
* Add benchmark values
* Update Docs/source/running_cpp/parameters.rst
Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>
* Have one Resampling object per species
Co-authored-by: Axel Huebl <axel.huebl@plasma.ninja>
Diffstat (limited to 'Docs/source/running_cpp')
| -rw-r--r-- | Docs/source/running_cpp/parameters.rst | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst index 05e9808eb..e646d2b6b 100644 --- a/Docs/source/running_cpp/parameters.rst +++ b/Docs/source/running_cpp/parameters.rst @@ -594,6 +594,31 @@ Particle initialization (the name of an existing positron species must be provided). **This feature requires to compile with QED=TRUE** +* ``<species>.do_resampling`` (`0` or `1`) optional (default `0`) + If `1` resampling is performed for this species. This means that the number of macroparticles + will be reduced at specific timesteps while preserving the distribution function as much as + possible (in particular the weight of the remaining particles will be increased on average). + This can be useful in situations with continuous creation of particles (e.g. with ionization + or with QED effects). At least one resampling trigger (see below) must be specified to actually + perform resampling. + +* ``<species>.resampling_algorithm`` (`string`) optional (default `leveling_thinning`) + The algorithm used for resampling. Currently there is only one option, which is already set by + default: + + * ``leveling_thinning`` This algorithm is defined in `Muraviev et al., arXiv:2006.08593 (2020) <https://arxiv.org/abs/2006.08593>`_. + The main parameter for this algorithm can be set with ``<species>.resampling_algorithm_target_ratio``. + It **roughly** corresponds to the ratio between the number of particles before and after + resampling. The default value for this parameter is 1.5. + +* ``<species>.resampling_trigger_intervals`` (`string`) optional (default `0`) + Using the `Intervals parser`_ syntax, this string defines timesteps at which resampling is + performed. + +* ``<species>.resampling_trigger_max_avg_ppc`` (`float`) optional (default `infinity`) + Resampling is performed everytime the number of macroparticles per cell of the species + averaged over the whole simulation domain exceeds this parameter. + .. _running-cpp-parameters-laser: Laser initialization |