csdms

basic_modeling_interface.time module

Interface that describes the time stepping of a model.

class basic_modeling_interface.time.BmiTime[source]

Bases: object

Methods that get time information from a model.

Methods

get_current_time() Current time of the model.
get_end_time() End time of the model.
get_start_time() Start time of the model.
get_time_step() Current time step of the model.
get_time_units() Time units of the model.
get_current_time()[source]

Current time of the model.

Returns:

float

The current model time.

See also

get_start_time

Notes

/* C */
int get_current_time(void * self, double * time);
get_end_time()[source]

End time of the model.

Returns:

float

The maximum model time.

See also

get_start_time

Notes

/* C */
int get_end_time(void * self, double * time);
get_start_time()[source]

Start time of the model.

Model times should be of type float. The default model start time is 0.

Returns:

float

The model start time.

Notes

/* C */
int get_start_time(void * self, double * time);
get_time_step()[source]

Current time step of the model.

The model time step should be of type float. The default time step is 1.0.

Returns:

float

The time step used in model.

Notes

/* C */
int get_time_step(void * self, double * dt);
get_time_units()[source]

Time units of the model.

Returns:

float

The model time unit; e.g., days or s.

Notes

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