diff options
Diffstat (limited to 'Docs/source/usage/parameters.rst')
| -rw-r--r-- | Docs/source/usage/parameters.rst | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/Docs/source/usage/parameters.rst b/Docs/source/usage/parameters.rst index 0b6d65436..c40dc8bea 100644 --- a/Docs/source/usage/parameters.rst +++ b/Docs/source/usage/parameters.rst @@ -1892,6 +1892,21 @@ In-situ capabilities can be used by turning on Sensei or Ascent (provided they a <diag_name>.adios2_operator.type = zfp <diag_name>.adios2_operator.parameters.precision = 3 +* ``<diag_name>.adios2_engine.type`` (``bp4``, ``sst``, ``ssc``, ``dataman``) optional, + `ADIOS2 Engine type <https://openpmd-api.readthedocs.io/en/0.14.0/details/backendconfig.html#adios2>`__ for `openPMD <https://www.openPMD.org>`_ data dumps. + See full list of engines at `ADIOS2 readthedocs <https://adios2.readthedocs.io/en/latest/engines/engines.html>`__ + +* ``<diag_name>.adios2_engine.parameters.*`` optional, + `ADIOS2 Engine parameters <https://openpmd-api.readthedocs.io/en/0.14.0/details/backendconfig.html#adios2>`__ for `openPMD <https://www.openPMD.org>`_ data dumps. + + An example for parameters for the BP engine are setting the number of writers (``NumAggregators``), transparently redirecting data to burst buffers etc. + A detailed list of engine-specific parameters are available at the official `ADIOS2 documentation <https://adios2.readthedocs.io/en/latest/engines/engines.html>`__ + + .. code-block:: text + + <diag_name>.adios2_engine.parameter.NumAggregators = 2048 + <diag_name>.adios2_engine.parameters.BurstBufferPath="/mnt/bb/username" + * ``<diag_name>.fields_to_plot`` (list of `strings`, optional) Fields written to output. Possible values: ``Ex`` ``Ey`` ``Ez`` ``Bx`` ``By`` ``Bz`` ``jx`` ``jy`` ``jz`` ``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. |