Added description of singleparticle particle injection style

mrowan137 · Apr 4, 2020 · f02d842 · f02d842
1 parent 98fe23a
commit f02d842
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
@@ -270,6 +270,12 @@ Particle initialization
     * ``NRandomPerCell``: injection with a fixed number of randomly-distributed particles per cell.
       This requires the additional parameter ``<species_name>.num_particles_per_cell``.
 
+    * ``singleparticle``: Inject a single macroparticle.
+      This requires the additional parameters:
+      ``<species_name>.single_particle_pos (`3 doubles`, particle 3D position)
+      ``<species_name>.single_particle_vel (`3 doubles`, particle 3D normalized momentum, i.e. :math:`= \gamma \beta`)
+      ``<species_name>.single_particle_weight ( `double`, macroparticle weight, i.e. nr of physical particles it represents)
+
     * ``gaussian_beam``: Inject particle beam with gaussian distribution in
       space in all directions. This requires additional parameters:
       ``<species_name>.q_tot`` (beam charge),