Skip to main content

SimulationTime

Struct SimulationTime 

Source
pub struct SimulationTime { /* private fields */ }
Expand description

The temporal coordinate associated with one SystemState.

iteration is always present and provides deterministic ordering, chunk boundaries, and checkpoint identity. physical_time optionally records a finite domain time such as seconds or model time. Time-axis units belong to stream metadata so they are not repeated in every state.

Implementations§

Source§

impl SimulationTime

Source

pub const fn from_iteration(iteration: u64) -> Self

Creates an iteration-only time point.

Source

pub fn from_iteration_and_physical_time( iteration: u64, physical_time: f64, ) -> Option<Self>

Creates a time point with a finite physical coordinate.

Returns None for NaN or either infinity. Negative finite values are accepted because some scientific coordinate systems use an origin after the beginning of a simulation or observation.

Source

pub const fn iteration(self) -> u64

Returns the deterministic iteration coordinate.

Source

pub const fn physical_time(self) -> Option<f64>

Returns the optional physical coordinate.

Source

pub fn checked_advance( self, physical_time_increment: Option<f64>, ) -> Result<Self, StateError>

Computes the next scientific time without mutating a state.

None advances only the iteration and preserves the optional physical coordinate. Some(delta) also advances an existing physical coordinate. All overflow and finiteness checks are identical to SystemState::advance_simulation_time.

Trait Implementations§

Source§

impl Clone for SimulationTime

Source§

fn clone(&self) -> SimulationTime

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for SimulationTime

Source§

impl Debug for SimulationTime

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl PartialEq for SimulationTime

Source§

fn eq(&self, other: &SimulationTime) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SimulationTime

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.