aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
authorGravatar Cameron Yang <cameronyang@lbl.gov> 2019-11-13 17:16:45 -0800
committerGravatar Cameron Yang <cameronyang@lbl.gov> 2019-11-13 17:16:45 -0800
commit1b05db8f849b7e36e339e32360a2a21b9a36fe64 (patch)
tree81198921b5d20c21bbf7b455489e25b0f6228c39 /Docs/source/running_cpp
parent6e7384d29f834a7853f4433258edbc5163366765 (diff)
downloadWarpX-1b05db8f849b7e36e339e32360a2a21b9a36fe64.tar.gz
WarpX-1b05db8f849b7e36e339e32360a2a21b9a36fe64.tar.zst
WarpX-1b05db8f849b7e36e339e32360a2a21b9a36fe64.zip
Added information on MB method and made code corrections.
Diffstat (limited to 'Docs/source/running_cpp')
-rw-r--r--Docs/source/running_cpp/parameters.rst11
1 files changed, 6 insertions, 5 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
index e7c20976f..139811ffc 100644
--- a/Docs/source/running_cpp/parameters.rst
+++ b/Docs/source/running_cpp/parameters.rst
@@ -271,10 +271,11 @@ Particle initialization
kb is the Boltzmann constant, c is the speed of light, and m is the mass of the species.
It also includes the optional parameter ``<species_name>.beta`` where beta is equal to v/c.
The plasma will be initialized to move at drift velocity beta*c in the positive
- ``<species_name>.direction = 'x', 'y', 'z'``, direction. The MB distribution is initialized
- in the drifting frame by sampling three Gaussian distributions in each dimension, and then
- the distribution is transformed to the simulation frame using the flipping method. The
- flipping method can be found in Zenitani 2015 section III. B. (Phys. Plasmas 22, 042116).
+ ``<species_name>.direction = 'x', 'y', 'z'`` direction. The MB distribution is initialized
+ in the drifting frame by sampling three Gaussian distributions in each dimension using,
+ the Box Mueller method, and then the distribution is transformed to the simulation frame
+ using the flipping method. The flipping method can be found in Zenitani 2015
+ section III. B. (Phys. Plasmas 22, 042116).
Note that though the particles may move at relativistic speeds in the simulation frame,
they are not relativistic in the drift frame. This is as opposed to the Maxwell Juttner
@@ -285,7 +286,7 @@ Particle initialization
to kb*T/(m*c^2), where kb is the Boltzmann constant, and m is the mass of the species. It also
includes the optional parameter ``<species_name>.beta`` where beta is equal to v/c. The plasma
will be initialized to move at velocity beta*c in the positive
- ``<species_name>.direction = 'x', 'y', 'z'``, direction. The MJ distribution will be initialized
+ ``<species_name>.direction = 'x', 'y', 'z'`` direction. The MJ distribution will be initialized
in the moving frame using the Sobol method, and then the distribution will be transformed to the
simulation frame using the flipping method. Both the Sobol and the flipping method can be found
in Zenitani 2015 (Phys. Plasmas 22, 042116).