aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
authorGravatar NeilZaim <49716072+NeilZaim@users.noreply.github.com> 2020-12-01 20:41:00 +0100
committerGravatar GitHub <noreply@github.com> 2020-12-01 11:41:00 -0800
commite044430eb54cea9c2b8fb9ccfb6d54d1976ab4c8 (patch)
tree0db1046ca0acf928704074dbacc5d86465c0d23b /Docs/source/running_cpp
parent89c371557a9ff271a35ec337046757a2d18f71b5 (diff)
downloadWarpX-e044430eb54cea9c2b8fb9ccfb6d54d1976ab4c8.tar.gz
WarpX-e044430eb54cea9c2b8fb9ccfb6d54d1976ab4c8.tar.zst
WarpX-e044430eb54cea9c2b8fb9ccfb6d54d1976ab4c8.zip
Add the possibility to disable Schwinger in part of the domain (#1524)
* Add the possibility to disable Schwinger in part of the domain * Update checksum benchmarks * Only query ymin and ymax in 3D
Diffstat (limited to 'Docs/source/running_cpp')
-rw-r--r--Docs/source/running_cpp/parameters.rst11
1 files changed, 7 insertions, 4 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
index 13f68b513..b82800904 100644
--- a/Docs/source/running_cpp/parameters.rst
+++ b/Docs/source/running_cpp/parameters.rst
@@ -332,14 +332,12 @@ Particle initialization
The mass of one `physical` particle of this species.
If ``species_type`` is specified, the mass will be set to the physical value and ``mass`` is optional.
-* ``<species_name>.xmin,ymin,zmin`` (`float`) optional (default unlimited)
- When ``<species_name>.xmin`` and ``<species_name>.xmax`` (see below) are set, they delimit the region within which particles are injected.
+* ``<species_name>.xmin,ymin,zmin`` and ``<species_name>.xmax,ymax,zmax`` (`float`) optional (default unlimited)
+ When ``<species_name>.xmin`` and ``<species_name>.xmax`` are set, they delimit the region within which particles are injected.
The WarpXParser (see :ref:`running-cpp-parameters-parser`) is used for the right-hand-side, so expressions like ``<species_name>.xmin = "2.+1."`` and/or using user-defined constants are accepted.
The same is applicable in the other directions.
If periodic boundary conditions are used in direction ``i``, then the default (i.e. if the range is not specified) range will be the simulation box, ``[geometry.prob_hi[i], geometry.prob_lo[i]]``.
-* ``<species_name>.xmax,ymax,zmax`` (`float`) optional (default unlimited)
-
* ``<species_name>.injection_style`` (`string`)
Determines how the particles will be injected in the simulation.
The options are:
@@ -1978,6 +1976,11 @@ Lookup tables store pre-computed values for functions used by the QED modules.
This value should correspond to the typical transverse extent for which the EM field has a very high value
(e.g. the beam waist for a focused laser beam).
+* ``qed_schwinger.xmin,ymin,zmin`` and ``qed_schwinger.xmax,ymax,zmax`` (`float`) optional (default unlimited)
+ When ``qed_schwinger.xmin`` and ``qed_schwinger.xmax`` are set, they delimit the region within
+ which Schwinger pairs can be created.
+ The same is applicable in the other directions.
+
* ``qed_schwinger.threshold_poisson_gaussian`` (`integer`) optional (default `25`)
If the expected number of physical pairs created in a cell at a given timestep is smaller than this threshold,
a Poisson distribution is used to draw the actual number of physical pairs created.