38 #ifndef Foam_TimeState_H 39 #define Foam_TimeState_H 86 const scalar newValue,
const scalar & value() const noexcept
Return const reference to value.
dimensionedScalar deltaT0() const
Return old time step.
scalar deltaTValue() const noexcept
Return time step value.
The time value with time-stepping information, user-defined remapping, etc.
virtual ~TimeState()=default
Destructor.
void resetTimeState(const word &newName, const scalar newValue, const label newIndex)
Reset some of TimeState (name, value, index)
bool writeTime() const noexcept
True if this is a write interval.
const word & timeName() const noexcept
Return the current time name.
virtual scalar timeToUserTime(const scalar t) const
Convert the real-time (s) into user-time (e.g. CA deg)
bool outputTime() const noexcept
Deprecated(2016-05) return true if this is a write time.
virtual scalar userTimeToTime(const scalar theta) const
Convert the user-time (e.g. CA deg) to real-time (s).
A class for handling words, derived from Foam::string.
label timeIndex() const noexcept
Return the current time index.
scalar deltaT0Value() const noexcept
Return old time step value.
const word & name() const noexcept
Return const reference to name.
scalar timeOutputValue() const
Return the current user-time value. (ie, after applying any timeToUserTime() conversion) ...
TimeState()
Construct a zero time state, using the current time formatting.
dimensionedScalar deltaT() const
Return time step.