diff options
| author |  Yinjian Zhao <yinjianzhao@lbl.gov>
| 2020-01-23 14:43:35 -0800 |
|---|---|---|
| committer | Yinjian Zhao <yinjianzhao@lbl.gov>
| 2020-01-23 14:43:35 -0800 |
| commit | d06b6f698729ffca37ddeefa79e3a9407d9f8d81 (patch) | |
| tree | 1a2a4f58aaf5eeb7eddbedc486fdaf1eea9c22a7 /Docs/source/running_cpp | |
| parent | 525e6bdc4f97152674ca68202c0e88dbfcd4769d (diff) | |
| download | WarpX-d06b6f698729ffca37ddeefa79e3a9407d9f8d81.tar.gz WarpX-d06b6f698729ffca37ddeefa79e3a9407d9f8d81.tar.zst WarpX-d06b6f698729ffca37ddeefa79e3a9407d9f8d81.zip | |
Change do_not_push to be species specific and add corresponding documentation.
Diffstat (limited to 'Docs/source/running_cpp')
| -rw-r--r-- | Docs/source/running_cpp/parameters.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst index cba041e6d..fe01815a2 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. |