aboutsummaryrefslogtreecommitdiff
path: root/Docs/source/usage
diff options
context:
space:
mode:
Diffstat (limited to 'Docs/source/usage')
-rw-r--r--Docs/source/usage/parameters.rst5
1 files changed, 1 insertions, 4 deletions
diff --git a/Docs/source/usage/parameters.rst b/Docs/source/usage/parameters.rst
index 5a9b9f175..a5914fbc3 100644
--- a/Docs/source/usage/parameters.rst
+++ b/Docs/source/usage/parameters.rst
@@ -2157,12 +2157,9 @@ In-situ capabilities can be used by turning on Sensei or Ascent (provided they a
Possible scalar fields: ``part_per_cell`` ``rho`` ``phi`` ``F`` ``part_per_grid`` ``divE`` ``divB`` and ``rho_<species_name>``, where ``<species_name>`` must match the name of one of the available particle species. Note that ``phi`` will only be written out when do_electrostatic==labframe. Also, note that for ``<diag_name>.diag_type = BackTransformed``, the only scalar field currently supported is ``rho``.
Possible vector field components in Cartesian geometry: ``Ex`` ``Ey`` ``Ez`` ``Bx`` ``By`` ``Bz`` ``jx`` ``jy`` ``jz``.
Possible vector field components in RZ geometry: ``Er`` ``Et`` ``Ez`` ``Br`` ``Bt`` ``Bz`` ``jr`` ``jt`` ``jz``.
- Default is ``<diag_name>.fields_to_plot = Ex Ey Ez Bx By Bz jx jy jz``,
- unless in RZ geometry with ``<diag_name>.format == openpmd``,
- then default is ``<diag_name>.fields_to_plot = Er Et Ez Br Bt Bz jr jt jz``.
+ The default is ``<diag_name>.fields_to_plot = Ex Ey Ez Bx By Bz jx jy jz`` in Cartesian geometry and ``<diag_name>.fields_to_plot = Er Et Ez Br Bt Bz jr jt jz`` in RZ geometry.
When the special value ``none`` is specified, no fields are written out.
Note that the fields are averaged on the cell centers before they are written to file.
- Also, when ``<diag_name>.format = openpmd``, the RZ modes for all fields are written.
Otherwise, we reconstruct a 2D Cartesian slice of the fields for output at :math:`\theta=0`.
* ``<diag_name>.dump_rz_modes`` (`0` or `1`) optional (default `0`)