aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
Diffstat (limited to 'Docs/source/running_cpp')
-rw-r--r--Docs/source/running_cpp/parameters.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
index cce6b6224..01be6384c 100644
--- a/Docs/source/running_cpp/parameters.rst
+++ b/Docs/source/running_cpp/parameters.rst
@@ -278,6 +278,10 @@ Particle initialization
and optional argument ``<species_name>.do_symmetrize`` (whether to
symmetrize the beam in the x and y directions).
+ * ``external_file``: inject macroparticles with properties (charge, mass, position, and momentum) according to data in external file.
+ It requires the additional argument ``<species_name>.injection_file``, which is the string corresponding to the OpenPMD file name.
+ When using this style, it is not necessary to add other ``<species_name>.(...)`` paramters, because they will be read directly from the file.
+
* ``<species_name>.num_particles_per_cell_each_dim`` (`3 integers in 3D and RZ, 2 integers in 2D`)
With the NUniformPerCell injection style, this specifies the number of particles along each axis
within a cell. Note that for RZ, the three axis are radius, theta, and z and that the recommended