Skip to content

Commit

Permalink
Docs: correct formatting of gaussian_parse_momentum_function (#5038)
Browse files Browse the repository at this point in the history
  • Loading branch information
RemiLehe authored Jul 11, 2024
1 parent a0ce802 commit 5f67151
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions Docs/source/usage/parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1156,8 +1156,8 @@ Particle initialization
* ``gaussian_parse_momentum_function``: Gaussian momentum distribution where the mean and the standard deviation are given by functions of position in the input file.
Both are assumed to be non-relativistic.
The mean is the normalized momentum, :math:`u_m = \gamma v_m/c`.
The standard deviation is normalized, :math:`u_th = v_th/c`.
For example, this might be `u_th = sqrt(T*q_e/mass)/clight` given the temperature (in eV) and mass.
The standard deviation is normalized, :math:`u_{th} = v_{th}/c`.
For example, this might be ``u_th = sqrt(T*q_e/mass)/clight`` given the temperature (in eV) and mass.
It requires the following arguments:

* ``<species_name>.momentum_function_ux_m(x,y,z)``: mean :math:`u_{x}`
Expand Down

0 comments on commit 5f67151

Please sign in to comment.