pywfm.IWFMModel.get_bypass_outflows#

IWFMModel.get_bypass_outflows(bypass_conversion_factor=1.0)#

Return the bypass outflows for the current simulation timestep

Parameters:

bypass_conversion_factor (float, default=1.0) –

Returns:

bypass outflows for the current simulation timestep

Return type:

np.ndarray

Note

This method is intended to be used when is_for_inquiry=0 when performing a model simulation

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_exports_destinations

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

IWFMModel.get_bypass_recoverable_loss_factor

Return the recoverable loss factor for a bypass

IWFMModel.get_bypass_nonrecoverable_loss_factor

Return the nonrecoverable loss factor for a bypass