Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document listen_feature_type in DiscreteControl / condition #1214

Merged
merged 1 commit into from
Mar 5, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions docs/core/usage.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -603,13 +603,14 @@ DiscreteControl is implemented based on [VectorContinuousCallback](https://docs.

The condition schema defines conditions of the form 'the discrete_control node with this node id listens to whether the given variable of the node with the given listen feature id is grater than the given value'. If the condition variable comes from a time-series, a look ahead $\Delta t$ can be supplied.

column | type | unit | restriction
----------------- | -------- | ------- | -----------
node_id | Int | - | sorted
listen_feature_id | Int | - | sorted per node_id
variable | String | - | must be "level" or "flow_rate", sorted per listen_feature_id
greater_than | Float64 | various | sorted per variable
look_ahead | Float64 | $s$ | Only on transient boundary conditions, non-negative (optional, default 0)
column | type | unit | restriction
------------------- | -------- | ------- | -----------
node_id | Int | - | sorted
listen_feature_id | Int | - | sorted per node_id
listen_feature_type | String | - | known node type
variable | String | - | must be "level" or "flow_rate", sorted per listen_feature_id
greater_than | Float64 | various | sorted per variable
look_ahead | Float64 | $s$ | Only on transient boundary conditions, non-negative (optional, default 0)

## DiscreteControl / logic

Expand Down
Loading