Skip to content

Commit

Permalink
Merge pull request #95 from alliander-opensource/bugfix/outputs-are-n…
Browse files Browse the repository at this point in the history
…ot-required

'Required' is not applicable to output fields
  • Loading branch information
bramstoeller authored Jul 14, 2022
2 parents 59b5a5d + ef57356 commit 6936484
Showing 1 changed file with 22 additions and 22 deletions.
44 changes: 22 additions & 22 deletions docs/graph-data-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ The base type for all power grid components.
| name | data type | unit | description | required | input | update | output |
| --- | --- | --- | --- | :---: | :---: | :---: | :---: |
| `id` | `int32_t` | - | ID of a component, the id should be unique along all components, i.e. you cannot have a node with `id` 5 and a line with `id` 5. | ✔ | ✔ | ❌ (id needs to be specified in the update query, but cannot be changed) | ✔ |
| `energized` | `int8_t` | - | Indicates if a component is energized, i.e. connected to a source | ✔ | ❌ | ❌ | ✔ |
| `energized` | `int8_t` | - | Indicates if a component is energized, i.e. connected to a source | | ❌ | ❌ | ✔ |

## Node

Expand All @@ -163,9 +163,9 @@ The base type for all power grid components.
| name | data type | unit | description | required | input | update | output | valid values |
| --- | --- | --- | --- | :---: | :---: | :---: | :---: | :---: |
| `u_rated` | `double` | volt (V) | rated line-line voltage | ✔ | ✔ | ❌ | ❌ | `> 0` |
| `u_pu` | `RealValueOutput` | - | per-unit voltage magnitude | ✔ | ❌ | ❌ | ✔ | |
| `u_angle` | `RealValueOutput` | rad | voltage angle | ✔ | ❌ | ❌ | ✔ | |
| `u` | `RealValueOutput` | volt (V) | voltage magnitude, line-line for symmetric calculation, line-neutral for asymmetric calculation | ✔ | ❌ | ❌ | ✔ | |
| `u_pu` | `RealValueOutput` | - | per-unit voltage magnitude | | ❌ | ❌ | ✔ | |
| `u_angle` | `RealValueOutput` | rad | voltage angle | | ❌ | ❌ | ✔ | |
| `u` | `RealValueOutput` | volt (V) | voltage magnitude, line-line for symmetric calculation, line-neutral for asymmetric calculation | | ❌ | ❌ | ✔ | |


## Branch
Expand All @@ -184,15 +184,15 @@ In this case, the attribute `from_status` and `to_status` is always 1.
| `to_node` | `int32_t` | - | ID of node at to-side | ✔ | ✔ | ❌ | ❌ | a valid node id |
| `from_status` | `int8_t` | - | connection status at from-side | ✔ | ✔ | ✔ | ❌ | `0` or `1` |
| `to_status` | `int8_t` | - | connection status at to-side | ✔ | ✔ | ✔ | ❌ | `0` or `1` |
| `p_from` | `RealValueOutput` | watt (W) | active power flowing into the branch at from-side | ✔ | ❌ | ❌ | ✔ | |
| `q_from` | `RealValueOutput` | volt-ampere-reactive (var) | reactive power flowing into the branch at from-side | ✔ | ❌ | ❌ | ✔ | |
| `i_from` | `RealValueOutput` | ampere (A) | current at from-side | ✔ | ❌ | ❌ | ✔ | |
| `s_from` | `RealValueOutput` | volt-ampere (VA) | apparent power flowing at from-side | ✔ | ❌ | ❌ | ✔ | |
| `p_to` | `RealValueOutput` | watt (W) | active power flowing into the branch at to-side | ✔ | ❌ | ❌ | ✔ | |
| `q_to` | `RealValueOutput` | volt-ampere-reactive (var) | reactive power flowing into the branch at to-side | ✔ | ❌ | ❌ | ✔ | |
| `i_to` | `RealValueOutput` | ampere (A) | current at to-side | ✔ | ❌ | ❌ | ✔ | |
| `s_to` | `RealValueOutput` | volt-ampere (VA) | apparent power flowing at to-side | ✔ | ❌ | ❌ | ✔ | |
| `loading` | `double` | - | relative loading of the line, `1.0` meaning 100% loaded. | ✔ | ❌ | ❌ | ✔ | |
| `p_from` | `RealValueOutput` | watt (W) | active power flowing into the branch at from-side | | ❌ | ❌ | ✔ | |
| `q_from` | `RealValueOutput` | volt-ampere-reactive (var) | reactive power flowing into the branch at from-side | | ❌ | ❌ | ✔ | |
| `i_from` | `RealValueOutput` | ampere (A) | current at from-side | | ❌ | ❌ | ✔ | |
| `s_from` | `RealValueOutput` | volt-ampere (VA) | apparent power flowing at from-side | | ❌ | ❌ | ✔ | |
| `p_to` | `RealValueOutput` | watt (W) | active power flowing into the branch at to-side | | ❌ | ❌ | ✔ | |
| `q_to` | `RealValueOutput` | volt-ampere-reactive (var) | reactive power flowing into the branch at to-side | | ❌ | ❌ | ✔ | |
| `i_to` | `RealValueOutput` | ampere (A) | current at to-side | | ❌ | ❌ | ✔ | |
| `s_to` | `RealValueOutput` | volt-ampere (VA) | apparent power flowing at to-side | | ❌ | ❌ | ✔ | |
| `loading` | `double` | - | relative loading of the line, `1.0` meaning 100% loaded. | | ❌ | ❌ | ✔ | |


### Line
Expand Down Expand Up @@ -275,11 +275,11 @@ For each `appliance` a switch is defined between the `appliance` and the `node`.
| --- | --- | --- | --- | :---: | :---: | :---: | :---: | :---: |
| `node` | `int32_t` | - | ID of the coupled node | ✔ | ✔ | ❌ | ❌ | a valid node id |
| `status` | `int8_t` | - | connection status to the node | ✔ | ✔ | ✔ | ❌ | `0` or `1` |
| `p` | `RealValueOutput` | watt (W) | active power | ✔ | ❌ | ❌ | ✔ | |
| `q` | `RealValueOutput` | volt-ampere-reactive (var) | reactive power | ✔ | ❌ | ❌ | ✔ | |
| `i` | `RealValueOutput` | ampere (A) | current | ✔ | ❌ | ❌ | ✔ | |
| `s` | `RealValueOutput` | volt-ampere (VA) | apparent power | ✔ | ❌ | ❌ | ✔ | |
| `pf` | `RealValueOutput` | - | power factor | ✔ | ❌ | ❌ | ✔ | |
| `p` | `RealValueOutput` | watt (W) | active power | | ❌ | ❌ | ✔ | |
| `q` | `RealValueOutput` | volt-ampere-reactive (var) | reactive power | | ❌ | ❌ | ✔ | |
| `i` | `RealValueOutput` | ampere (A) | current | | ❌ | ❌ | ✔ | |
| `s` | `RealValueOutput` | volt-ampere (VA) | apparent power | | ❌ | ❌ | ✔ | |
| `pf` | `RealValueOutput` | - | power factor | | ❌ | ❌ | ✔ | |

### Source

Expand Down Expand Up @@ -387,8 +387,8 @@ The table below shows a list of attributes.
| --- | --- | --- | --- | :---: | :---: | :---: | :---: | :---: |
| `u_measured` | `RealValueInput` | volt (V) | measured voltage magnitude | ✨ only for state estimation | ✔ | ✔ | ❌ | `> 0` |
| `u_angle_measured` | `RealValueInput` | rad | measured voltage angle (only possible with phasor measurement units) |❌ | ✔ | ✔ | ❌ | |
| `u_residual` | `RealValueOutput` | volt (V) | residual value between measured voltage magnitude and calculated voltage magnitude | ✔ | ❌ | ❌ | ✔ | |
| `u_angle_residual` | `RealValueOutput` | rad | residual value between measured voltage angle and calculated voltage angle (only possible with phasor measurement units) | ❌ | ❌ | ❌ | ✔ | |
| `u_residual` | `RealValueOutput` | volt (V) | residual value between measured voltage magnitude and calculated voltage magnitude | | ❌ | ❌ | ✔ | |
| `u_angle_residual` | `RealValueOutput` | rad | residual value between measured voltage angle and calculated voltage angle (only possible with phasor measurement units) | | ❌ | ❌ | ✔ | |


### Generic Power Sensor
Expand Down Expand Up @@ -427,5 +427,5 @@ The table below shows a list of attributes.
| --- | --- | --- | --- | :---: | :---: | :---: | :---: |
| `p_measured` | `RealValueInput` | watt (W) | measured active power | ✨ only for state estimation | ✔ | ✔ | ❌ |
| `q_measured` | `RealValueInput` | volt-ampere-reactive (var) | measured reactive power | ✨ only for state estimation | ✔ | ✔ | ❌ |
| `p_residual` | `RealValueOutput` | watt (W) | residual value between measured active power and calculated active power | ✔ | ❌ | ❌ | ✔ |
| `q_residual` | `RealValueOutput` | volt-ampere-reactive (var) | residual value between measured reactive power and calculated reactive power | ✔ | ❌ | ❌ | ✔ |
| `p_residual` | `RealValueOutput` | watt (W) | residual value between measured active power and calculated active power | | ❌ | ❌ | ✔ |
| `q_residual` | `RealValueOutput` | volt-ampere-reactive (var) | residual value between measured reactive power and calculated reactive power | | ❌ | ❌ | ✔ |

0 comments on commit 6936484

Please sign in to comment.