From c1d5de97525433d58ca272ea281d5c6d58d2656a Mon Sep 17 00:00:00 2001 From: RevathiJambunathan Date: Tue, 19 Mar 2024 13:29:34 -0700 Subject: [PATCH] consistent docs --- Docs/source/usage/parameters.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Docs/source/usage/parameters.rst b/Docs/source/usage/parameters.rst index a615c9c8a87..b53546b7856 100644 --- a/Docs/source/usage/parameters.rst +++ b/Docs/source/usage/parameters.rst @@ -407,7 +407,7 @@ Domain Boundary Conditions setting these variables will trigger an electrostatic solve at ``t=0``, to compute the initial electric field produced by the boundaries. -* ``boundary.particle_lo`` and ``boundary.particle_hi`` (`2 strings` for 2D, `3 strings` for 3D, `absorbing` by default) +* ``boundary.particle_lo`` and ``boundary.particle_hi`` (`2 strings` for 2D, `3 strings` for 3D) Options are: * ``Absorbing``: Particles leaving the boundary will be deleted. @@ -680,6 +680,8 @@ Particle initialization * ``particles.species_names`` (`strings`, separated by spaces) The name of each species. This is then used in the rest of the input deck ; in this documentation we use `` as a placeholder. + Note that particle boundary condition must be specified using + ``boundary.particle_lo`` and ``boundary.particle_hi`` * ``particles.photon_species`` (`strings`, separated by spaces) List of species that are photon species, if any.