aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
authorGravatar Remi Lehe <remi.lehe@normalesup.org> 2019-10-28 16:12:50 -0700
committerGravatar GitHub <noreply@github.com> 2019-10-28 16:12:50 -0700
commitf326192ee5140278c6061b1171b98c6a0f932320 (patch)
treeb9e687ace23d47a301e2ac07123bd41b912590ad /Docs/source/running_cpp
parent2eac8727874e11c3c8163b3d9ed1ec8854717753 (diff)
parentca6e70897035190dfdd2e706163b73bd383775b3 (diff)
downloadWarpX-f326192ee5140278c6061b1171b98c6a0f932320.tar.gz
WarpX-f326192ee5140278c6061b1171b98c6a0f932320.tar.zst
WarpX-f326192ee5140278c6061b1171b98c6a0f932320.zip
Merge pull request #476 from MaxThevenet/initial_fields
Add uniform initial field to the grid
Diffstat (limited to 'Docs/source/running_cpp')
-rw-r--r--Docs/source/running_cpp/parameters.rst8
1 files changed, 7 insertions, 1 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
index a2de46b03..e5c99a3d9 100644
--- a/Docs/source/running_cpp/parameters.rst
+++ b/Docs/source/running_cpp/parameters.rst
@@ -392,7 +392,7 @@ Particle initialization
It only works if `<species>.do_qed = 1`. Enables non-linear Breit-Wheeler process for this species.
**Implementation of this feature is in progress. It requires to compile with QED=TRUE**
-* ``warpx.E_external`` & ``warpx.B_external`` (list of `float`) optional (default `0.0`)
+* ``warpx.E_external_particle`` & ``warpx.B_external_particle`` (list of `float`) optional (default `0. 0. 0.`)
Two separate parameters which add a uniform E-field or B-field to each particle
which is then added to the field values gathered from the grid in the
PIC cycle.
@@ -583,6 +583,12 @@ Laser initialization
``mirror_z_width < dz/cell_size``, the upper bound of the mirror is increased
so that it contains at least ``mirror_z_npoints``.
+* ``warpx.E_external_grid`` & ``warpx.B_external_grid`` (list of `int`) optional (default `0. 0. 0.`)
+ External uniform and constant electrostatic and magnetostatic field added
+ to the grid at initialization. Use with caution as these fields are used for
+ the field solver. In particular, do not use any other boundary condition
+ than periodic.
+
Numerics and algorithms
-----------------------