pywfm.IWFMModel.get_bypass_ids#
- IWFMModel.get_bypass_ids()#
Return the bypass identification numbers specified in an IWFM model
- Returns:
array of bypass IDs
- Return type:
np.ndarray
See also
IWFMModel.get_n_bypasses
Return the number of bypasses in an IWFM model
IWFMModel.get_bypass_export_nodes
Return the stream node IDs corresponding to bypass locations
IWFMModel.get_bypass_exports_destinations
Return stream node IDs and destination types and IDS where bypass flows are delivered
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_ids() array([1, 2]) >>> model.kill() >>> model.close_log_file()