solve
Read-only
Determine the steady operating point of a water-handling system and retrieve measured values, component modes, warnings, and control loop states.
Instructions
Solve the steady operating point.
Returns the selected values with units (6 significant digits; pressures carry their reference, port pressures are bar gauge), the mode of every instance, component warnings and non-fatal pre-flight issues. Fails with the list of errors when check_system reports any. Controls: PI actuators are set to hold their setpoints, hysteresis switches hold their state; controls reports each loop (output, measured, setpoint, error, saturated or state).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| units | No | Unit per path, e.g. {'v.volume_flow': 'L/s', 'mains.port.p': 'bar absolute'}; a key '*.<name>' matches every path ending in '.<name>'. | |
| system_id | Yes | ||
| variables | No | Paths ('v.volume_flow', 'v.port_a.p'), instance names, 'control' or '*'. Default: observables, states, port pressures and control results. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| modes | Yes | ||
| issues | Yes | ||
| values | Yes | ||
| controls | No | ||
| warnings | Yes | ||
| converged | Yes | ||
| system_id | Yes | ||
| iterations | Yes | ||
| max_residual | Yes |