Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
franzpoeschel committed Jun 6, 2024
1 parent 17c42f3 commit 237b394
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/source/details/mpi.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@ Functionality Behavior Description
.. [4] We usually open iterations delayed on first access. This first access is usually the ``flush()`` call after a ``storeChunk``/``loadChunk`` operation. If the first access is non-collective, an explicit, collective ``Iteration::open()`` can be used to have the files already open.
Alternatively, iterations might be accessed for the first time by immediate operations such as ``::availableChunks()``.
.. warning::

The openPMD-api will by default flush only those Iterations which are dirty, i.e. have been written to.
This is somewhat unfortunate in parallel setups since only the dirty status of the current MPI rank can be considered.
As a workaround, use ``Attributable::seriesFlush()`` on an Iteration (or an object contained within an Iteration) to force flush that Iteration regardless of its dirty status.

.. tip::

Just because an operation is independent does not mean it is allowed to be inconsistent.
Expand Down

0 comments on commit 237b394

Please sign in to comment.