diff options
Diffstat (limited to 'Docs/source/usage/parameters.rst')
| -rw-r--r-- | Docs/source/usage/parameters.rst | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/Docs/source/usage/parameters.rst b/Docs/source/usage/parameters.rst index f7eba5583..0a12dc82d 100644 --- a/Docs/source/usage/parameters.rst +++ b/Docs/source/usage/parameters.rst @@ -725,8 +725,8 @@ Particle initialization For more information on the `openPMD format <https://github.com/openPMD>`__ and how to build WarpX with it, please visit :ref:`the install section <install-developers>`. * ``NFluxPerCell``: Continuously inject a flux of macroparticles from a planar surface. - The density specified by the density profile is interpreted to have the units of #/m^2/s. This requires the additional parameters: + ``<species_name>.flux_profile`` (see the description of this parameter further below) ``<species_name>.surface_flux_pos`` (`double`, location of the injection plane [meter]) ``<species_name>.flux_normal_axis`` (`x`, `y`, or `z` for 3D, `x` or `z` for 2D, or `r`, `t`, or `z` for RZ. When `flux_normal_axis` is `r` or `t`, the `x` and `y` components of the user-specified momentum distribution are interpreted as the `r` and `t` components respectively) ``<species_name>.flux_direction`` (`-1` or `+1`, direction of flux relative to the plane) @@ -802,6 +802,16 @@ Particle initialization ``electrons.density_function(x,y,z) = "n0+n0*x**2*1.e12"`` where ``n0`` is a user-defined constant, see above. WARNING: where ``density_function(x,y,z)`` is close to zero, particles will still be injected between ``xmin`` and ``xmax`` etc., with a null weight. This is undesirable because it results in useless computing. To avoid this, see option ``density_min`` below. +* ``<species_name>.flux_profile`` (`string`) + Defines the expression of the flux, when using ``<species_name>.injection_style=NFluxPerCell`` + + * ``constant``: Constant flux. This requires the additional parameter ``<species_name>.flux``. + i.e., the injection flux in :math:`m^{-2}.s^{-1}`. + + * ``parse_flux_function``: the flux is given by a function in the input file. + It requires the additional argument ``<species_name>.flux_function(x,y,z,t)``, which is a + mathematical expression for the flux of the species. + * ``<species_name>.density_min`` (`float`) optional (default `0.`) Minimum plasma density. No particle is injected where the density is below this value. |