Skip to content

Commit

Permalink
Remove confusing sentence for PidControl (#1009)
Browse files Browse the repository at this point in the history
People are reading this as if the outneighbor of a PidControl can only
be a Pump, but that is not the case. Since it's quite a detailed and
perhaps obvious point, this removes the extra line.
  • Loading branch information
visr authored Feb 2, 2024
1 parent f721804 commit 21d54c0
Showing 1 changed file with 0 additions and 2 deletions.
2 changes: 0 additions & 2 deletions docs/core/usage.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -655,8 +655,6 @@ control_state | String

The PidControl node controls the level in a basin by continuously controlling the flow rate of a connected pump or outlet. See also [PID controller](https://en.wikipedia.org/wiki/PID_controller). When A PidControl node is made inactive, the node under its control retains the last flow rate value, and the error integral is reset to 0.

The pump must be an outneighbor of the controlled basin, the outlet must be an inneighbor. Thus for the same coefficient values in `proportional`, `integral` and `derivative`, the pump and outlet have the oppositve effect on the controlled basin.

In the future controlling the flow on a particular edge could be supported.

column | type | unit | restriction
Expand Down

0 comments on commit 21d54c0

Please sign in to comment.