diff options
Diffstat (limited to 'Docs/source/usage/parameters.rst')
| -rw-r--r-- | Docs/source/usage/parameters.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Docs/source/usage/parameters.rst b/Docs/source/usage/parameters.rst index 4a67eb500..cd76ba1e8 100644 --- a/Docs/source/usage/parameters.rst +++ b/Docs/source/usage/parameters.rst @@ -856,7 +856,9 @@ Particle initialization 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`` function ``get_particle_boundary_buffer()`` can be + function ``get_particle_boundary_buffer``, found in the + ``picmi.Simulation`` class as + ``sim.extension.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 |