diff options
| author |  MaxThevenet <maxence.thevenet@desy.de>
| 2020-09-24 07:43:03 +0200 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2020-09-23 22:43:03 -0700 |
| commit | 8797c599f2c16e33a790300ebb275b7b696df91b (patch) | |
| tree | c882767138dc023aab07d6e5414f00b2c321c685 /Docs/source/running_cpp | |
| parent | 20649677733e0b457def83ff48147facf8268b5c (diff) | |
| download | WarpX-8797c599f2c16e33a790300ebb275b7b696df91b.tar.gz WarpX-8797c599f2c16e33a790300ebb275b7b696df91b.tar.zst WarpX-8797c599f2c16e33a790300ebb275b7b696df91b.zip | |
Option to have absorbing BC for particles, regardless of field BC (#1334)
* option to have absorbing BC for particles, regarless of field BC
* document input parameter particles.absorbing_bc
* minor, just add a small comment
* clarify doc and use better input parameter
* clarify documentation
Diffstat (limited to 'Docs/source/running_cpp')
| -rw-r--r-- | Docs/source/running_cpp/parameters.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst index 7805155ce..05e9808eb 100644 --- a/Docs/source/running_cpp/parameters.rst +++ b/Docs/source/running_cpp/parameters.rst @@ -277,6 +277,11 @@ Particle initialization * ``particles.use_fdtd_nci_corr`` (`0` or `1`) optional (default `0`) Whether to activate the FDTD Numerical Cherenkov Instability corrector. +* ``particles.boundary_conditions`` (`string`) optional (default `none`) + Boundary conditions applied to particles. Options are: + * ``none``: the boundary conditions applied to particles is determined by ``geometry.is_periodic``. + * ``absorbing``: particles exiting the simulation domain are discarded. + * ``particles.rigid_injected_species`` (`strings`, separated by spaces) List of species injected using the rigid injection method. The rigid injection method is useful when injecting a relativistic particle beam, in boosted-frame |