pywfm.IWFMModel.get_actual_stream_diversions_at_some_locations#

IWFMModel.get_actual_stream_diversions_at_some_locations(diversion_locations='all', diversion_conversion_factor=1.0)#

Return actual diversion amounts for a list of diversions during a model simulation

Parameters:

diversion_locations (int, list, tuple, np.ndarray, or str='all', default='all') – one or more diversion ids where actual diversions are returned.
diversion_conversion_factor (float, default=1.0) – conversion factor for actual diversions from the simulation unit of volume to a desired unit of volume

Returns:

actual diversions for the diversion ids provided

Return type:

np.ndarray

Note

This method is designed for use when is_for_inquiry=0 to return actual diversions amounts for selected diversion locations at the current timestep during a simulation.

Actual diversion amounts can be less than the required diversion amount if stream goes dry at the stream node where the diversion occurs

See also

IWFMModel.get_stream_tributary_inflows: Return small watershed inflows at every stream node for the current timestep
IWFMModel.get_stream_rainfall_runoff: Return rainfall runoff at every stream node for the current timestep
IWFMModel.get_stream_return_flows: Return agricultural and urban return flows at every stream node for the current timestep
IWFMModel.get_stream_pond_drains: Return drainage from rice and refuge ponds into every stream node for the current timestep
IWFMModel.get_stream_tile_drain_flows: Return tile drain flows into every stream node for the current timestep
IWFMModel.get_stream_riparian_evapotranspiration: Return riparian evapotranspiration from every stream node for the current timestep
IWFMModel.get_stream_gain_from_groundwater: Return gain from groundwater for every stream node for the current timestep
IWFMModel.get_stream_gain_from_lakes: Return gain from lakes for every stream node for the current timestep
IWFMModel.get_net_bypass_inflows: Return net bypass inflows for every stream node for the current timestep