You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Delete more deprecated code after in-situ uses new diagnostics format (#1041)
* move ascent to new diagnostics
* move Sensei to the new diagnostics
* minor cleaning in new diagnostics
* Delete more deprecated code after in-situ uses new diags
* remove deprecated input options from subcycling test
* Finish updating the doc for Sensei and Ascent with the new diags
Copy file name to clipboardExpand all lines: Docs/source/running_cpp/parameters.rst
+14-18Lines changed: 14 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1133,6 +1133,9 @@ Boundary conditions
1133
1133
Diagnostics and output
1134
1134
----------------------
1135
1135
1136
+
In-situ visualization
1137
+
^^^^^^^^^^^^^^^^^^^^^
1138
+
1136
1139
WarpX has three types of diagnostics:
1137
1140
``FullDiagnostics`` consist in dumps of fields and particles at given iterations,
1138
1141
``BackTransformedDiagnostics`` are used when running a simulation in a boosted frame, to reconstruct output data to the lab frame, and
@@ -1148,6 +1151,7 @@ Similar to what is done for physical species, WarpX has a class Diagnostics that
1148
1151
The user specifies the number of diagnostics and the name of each of them, and then specifies options for each of them separately.
1149
1152
Note that some parameter (those that do not start with a ``<diag_name>.`` prefix) apply to all diagnostics.
1150
1153
This should be changed in the future.
1154
+
In-situ capabilities can be used by turning on Sensei or Ascent (provided they are installed) through the output format, see below.
1151
1155
1152
1156
* ``diagnostics.diags_names`` (list of `string` optional, default `empty`)
1153
1157
Name of each diagnostics.
@@ -1175,8 +1179,18 @@ This should be changed in the future.
1175
1179
1176
1180
* ``ascent`` for in-situ visualization using Ascent.
1177
1181
1182
+
* ``sensei`` for in-situ visualization using Sensei.
1183
+
1178
1184
example: ``diag1.format = openpmd``.
1179
1185
1186
+
* ``<diag_name>.sensei_config`` (`string`)
1187
+
Only read if ``<diag_name>.format = sensei``.
1188
+
Points to the SENSEI XML file which selects and configures the desired back end.
1189
+
1190
+
* ``<diag_name>.sensei_pin_mesh`` (`integer`; 0 by default)
1191
+
Only read if ``<diag_name>.format = sensei``.
1192
+
When 1 lower left corner of the mesh is pinned to 0.,0.,0.
1193
+
1180
1194
* ``<diag_name>.openpmd_backend`` (``bp``, ``h5`` or ``json``) optional, only used if ``<diag_name>.format = openpmd``
1181
1195
`I/O backend <https://openpmd-api.readthedocs.io/en/latest/backends/overview.html>`_ for `openPMD <https://www.openPMD.org>`_ data dumps.
1182
1196
``bp`` is the `ADIOS I/O library <https://csmd.ornl.gov/adios>`_, ``h5`` is the `HDF5 format <https://www.hdfgroup.org/solutions/hdf5/>`_, and ``json`` is a `simple text format <https://en.wikipedia.org/wiki/JSON>`_.
@@ -1530,24 +1544,6 @@ Reduced Diagnostics
1530
1544
The separator between row values in the output file.
1531
1545
The default separator is a whitespace.
1532
1546
1533
-
In-situ visualization
1534
-
^^^^^^^^^^^^^^^^^^^^^
1535
-
1536
-
Besides the diagnostics described above, WarpX has in-situ visualization capabilities.
1537
-
This is controlled by the following option(s):
1538
-
1539
-
* ``insitu.int`` (`integer`; 0 by default)
1540
-
Turns in situ processing on or off and controls how often data is processed.
1541
-
1542
-
* ``insitu.start`` (`integer`; 0 by default)
1543
-
Controls when in situ processing starts.
1544
-
1545
-
* ``insitu.config`` (`string`)
1546
-
Points to the SENSEI XML file which selects and configures the desired back end.
1547
-
1548
-
* ``insitu.pin_mesh`` (`integer`; 0 by default)
1549
-
when 1 lower left corner of the mesh is pinned to 0.,0.,0.
1550
-
1551
1547
Lookup tables and other settings for QED modules (implementation in progress)
0 commit comments