Time functions¶

These simple diagnostic functions provide information on model time. Model time is always expressed as a floating point value.

get_current_time¶

SIDL

int get_current_time(out double time);

Python

def get_current_time(self) -> float:

int get_current_time(void *self, double *time);

The current model time.

Implementation notes

In C++, Java, and Python, the argument is omitted and the time is returned from the function.
In C and Fortran, an integer status code indicating success (zero) or failure (nonzero) is returned.

get_start_time¶

SIDL

int get_start_time(out double time);

Python

def get_start_time(self) -> float:

int get_start_time(void *self, double *time);

The start time of the model.

Implementation notes

The start time in BMI is typically defined to be 0.0.
In C++, Java, and Python, the argument is omitted and the time is returned from the function.
In C and Fortran, an integer status code indicating success (zero) or failure (nonzero) is returned.

get_end_time¶

SIDL

int get_end_time(out double time);

Python

def get_end_time(self) -> float:

int get_end_time(void *self, double *time);

The end time of the model.

Implementation notes

If the model doesn’t define an end time, a large number (e.g., the largest floating point number supported on a platform) is typically chosen.
In C++, Java, and Python, the argument is omitted and the time is returned from the function.
In C and Fortran, an integer status code indicating success (zero) or failure (nonzero) is returned.

get_time_units¶

SIDL

int get_time_units(out string units);

Python

def get_time_units(self) -> str:

int get_time_units(void *self, char *units);

Get the units of time as reported by the model’s BMI (through get_current_time, get_end_time, etc.). It’s recommended to use [time unit conventions] from Unidata’s [UDUNITS] package; e.g., "s", "min", "h", "d".

Implementation notes

Avoid using "years" as a unit, if possible, since a year is difficult to define precisely. UDUNITS defines a year as 365.2422 days or 31556926 seconds.
Dimensionless quantities should use "" or "1" as the unit.
Models that don’t vary with time, or don’t have time units should use "none".
In C++, Java, and Python, the argument is omitted and the units are returned from the function as a string.
In C and Fortran, an integer status code indicating success (zero) or failure (nonzero) is returned.

get_time_step¶

SIDL

int get_time_step(out double time_step);

Python

def get_time_step(self) -> float:

int get_time_step(void *self, double *time_step);

Get the time step used in the model. The time step is always expressed as a floating point value.

Implementation notes

A time step is typically a positive value. However, if the model permits it, a negative value can be used (running the model backward).
In C++, Java, and Python, the argument is omitted and the time step is returned from the function.
In C and Fortran, an integer status code indicating success (zero) or failure (nonzero) is returned.