Skip to content

Commit

Permalink
consistent docs
Browse files Browse the repository at this point in the history
  • Loading branch information
RevathiJambunathan committed Mar 19, 2024
1 parent 663f949 commit c1d5de9
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion Docs/source/usage/parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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 `<species_name>` 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.
Expand Down

0 comments on commit c1d5de9

Please sign in to comment.