aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
authorGravatar Remi Lehe <remi.lehe@normalesup.org> 2020-01-24 10:09:47 -0800
committerGravatar GitHub <noreply@github.com> 2020-01-24 10:09:47 -0800
commitf217ff23e750946e755b299a6ecedc564b60d56e (patch)
tree7222fe6fa534192ffb105f4a0b3ddead9d5ddc3b /Docs/source/running_cpp
parented6d68282067a49c7f51b5e2042c1a45ce8a229c (diff)
parentd06b6f698729ffca37ddeefa79e3a9407d9f8d81 (diff)
downloadWarpX-f217ff23e750946e755b299a6ecedc564b60d56e.tar.gz
WarpX-f217ff23e750946e755b299a6ecedc564b60d56e.tar.zst
WarpX-f217ff23e750946e755b299a6ecedc564b60d56e.zip
Merge pull request #651 from Yin-YinjianZhao/do_not_push
Change do_not_push to be species specific and add documentation
Diffstat (limited to 'Docs/source/running_cpp')
-rw-r--r--Docs/source/running_cpp/parameters.rst4
1 files changed, 4 insertions, 0 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
index 078b733e6..b2810329a 100644
--- a/Docs/source/running_cpp/parameters.rst
+++ b/Docs/source/running_cpp/parameters.rst
@@ -386,6 +386,10 @@ Particle initialization
If `1` is given, both charge deposition and current deposition will
not be done, thus that species does not contribute to the fields.
+* ``<species_name>.do_not_push`` (`0` or `1` optional; default `0`)
+ If `1` is given, this species will not be pushed
+ by any pusher during the simulation.
+
* ``<species>.plot_species`` (`0` or `1` optional; default `1`)
Whether to plot particle quantities for this species.