evaluate_maximum_velocity#

module wntr.extensions.design_verification.constraints

evaluate_maximum_velocity(velocity, maximum_velocity_mps, required_compliance_pct=100.0, velocity_tolerance_mps=0.0)[source]#

Evaluate maximum absolute pipe-velocity compliance.

Parameters:

  • velocity (pd.DataFrame) – Pipe-velocity results. Rows represent simulation times and columns represent pipe names.

  • maximum_velocity_mps (float) – Maximum allowable absolute velocity in metres per second.

  • required_compliance_pct (float, optional) – Percentage of pipe-time values required to satisfy the velocity limit.

  • velocity_tolerance_mps (float, optional) – Non-negative numerical tolerance applied above the maximum absolute velocity limit. The default of zero preserves strict comparison behaviour.

Returns:

Velocity-compliance result and critical location.

Return type:

ConstraintResult