Logical compilation of data from one snapshot (e.g.
More...
#include <Iteration.hpp>
|
template<typename T , typename T_key , typename T_container > |
class | Container |
|
class | SeriesInterface |
|
class | WriteIterations |
|
class | SeriesIterator |
|
◆ close()
Iteration & openPMD::Iteration::close |
( |
bool |
flush = true | ) |
|
Close an iteration.
No further (backend-propagating) accesses may be performed on this iteration. A closed iteration may not (yet) be reopened.
With an MPI-parallel series, close is an MPI-collective operation.
- Returns
- Reference to iteration.
◆ closed()
bool openPMD::Iteration::closed |
( |
| ) |
const |
Has the iteration been closed? A closed iteration may not (yet) be reopened.
- Returns
- Whether the iteration has been closed.
◆ closedByWriter()
bool openPMD::Iteration::closedByWriter |
( |
| ) |
const |
Has the iteration been closed by the writer? Background: Upon calling Iteration::close(), the openPMD API will add metadata to the iteration in form of an attribute, indicating that the iteration has indeed been closed.
Useful mainly in streaming context when a reader inquires from a writer that it is done writing.
- Returns
- Whether the iteration has been explicitly closed (yet) by the writer.
◆ dt()
- Template Parameters
-
T | Floating point type of user-selected precision (e.g. float, double). |
- Returns
- Time step used to reach this iteration.
◆ open()
Open an iteration.
Explicitly open an iteration. Usually, file-open operations are delayed until the first load/storeChunk operation is flush-ed. In parallel contexts where it is know that such a first access needs to be run non-collectively, one can explicitly open an iteration through this collective call. Also necessary when using defer_iteration_parsing. The Streaming API (i.e. Series::readIterations()) will call this method implicitly and users need not call it.
- Returns
- Reference to iteration.
◆ setDt()
template<typename T >
template Iteration & openPMD::Iteration::setDt< long double > |
( |
T |
newDt | ) |
|
Set the time step used to reach this iteration.
- Template Parameters
-
T | Floating point type of user-selected precision (e.g. float, double). |
- Parameters
-
newDt | Time step used to reach this iteration. |
- Returns
- Reference to modified iteration.
◆ setTime()
template<typename T >
template Iteration & openPMD::Iteration::setTime< long double > |
( |
T |
newTime | ) |
|
Set the global reference time for this iteration.
- Template Parameters
-
T | Floating point type of user-selected precision (e.g. float, double). |
- Parameters
-
newTime | Global reference time for this iteration. |
- Returns
- Reference to modified iteration.
◆ setTimeUnitSI()
Iteration & openPMD::Iteration::setTimeUnitSI |
( |
double |
newTimeUnitSI | ) |
|
Set the conversion factor to convert time and dt to seconds.
- Parameters
-
newTimeUnitSI | new value for timeUnitSI |
- Returns
- Reference to modified iteration.
◆ time()
template<typename T >
T openPMD::Iteration::time |
|
inline |
- Template Parameters
-
T | Floating point type of user-selected precision (e.g. float, double). |
- Returns
- Global reference time for this iteration.
◆ timeUnitSI()
double openPMD::Iteration::timeUnitSI |
( |
| ) |
const |
- Returns
- Conversion factor to convert time and dt to seconds.
The documentation for this class was generated from the following files:
- /tmp/tmp.7iNmvGSbic/openPMD-api/include/openPMD/Iteration.hpp
- /tmp/tmp.7iNmvGSbic/openPMD-api/src/Iteration.cpp