Skip to content

Commit

Permalink
Document listen_feature_type in DiscreteControl / condition (#1214)
Browse files Browse the repository at this point in the history
  • Loading branch information
Hofer-Julian committed Mar 5, 2024
1 parent a6c95ce commit c7204bc
Showing 1 changed file with 8 additions and 7 deletions.
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

0 comments on commit c7204bc

Please sign in to comment.