aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
authorGravatar Remi Lehe <remi.lehe@normalesup.org> 2019-05-07 11:13:56 -0700
committerGravatar Remi Lehe <remi.lehe@normalesup.org> 2019-05-07 11:13:56 -0700
commit0be0df0284caf6b6c81c191411da1b32f2748fb7 (patch)
tree3f7e94c9dd8431e486fd82e1f18335043d2ee96d /Docs/source/running_cpp
parent5060718c6eab3b8e1a5b26133d885c6e674ae8fe (diff)
downloadWarpX-0be0df0284caf6b6c81c191411da1b32f2748fb7.tar.gz
WarpX-0be0df0284caf6b6c81c191411da1b32f2748fb7.tar.zst
WarpX-0be0df0284caf6b6c81c191411da1b32f2748fb7.zip
Add more documentation
Diffstat (limited to 'Docs/source/running_cpp')
-rw-r--r--Docs/source/running_cpp/parameters.rst14
1 files changed, 9 insertions, 5 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
index 3ef3dea88..50a419e81 100644
--- a/Docs/source/running_cpp/parameters.rst
+++ b/Docs/source/running_cpp/parameters.rst
@@ -65,14 +65,14 @@ Setting up the field mesh
level, instead of gathering the fields from the refinement patch itself.
This avoids some of the spurious effects that can occur inside the
refinement patch, close to its edge. See the section
- :doc:`../../theory/warpx_theory` for more details.
+ :doc:`../../theory/amr` for more details.
* ``n_current_deposition_buffer`` (`integer`)
When using mesh refinement: the particles that are located inside
a refinement patch, but within ``n_field_gather_buffer`` cells of
the edge of this patch, will deposit their charge and current to the
lower refinement level, instead of depositing to the refinement patch
- itself. See the section :doc:`../../theory/warpx_theory` for more details.
+ itself. See the section :doc:`../../theory/amr` for more details.
Distribution across MPI ranks and parallelization
-------------------------------------------------
@@ -150,10 +150,14 @@ Particle initialization
Whether to activate the FDTD Numerical Cherenkov Instability corrector.
* ``particles.rigid_injected_species`` (`strings`, separated by spaces)
- List of species injected using the rigid injection method. For species injected
- using this method, particles are translated along the `+z` axis with constant velocity
- as long as their ``z`` coordinate verifies ``z<zinject_plane``. When ``z>zinject_plane``,
+ List of species injected using the rigid injection method. The rigid injection
+ method is useful when injecting a relativistic particle beam, in boosted-frame
+ simulation ; see the section :doc:`../../theory/input_output` for more details.
+ For species injected using this method, particles are translated along the `+z`
+ axis with constant velocity as long as their ``z`` coordinate verifies
+ ``z<zinject_plane``. When ``z>zinject_plane``,
particles are pushed in a standard way, using the specified pusher.
+ (see the parameter ``<species_name>.zinject_plane`` below)
* ``<species_name>.charge`` (`float`)
The charge of one `physical` particle of this species.