pywfm.IWFMModel.read_timeseries_data_overwrite#

IWFMModel.read_timeseries_data_overwrite(land_use_areas, diversion_ids, diversions, stream_inflow_ids, stream_inflows)#

reads time series data for the current simulation time step and allows overwriting certain time series data

Parameters:
  • land_use_areas (list or np.ndarray) – subregional land use areas to be overwritten for the current time step order is non-ponded first, then ponded, then urban, then native, and riparian

  • diversion_ids (list or np.ndarray) – diversion identification numbers to be overwritten

  • diversions (list or np.ndarray) – diversion amounts to overwrite for each diversion identification number provided. must be same length as diversion_ids

  • stream_inflow_ids (list or np.ndarray) – stream inflow indices where boundary inflows will be overwritten

  • stream_inflows (list or np.ndarray) – stream inflow amounts to be overwritten for each stream flow index provided. Must be the same length as stream_inflow_ids

Return type:

None

Note

This method is intended to be used when is_for_inquiry=0 during a model simulation

See also

IWFMModel.read_timeseries_data

reads in all of the time series data for the current simulation time step