pywfm.IWFMModel.get_supply_requirement_urban_elements#

IWFMModel.get_supply_requirement_urban_elements(elements='all', conversion_factor=1.0)#

Return the urban supply requirement for one or more model elements

Parameters:

elements (int, list, tuple, np.ndarray, or str='all', default='all') – one or more element identification numbers used to return the urban supply requirement
conversion_factor (float, default=1.0) – factor to convert urban supply requirement from model units to desired output units

Returns:

array of urban supply requirement for elements specified

Return type:

np.ndarray

Note

This method is intended to be used during a model simulation (is_for_inquiry=0)