pywfm.IWFMModel.set_supply_adjustment_tolerance#

IWFMModel.set_supply_adjustment_tolerance(tolerance)#

sets the tolerance, given as a fraction of the water demand that will be used in automatic supply adjustment

Parameters:

tolerance (float) – fraction of water demand used as the convergence criteria for iterative supply adjustment

Note

When the automatic supply adjustment feature of IWFM is turned on, IWFM iteratively tries to adjust water supplies (diversions, pumping or both based on user defined specifications) to meet the water demand. When the difference between water supply and demand is less than the tolerance, IWFM assumes equivalency between demand and supply, and terminates supply adjustment iterations.

0.01 represents 1% of the demand