audit_head_pump_curves#

module wntr.extensions.design_verification.pumps

audit_head_pump_curves(network, flowrate, *, status=None, setting=None, relative_tolerance=1e-09)[source]#

Audit every head pump against the maximum flow in its curve.

Pump affinity scaling is respected by multiplying the maximum curve-point flow by the pump speed reported in the hydraulic setting result. When no setting result is supplied, the pump’s configured base speed is used.

Parameters:

  • network (WaterNetworkModel) – WNTR water-network model used for the simulation.

  • flowrate (pd.DataFrame) – Link-flowrate results indexed by simulation time.

  • status (pd.DataFrame or None, optional) – Optional link-status results. Positive values are treated as active.

  • setting (pd.DataFrame or None, optional) – Optional link-setting results. For pumps, this represents speed.

  • relative_tolerance (float, optional) – Relative numerical tolerance applied to the curve-domain limit.