openPMD::Iteration Class Reference

Logical compilation of data from one snapshot (e.g. More...

#include <Iteration.hpp>

Inheritance diagram for openPMD::Iteration:

Collaboration diagram for openPMD::Iteration:

Public Member Functions
	Iteration (Iteration const &)
Iteration &	operator= (Iteration const &)
template<typename T >
T	time () const
template<typename T >
Iteration &	setTime (T newTime)
	Set the global reference time for this iteration. More...
template<typename T >
T	dt () const
template<typename T >
Iteration &	setDt (T newDt)
	Set the time step used to reach this iteration. More...
double	timeUnitSI () const
Iteration &	setTimeUnitSI (double newTimeUnitSI)
	Set the conversion factor to convert time and dt to seconds. More...
Public Member Functions inherited from openPMD::Attributable
	Attributable (Attributable const &)
	Attributable (Attributable &&)=delete
Attributable &	operator= (Attributable const &)
Attributable &	operator= (Attributable &&)=delete
Attribute	getAttribute (std::string const &key) const
	Retrieve value of Attribute stored with provided key. More...
bool	deleteAttribute (std::string const &key)
	Remove Attribute of provided value both logically and physically. More...
std::vector< std::string >	attributes () const
	List all currently stored Attributes' keys. More...
size_t	numAttributes () const
	Count all currently stored Attributes. More...
bool	containsAttribute (std::string const &key) const
	Check whether am Attribute with a given key exists. More...
std::string	comment () const
	Retrieve a user-supplied comment associated with the object. More...
Attributable &	setComment (std::string const &comment)
	Populate Attribute corresponding to a comment with the user-supplied comment. More...
template<typename T >
bool	setAttribute (std::string const &key, T const &value)
	Populate Attribute of provided name with provided value. More...
bool	setAttribute (std::string const &key, char const value[])

Public Attributes
Container< Mesh >	meshes
Container< ParticleSpecies >	particles

Friends
template<typename T , typename T_key , typename T_container >
class	Container
class	Series

Additional Inherited Members
Protected Member Functions inherited from openPMD::Attributable
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...
Protected Attributes inherited from openPMD::Attributable
std::shared_ptr< Writable >	m_writable
AbstractFilePosition *	abstractFilePosition
AbstractIOHandler *	IOHandler
Writable *	parent
bool &	dirty
bool &	written

Detailed Description

Logical compilation of data from one snapshot (e.g.

a single simulation cycle).

See also

https://github.com/openPMD/openPMD-standard/blob/latest/STANDARD.md#required-attributes-for-the-basepath

Member Function Documentation

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