aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
authorGravatar Axel Huebl <axel.huebl@plasma.ninja> 2019-09-26 09:11:52 -0700
committerGravatar GitHub <noreply@github.com> 2019-09-26 09:11:52 -0700
commit2e43f6030099c1d029f39d2b91725f5e14b6fcea (patch)
treef7d2676295b557cd4017f6ad4a6e14152efd58f7 /Docs/source/running_cpp
parent854e1710f0b55b0caf3aba2cb34ed86d52b84216 (diff)
parent737e499e314c3fcbde4e22e07f78f7f595cb1d8e (diff)
downloadWarpX-2e43f6030099c1d029f39d2b91725f5e14b6fcea.tar.gz
WarpX-2e43f6030099c1d029f39d2b91725f5e14b6fcea.tar.zst
WarpX-2e43f6030099c1d029f39d2b91725f5e14b6fcea.zip
Merge pull request #385 from MaxThevenet/clean_Tools
update doc and cleaning in Tools
Diffstat (limited to 'Docs/source/running_cpp')
-rw-r--r--Docs/source/running_cpp/parameters.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
index 0e28723af..17b6a1c5d 100644
--- a/Docs/source/running_cpp/parameters.rst
+++ b/Docs/source/running_cpp/parameters.rst
@@ -285,8 +285,9 @@ Particle initialization
* ``species_name.predefined_profile_name`` (`string`)
Only read of ``<species_name>.electrons.profile`` is `predefined`.
- * If ``parabolic_channel``, the plasma profile is a parabolic profile with linear ramps
- at the beginning and the end of the profile. The density is given by
+ * If ``parabolic_channel``, the plasma profile is a parabolic profile with
+ cosine-like ramps at the beginning and the end of the profile.
+ The density is given by
.. math::
@@ -299,9 +300,9 @@ Particle initialization
n(x,y) = 1 + 4\frac{x^2+y^2}{k_p^2 R_c^4}
where :math:`k_p` is the plasma wavenumber associated with density :math:`n_0`.
- Here, :math:`n(z)` is a linear up-ramp from :math:`0` to :math:`L_{ramp,up}`,
+ Here, :math:`n(z)` is a cosine-like up-ramp from :math:`0` to :math:`L_{ramp,up}`,
constant to :math:`1` from :math:`L_{ramp,up}` to :math:`L_{ramp,up} + L_{plateau}`
- and a linear down-ramp from :math:`L_{ramp,up} + L_{plateau}` to
+ and a cosine-like down-ramp from :math:`L_{ramp,up} + L_{plateau}` to
:math:`L_{ramp,up} + L_{plateau}+L_{ramp,down}`. All parameters are given
in ``predefined_profile_params``.