diff options
Diffstat (limited to 'Docs/source/usage/parameters.rst')
| -rw-r--r-- | Docs/source/usage/parameters.rst | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/Docs/source/usage/parameters.rst b/Docs/source/usage/parameters.rst index b329928f6..8e5bc77de 100644 --- a/Docs/source/usage/parameters.rst +++ b/Docs/source/usage/parameters.rst @@ -759,6 +759,27 @@ Particle initialization If `1` is given, this species will not be pushed by any pusher during the simulation. +* ``<species>.save_particles_at_xlo/ylo/zlo``, ``<species>.save_particles_at_xhi/yhi/zhi`` and ``<species>.save_particles_at_eb`` (`0` or `1` optional, default `0`) + If `1` particles of this species will be copied to the scraped particle + buffer for the specified boundary if they leave the simulation domain in + the specified direction. **If USE_EB=TRUE** the ``save_particles_at_eb`` + flag can be set to `1` to also save particle data for the particles of this + species that impact the embedded boundary. + The scraped particle buffer can be used to track particle fluxes out of the + simulation but is currently only accessible via the Python interface. The + ``pywarpx._libwarpx`` function ``get_particle_boundary_buffer()`` can be + used to access the scraped particle buffer. An entry is included for every + particle in the buffer of the timestep at which the particle was scraped. + This can be accessed by passing the argument ``comp_name="step_scraped"`` to + the above mentioned function. + + .. note:: + Currently the scraped particle buffer relies on the user to access the + data in the buffer for processing and periodically clear the buffer. The + buffer will grow unbounded as particles are scraped and therefore could + lead to memory issues if not periodically cleared. To clear the buffer + call ``warpx_clearParticleBoundaryBuffer()``. + * ``<species>.do_back_transformed_diagnostics`` (`0` or `1` optional, default `1`) Only used when ``warpx.do_back_transformed_diagnostics=1``. When running in a boosted frame, whether or not to plot back-transformed diagnostics for |