Skip to content

Commit

Permalink
Delete more deprecated code after in-situ uses new diagnostics format (
Browse files Browse the repository at this point in the history
…#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
  • Loading branch information
MaxThevenet authored May 30, 2020
1 parent bd7d6f6 commit fe784c7
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 463 deletions.
32 changes: 14 additions & 18 deletions Docs/source/running_cpp/parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1133,6 +1133,9 @@ Boundary conditions
Diagnostics and output
----------------------

In-situ visualization
^^^^^^^^^^^^^^^^^^^^^

WarpX has three types of diagnostics:
``FullDiagnostics`` consist in dumps of fields and particles at given iterations,
``BackTransformedDiagnostics`` are used when running a simulation in a boosted frame, to reconstruct output data to the lab frame, and
Expand All @@ -1148,6 +1151,7 @@ Similar to what is done for physical species, WarpX has a class Diagnostics that
The user specifies the number of diagnostics and the name of each of them, and then specifies options for each of them separately.
Note that some parameter (those that do not start with a ``<diag_name>.`` prefix) apply to all diagnostics.
This should be changed in the future.
In-situ capabilities can be used by turning on Sensei or Ascent (provided they are installed) through the output format, see below.

* ``diagnostics.diags_names`` (list of `string` optional, default `empty`)
Name of each diagnostics.
Expand Down Expand Up @@ -1175,8 +1179,18 @@ This should be changed in the future.

* ``ascent`` for in-situ visualization using Ascent.

* ``sensei`` for in-situ visualization using Sensei.

example: ``diag1.format = openpmd``.

* ``<diag_name>.sensei_config`` (`string`)
Only read if ``<diag_name>.format = sensei``.
Points to the SENSEI XML file which selects and configures the desired back end.

* ``<diag_name>.sensei_pin_mesh`` (`integer`; 0 by default)
Only read if ``<diag_name>.format = sensei``.
When 1 lower left corner of the mesh is pinned to 0.,0.,0.

* ``<diag_name>.openpmd_backend`` (``bp``, ``h5`` or ``json``) optional, only used if ``<diag_name>.format = openpmd``
`I/O backend <https://openpmd-api.readthedocs.io/en/latest/backends/overview.html>`_ for `openPMD <https://www.openPMD.org>`_ data dumps.
``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>`_.
Expand Down Expand Up @@ -1530,24 +1544,6 @@ Reduced Diagnostics
The separator between row values in the output file.
The default separator is a whitespace.

In-situ visualization
^^^^^^^^^^^^^^^^^^^^^

Besides the diagnostics described above, WarpX has in-situ visualization capabilities.
This is controlled by the following option(s):

* ``insitu.int`` (`integer`; 0 by default)
Turns in situ processing on or off and controls how often data is processed.

* ``insitu.start`` (`integer`; 0 by default)
Controls when in situ processing starts.

* ``insitu.config`` (`string`)
Points to the SENSEI XML file which selects and configures the desired back end.

* ``insitu.pin_mesh`` (`integer`; 0 by default)
when 1 lower left corner of the mesh is pinned to 0.,0.,0.

Lookup tables and other settings for QED modules (implementation in progress)
-----------------------------------------------------------------------------

Expand Down
2 changes: 0 additions & 2 deletions Examples/Tests/subcycling/inputs_2d
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,6 @@ warpx.use_filter = 1
warpx.do_pml = 1
warpx.do_subcycling = 1
warpx.refine_plasma = 0
warpx.plot_finepatch = 1
warpx.plot_crsepatch = 1
warpx.n_current_deposition_buffer = 0
warpx.n_field_gather_buffer = 0

Expand Down
8 changes: 0 additions & 8 deletions Source/Diagnostics/FieldIO.H
Original file line number Diff line number Diff line change
Expand Up @@ -82,14 +82,6 @@ getInterpolatedVector(
const int r_ratio, const amrex::Real* dx,
const int ngrow );

void
coarsenCellCenteredFields(
amrex::Vector<amrex::MultiFab>& coarse_mf,
amrex::Vector<amrex::Geometry>& coarse_geom,
const amrex::Vector<amrex::MultiFab>& source_mf,
const amrex::Vector<amrex::Geometry>& source_geom,
int coarse_ratio, int finest_level );

#ifdef WARPX_USE_OPENPMD
void
setOpenPMDUnit( openPMD::Mesh mesh, const std::string field_name );
Expand Down
Loading

0 comments on commit fe784c7

Please sign in to comment.