diff options
| author |  Remi Lehe <remi.lehe@normalesup.org>
| 2019-08-03 11:14:57 -0700 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2019-08-03 11:14:57 -0700 |
| commit | 9834211e76bd029f402e328b0bd7cf068ab46e2e (patch) | |
| tree | e2808950d194eb057b4481aef1595c2a3f98c20f /Docs/source/running_cpp | |
| parent | 1c137793dcfe35dc164eec1ec900f3ad8efc83ed (diff) | |
| parent | bf8bedf9fe8ba979f676ff7fce34630632e302a1 (diff) | |
| download | WarpX-9834211e76bd029f402e328b0bd7cf068ab46e2e.tar.gz WarpX-9834211e76bd029f402e328b0bd7cf068ab46e2e.tar.zst WarpX-9834211e76bd029f402e328b0bd7cf068ab46e2e.zip | |
Merge pull request #253 from ECP-WarpX/min_density
[mini-PR] allow threshold for plasma density
Diffstat (limited to 'Docs/source/running_cpp')
| -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. |