aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/running_cpp
diff options
context:
space:
mode:
authorGravatar Edoardo Zoni <59625522+EZoni@users.noreply.github.com> 2020-09-23 17:14:43 -0700
committerGravatar GitHub <noreply@github.com> 2020-09-23 17:14:43 -0700
commitb1c9e243f1a00f597dfaaa122597c015d71b67ac (patch)
tree54f68e1f2e759fc9215d90834929882df11a96c5 /Docs/source/running_cpp
parent08b7bcc549ccdc412cfb06b278a92b4e0b13ead9 (diff)
downloadWarpX-b1c9e243f1a00f597dfaaa122597c015d71b67ac.tar.gz
WarpX-b1c9e243f1a00f597dfaaa122597c015d71b67ac.tar.zst
WarpX-b1c9e243f1a00f597dfaaa122597c015d71b67ac.zip
Dump rho per species (#1294)
* Add strings rho_<species_name> to m_varnames * Initialize rho functor for each species * Get charge density per species * Correct selection of species to dump rho * Clear vector of string used to parse input * Add missing Doxygen parameter * Update documentation * Fix bug introduced in RZ geometry * Add includes * Rename variables as species_variables * Replace 0 with 0u (unsigned) * Simplify using range-based loops * Use range-checked .at() to access vector elements * Improve comments
Diffstat (limited to 'Docs/source/running_cpp')
-rw-r--r--Docs/source/running_cpp/parameters.rst7
1 files changed, 5 insertions, 2 deletions
diff --git a/Docs/source/running_cpp/parameters.rst b/Docs/source/running_cpp/parameters.rst
index 2b3ddd87d..7805155ce 100644
--- a/Docs/source/running_cpp/parameters.rst
+++ b/Docs/source/running_cpp/parameters.rst
@@ -1432,13 +1432,16 @@ s disabled.
Which species dumped in this diagnostics.
* ``<diag_name>.<species_name>.variables`` (list of `strings` separated by spaces, optional)
- List of particle quantities to write to output file.
- By defaults, all quantities are written to file. Choices are
+ List of particle quantities or species-specific field quantities to write to output file.
+ Choices are
* ``w`` for the particle weight,
* ``ux`` ``uy`` ``uz`` for the particle momentum,
+ * ``rho`` to dump the charge density of the particles belonging to species ``<species_name>``.
+
+ By defaults, all quantities are written to output file, except the charge density.
The particle positions are always included.
Use ``<species>.variables = none`` to plot no particle data, except particle position.