pywfm.IWFMModel.get_output_interval#

IWFMModel.get_output_interval()#

Return a list of the possible time intervals a selected time-series data can be retrieved at.

Returns:: list of available output intervals for given data type
Return type:: list of strings

See also

IWFMModel.get_current_date_and_time: Return the current simulation date and time
IWFMModel.get_n_time_steps: Return the number of timesteps in an IWFM simulation
IWFMModel.get_time_specs: Return the IWFM simulation dates and time step
IWFMModel.get_n_intervals: Return the number of time intervals between a provided start date and end date
IWFMModel.is_date_greater: Return True if first_date is greater than comparison_date
IWFMModel.increment_time: increments the date provided by the specified time interval

Example

>>> from pywfm import IWFMModel
>>> pp_file = '../Preprocessor/PreProcessor_MAIN.IN'
>>> sim_file = 'Simulation_MAIN.IN'
>>> model = IWFMModel(pp_file, sim_file)
>>> model.get_output_interval()
['1DAY', '1WEEK', '1MON', '1YEAR']
>>> model.kill()
>>> model.close_log_file()