pywfm.IWFMModel.get_bypass_exports_destinations#

IWFMModel.get_bypass_exports_destinations(bypass_list)#

Return stream node IDs and destination types and IDS where bypass flows are delivered.

Parameters:

bypass_list (int, list, or np.ndarray) – one or more bypass IDs

Returns:

export_stream_nodes (np.ndarray) – stream node IDs where bypasses occur
destination_types (np.ndarray) – destination type flags used by IWFM
destination_ids (np.ndarray) – destination ID for each bypass

See also

IWFMModel.get_n_bypasses: Return the number of bypasses in an IWFM model
IWFMModel.get_bypass_ids: Return the bypass identification numbers specified in an IWFM model
IWFMModel.get_bypass_export_nodes: Return the stream node IDs corresponding to bypass locations
IWFMModel.get_bypass_outflows: Return the bypass outflows for the current simulation timestep
IWFMModel.get_bypass_recoverable_loss_factor: Return the recoverable loss factor for a bypass
IWFMModel.get_bypass_recoverable_loss_factor: Return the nonrecoverable loss factor for a bypass

Example

>>> from pywfm import IWFMModel
>>> pp_file = '../Preprocessor/PreProcessor_MAIN.IN'
>>> sim_file = 'Simulation_MAIN.IN'
>>> model = IWFMModel(pp_file, sim_file)
>>> model.get_bypass_exports_destinations(1)
(array([13, 17]), array([0, 1]), array([ 0, 22]))
>>> model.kill()
>>> model.close_log_file()