aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
authorGravatar MaxThevenet <mthevenet@lbl.gov> 2019-09-20 13:42:47 -0700
committerGravatar MaxThevenet <mthevenet@lbl.gov> 2019-09-20 13:42:47 -0700
commit441b196e913ad99d802e04eb026b8454190c3ba8 (patch)
treedf42317d5f6a089966160f0e3c74f6b483dc7a3b /Docs/source/running_cpp
parent266fec6dc5586ee0f878fbeec06f317f0286ce2c (diff)
downloadWarpX-441b196e913ad99d802e04eb026b8454190c3ba8.tar.gz
WarpX-441b196e913ad99d802e04eb026b8454190c3ba8.tar.zst
WarpX-441b196e913ad99d802e04eb026b8454190c3ba8.zip
add reference to 3D rendering scripts in doc, remove old script in Tools, and update description of parabolic profile
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 a6f6756ad..32b56456c 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``.