aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
authorGravatar MaxThevenet <mthevenet@lbl.gov> 2019-05-07 16:41:24 -0700
committerGravatar MaxThevenet <mthevenet@lbl.gov> 2019-05-07 16:41:24 -0700
commitb0e989dbb5006719426e67912d7c78f7f5aea796 (patch)
tree6c00c47670bd87f2141bb5136b87dcf26701f90c /Docs/source/running_cpp
parent704f53d270cf173bf86e06901450b8a70610af4c (diff)
downloadWarpX-b0e989dbb5006719426e67912d7c78f7f5aea796.tar.gz
WarpX-b0e989dbb5006719426e67912d7c78f7f5aea796.tar.zst
WarpX-b0e989dbb5006719426e67912d7c78f7f5aea796.zip
fix doc
Diffstat (limited to 'Docs/source/running_cpp')
-rw-r--r--Docs/source/running_cpp/parameters.rst8
1 files changed, 7 insertions, 1 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
index cf1247f16..b1e05f950 100644
--- a/Docs/source/running_cpp/parameters.rst
+++ b/Docs/source/running_cpp/parameters.rst
@@ -418,7 +418,13 @@ Laser initialization
If the antenna starts outside of the simulation domain but enters it
at some point (due to moving window or moving antenna in the boosted
frame), use this so that the laser antenna is injected when it reaches
- the box boundary. Currently only works if boost direction, laser direction
+ the box boundary. If running in a boosted frame, this requires the
+ boost direction, moving window direction and laser propagation direction
+ to be along `z`. If not running in a boosted frame, this requires the
+ moving window and laser propagation directions to be the same (`x`, `y`
+ or `z`)
+
+Currently only works if boost direction, laser direction
and moving window are all in the `z` direction.
* ``warpx.num_mirrors`` (`int`) optional (default `0`)