diff options
| author |  MaxThevenet <mthevenet@lbl.gov>
| 2019-08-02 11:37:23 -0700 |
|---|---|---|
| committer | MaxThevenet <mthevenet@lbl.gov>
| 2019-08-02 11:37:23 -0700 |
| commit | bf8bedf9fe8ba979f676ff7fce34630632e302a1 (patch) | |
| tree | 71cb29c4c07d4efedeacbd0ca0f4870ed9c68a76 /Docs/source/running_cpp/parameters.rst | |
| parent | 0c6441b735a4226bd9e1b51a7efdf48111745c1b (diff) | |
| download | WarpX-bf8bedf9fe8ba979f676ff7fce34630632e302a1.tar.gz WarpX-bf8bedf9fe8ba979f676ff7fce34630632e302a1.tar.zst WarpX-bf8bedf9fe8ba979f676ff7fce34630632e302a1.zip | |
add doc
Diffstat (limited to 'Docs/source/running_cpp/parameters.rst')
| -rw-r--r-- | Docs/source/running_cpp/parameters.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst index 7b2d2c0e6..f63930c77 100644 --- a/Docs/source/running_cpp/parameters.rst +++ b/Docs/source/running_cpp/parameters.rst @@ -219,6 +219,14 @@ Particle initialization ``electrons.density_function(x,y,z) = "n0+n0*x**2*1.e12"`` where ``n0`` is a user-defined constant, see above. +* ``<species_name>.density_min`` (`float`) optional (default `0.`) + Minimum plasma density. No particle is injected where the density is below + this value. + +* ``<species_name>.density_max`` (`float`) optional (default `infinity`) + Maximum plasma density. The density at each point is the minimum between + the value given in the profile, and `density_max`. + * ``<species_name>.radially_weighted`` (`bool`) optional (default `true`) Whether particle's weight is varied with their radius. This only applies to cylindrical geometry. The only valid value is true. |