Skip to content

Commit ba37c77

Browse files
authored
Add predefined density profile to parameters documentation (#2155)
1 parent 8836f4a commit ba37c77

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

Docs/source/usage/parameters.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -604,6 +604,10 @@ Particle initialization
604604
and ``<species_name>.xmax`` (and same in all directions). This requires additional
605605
parameter ``<species_name>.density``. i.e., the plasma density in :math:`m^{-3}`.
606606

607+
* ``predefined``: Predefined density profile.
608+
This requires additional parameters ``<species_name>.predefined_profile_name`` and ``<species_name>.predefined_profile_params``.
609+
Currently, only a parabolic channel density profile is implemented.
610+
607611
* ``parse_density_function``: the density is given by a function in the input file.
608612
It requires additional argument ``<species_name>.density_function(x,y,z)``, which is a
609613
mathematical expression for the density of the species, e.g.
@@ -701,7 +705,7 @@ Particle initialization
701705
``vzbar`` until it reaches ``zinject_plane``.
702706

703707
* ``species_name.predefined_profile_name`` (`string`)
704-
Only read of ``<species_name>.electrons.profile`` is `predefined`.
708+
Only read if ``<species_name>.profile`` is ``predefined``.
705709

706710
* If ``parabolic_channel``, the plasma profile is a parabolic profile with
707711
cosine-like ramps at the beginning and the end of the profile.

0 commit comments

Comments
 (0)