pywfm.IWFMModel.get_stream_diversion_locations#

IWFMModel.get_stream_diversion_locations(diversion_locations='all')#

Return the stream node IDs corresponding to diversion locations

Parameters:: diversion_locations (int, list, tuple, np.ndarray, str='all', default='all') – one or more diversion IDs used to return the corresponding stream node ID
Returns:: array of stream node IDs corresponding to where diversions are exported
Return type:: np.ndarray

See also

IWFMModel.get_n_diversions: Return the number of surface water diversions in an IWFM model
IWFMModel.get_diversion_ids: Return the surface water diversion identification numbers specified in an IWFM model

Example

>>> from pywfm import IWFMModel
>>> pp_file = '../Preprocessor/PreProcessor_MAIN.IN'
>>> sim_file = 'Simulation_MAIN.IN'
>>> model = IWFMModel(pp_file, sim_file)
>>> model.get_stream_diversion_locations()
array([ 9, 12, 12, 22, 0])
>>> model.kill()
>>> model.close_log_file()