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 | Series |
|
|
void | flushAttributes () |
|
void | readAttributes () |
|
template<typename T > |
T | readFloatingpoint (std::string const &key) const |
| Retrieve the value of a floating point Attribute of user-defined precision with ensured type-safety. More...
|
|
template<typename T > |
std::vector< T > | readVectorFloatingpoint (std::string const &key) const |
| Retrieve a vector of values of a floating point Attributes of user-defined precision with ensured type-safety. More...
|
|
std::shared_ptr< Writable > | m_writable |
|
AbstractFilePosition * | abstractFilePosition |
|
AbstractIOHandler * | IOHandler |
|
Writable * | parent |
|
bool & | dirty |
|
bool & | written |
|
◆ dt()
template<typename T >
T openPMD::Iteration::dt |
( |
| ) |
const |
|
inline |
- Template Parameters
-
T | Floating point type of user-selected precision (e.g. float, double). |
- Returns
- Time step used to reach this 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 |
( |
| ) |
const |
|
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:
- /home/docs/checkouts/readthedocs.org/user_builds/openpmd-api/checkouts/0.11.1-alpha/include/openPMD/Iteration.hpp
- /home/docs/checkouts/readthedocs.org/user_builds/openpmd-api/checkouts/0.11.1-alpha/src/Iteration.cpp