pywfm.IWFMModel.get_diversion_ids

IWFMModel.get_diversion_ids()

Return the surface water diversion identification numbers specified in an IWFM model

Returns:

array of diversion IDs

Return type:

np.ndarray

See also

IWFMModel.get_n_diversions

Return the number of surface water diversions in an IWFM model

IWFMModel.get_stream_diversion_locations

Return the stream node IDs corresponding to diversion locations

Example

>>> from pywfm import IWFMModel
>>> pp_file = '../Preprocessor/PreProcessor_MAIN.IN'
>>> sim_file = 'Simulation_MAIN.IN'
>>> model = IWFMModel(pp_file, sim_file)
>>> model.get_diversion_ids()
array([1, 2, 3, 4, 5])
>>> model.kill()
>>> model.close_log_file()