Skip to content

Commit 193a1be

Browse files
ckittlckittl
authored
Merge pull request #373 from ie3-institute/to/#371-clarify-parallelDevices-param
To/#371 clarify parallel devices param
2 parents b646725 + 346b90f commit 193a1be

File tree

9 files changed

+80
-62
lines changed

9 files changed

+80
-62
lines changed

‎docs/readthedocs/gettingstarted.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ On `Maven central <https://search.maven.org/artifact/com.github.ie3-institute/Po
2525
<dependency>
2626
<groupId>com.github.ie3-institute</groupId>
2727
<artifactId>PowerSystemDataModel</artifactId>
28-
<version>1.1.0</version>
28+
<version>2.0.0</version>
2929
</dependency>
3030
3131
Snapshot releases

‎docs/readthedocs/models/input/grid/line.rst‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@ Entity Model
4848
+-------------------+------+--------------------------------------------------------+
4949
| nodeB | -- | |
5050
+-------------------+------+--------------------------------------------------------+
51-
| parallelDevices | -- | Amount of parallel devices of same attributes |
51+
| parallelDevices | -- | | overall amount of parallel lines to automatically |
52+
| | -- | | construct (e.g. parallelDevices = 2 will build a |
53+
| | -- | | total of two lines using the specified parameters) |
5254
+-------------------+------+--------------------------------------------------------+
5355
| type | -- | |
5456
+-------------------+------+--------------------------------------------------------+

‎docs/readthedocs/models/input/grid/transformer2w.rst‎

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -50,29 +50,31 @@ As obvious, the parameter can be used in T- as in 𝜋-equivalent circuit repres
5050
Entity Model
5151
""""""""""""
5252

53-
+-----------------+------+--------------------------------------------------------+
54-
| Attribute | Unit | Remarks |
55-
+=================+======+========================================================+
56-
| uuid | -- | |
57-
+-----------------+------+--------------------------------------------------------+
58-
| id | -- | Human readable identifier |
59-
+-----------------+------+--------------------------------------------------------+
60-
| operator | -- | |
61-
+-----------------+------+--------------------------------------------------------+
62-
| operationTime | -- | Timely restriction of operation |
63-
+-----------------+------+--------------------------------------------------------+
64-
| nodeA | -- | Higher voltage node |
65-
+-----------------+------+--------------------------------------------------------+
66-
| nodeB | -- | Lower voltage node |
67-
+-----------------+------+--------------------------------------------------------+
68-
| parallelDevices | -- | Amount of parallel devices of same attributes |
69-
+-----------------+------+--------------------------------------------------------+
70-
| type | -- | |
71-
+-----------------+------+--------------------------------------------------------+
72-
| tapPos | -- | Current position of the tap changer |
73-
+-----------------+------+--------------------------------------------------------+
74-
| autoTap | -- | true, if there is a tap regulation apparent and active |
75-
+-----------------+------+--------------------------------------------------------+
53+
+-----------------+------+------------------------------------------------------------+
54+
| Attribute | Unit | Remarks |
55+
+=================+======+============================================================+
56+
| uuid | -- | |
57+
+-----------------+------+------------------------------------------------------------+
58+
| id | -- | Human readable identifier |
59+
+-----------------+------+------------------------------------------------------------+
60+
| operator | -- | |
61+
+-----------------+------+------------------------------------------------------------+
62+
| operationTime | -- | Timely restriction of operation |
63+
+-----------------+------+------------------------------------------------------------+
64+
| nodeA | -- | Higher voltage node |
65+
+-----------------+------+------------------------------------------------------------+
66+
| nodeB | -- | Lower voltage node |
67+
+-----------------+------+------------------------------------------------------------+
68+
| parallelDevices | -- | | overall amount of parallel transformers to automatically |
69+
| | -- | | construct (e.g. parallelDevices = 2 will build a |
70+
| | -- | | total of two transformers using the specified parameters)|
71+
+-----------------+------+------------------------------------------------------------+
72+
| type | -- | |
73+
+-----------------+------+------------------------------------------------------------+
74+
| tapPos | -- | Current position of the tap changer |
75+
+-----------------+------+------------------------------------------------------------+
76+
| autoTap | -- | true, if there is a tap regulation apparent and active |
77+
+-----------------+------+------------------------------------------------------------+
7678

7779
Caveats
7880
^^^^^^^

‎docs/readthedocs/models/input/grid/transformer3w.rst‎

Lines changed: 27 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -70,31 +70,33 @@ All impedances and admittances are given with respect to the higher voltage side
7070
Entity Model
7171
""""""""""""
7272

73-
+-----------------+------+--------------------------------------------------------+
74-
| Attribute | Unit | Remarks |
75-
+=================+======+========================================================+
76-
| uuid | -- | |
77-
+-----------------+------+--------------------------------------------------------+
78-
| id | -- | Human readable identifier |
79-
+-----------------+------+--------------------------------------------------------+
80-
| operator | -- | |
81-
+-----------------+------+--------------------------------------------------------+
82-
| operationTime | -- | Timely restriction of operation |
83-
+-----------------+------+--------------------------------------------------------+
84-
| nodeA | -- | Higher voltage node |
85-
+-----------------+------+--------------------------------------------------------+
86-
| nodeB | -- | Intermediate voltage node |
87-
+-----------------+------+--------------------------------------------------------+
88-
| nodeC | -- | Lowest voltage node |
89-
+-----------------+------+--------------------------------------------------------+
90-
| parallelDevices | -- | Amount of parallel devices of same attributes |
91-
+-----------------+------+--------------------------------------------------------+
92-
| type | -- | |
93-
+-----------------+------+--------------------------------------------------------+
94-
| tapPos | -- | Current position of the tap changer |
95-
+-----------------+------+--------------------------------------------------------+
96-
| autoTap | -- | true, if there is a tap regulation apparent and active |
97-
+-----------------+------+--------------------------------------------------------+
73+
+-----------------+------+------------------------------------------------------------+
74+
| Attribute | Unit | Remarks |
75+
+=================+======+============================================================+
76+
| uuid | -- | |
77+
+-----------------+------+------------------------------------------------------------+
78+
| id | -- | Human readable identifier |
79+
+-----------------+------+------------------------------------------------------------+
80+
| operator | -- | |
81+
+-----------------+------+------------------------------------------------------------+
82+
| operationTime | -- | Timely restriction of operation |
83+
+-----------------+------+------------------------------------------------------------+
84+
| nodeA | -- | Higher voltage node |
85+
+-----------------+------+------------------------------------------------------------+
86+
| nodeB | -- | Intermediate voltage node |
87+
+-----------------+------+------------------------------------------------------------+
88+
| nodeC | -- | Lowest voltage node |
89+
+-----------------+------+------------------------------------------------------------+
90+
| parallelDevices | -- | | overall amount of parallel transformers to automatically |
91+
| | -- | | construct (e.g. parallelDevices = 2 will build a |
92+
| | -- | | total of two transformers using the specified parameters)|
93+
+-----------------+------+------------------------------------------------------------+
94+
| type | -- | |
95+
+-----------------+------+------------------------------------------------------------+
96+
| tapPos | -- | Current position of the tap changer |
97+
+-----------------+------+------------------------------------------------------------+
98+
| autoTap | -- | true, if there is a tap regulation apparent and active |
99+
+-----------------+------+------------------------------------------------------------+
98100

99101
Caveats
100102
^^^^^^^

‎src/main/java/edu/ie3/datamodel/models/input/connector/ConnectorInput.java‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ public abstract class ConnectorInput extends AssetInput implements HasNodes {
3030
* @param operationTime Time for which the entity is operated
3131
* @param nodeA Grid node at one side of the connector
3232
* @param nodeB Grid node at the other side of the connector
33-
* @param parallelDevices Amount of parallel devices
33+
* @param parallelDevices overall amount of parallel devices to automatically construct (e.g.
34+
* parallelDevices = 2 will build a total of two entities using the specified parameters)
3435
*/
3536
public ConnectorInput(
3637
UUID uuid,
@@ -53,7 +54,8 @@ public ConnectorInput(
5354
* @param id of the asset
5455
* @param nodeA Grid node at one side of the connector
5556
* @param nodeB Grid node at the other side of the connector
56-
* @param parallelDevices Amount of parallel devices
57+
* @param parallelDevices overall amount of parallel devices to automatically construct (e.g.
58+
* parallelDevices = 2 will build a total of two entities using the specified parameters)
5759
*/
5860
public ConnectorInput(
5961
UUID uuid, String id, NodeInput nodeA, NodeInput nodeB, int parallelDevices) {

‎src/main/java/edu/ie3/datamodel/models/input/connector/LineInput.java‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,8 @@ public class LineInput extends ConnectorInput implements HasType {
4343
* @param operationTime Time for which the entity is operated
4444
* @param nodeA Grid node at one side of the line
4545
* @param nodeB Grid node at the other side of the line
46-
* @param parallelDevices Amount of parallel lines
46+
* @param parallelDevices overall amount of parallel lines to automatically construct (e.g.
47+
* parallelDevices = 2 will build a total of two lines using the specified parameters)
4748
* @param type of line
4849
* @param length of this line
4950
* @param geoPosition Coordinates of this line
@@ -75,7 +76,8 @@ public LineInput(
7576
* @param id of the asset
7677
* @param nodeA Grid node at one side of the line
7778
* @param nodeB Grid node at the other side of the line
78-
* @param parallelDevices Amount of parallel lines
79+
* @param parallelDevices overall amount of parallel lines to automatically construct (e.g.
80+
* parallelDevices = 2 will build a total of two lines using the specified parameters)
7981
* @param type of line
8082
* @param length of this line
8183
* @param geoPosition Coordinates of this line

‎src/main/java/edu/ie3/datamodel/models/input/connector/Transformer2WInput.java‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ public class Transformer2WInput extends TransformerInput implements HasType {
3030
* @param operationTime Time for which the entity is operated
3131
* @param nodeA higher voltage node
3232
* @param nodeB lower voltage node
33-
* @param parallelDevices Amount of singular transformers
33+
* @param parallelDevices overall amount of parallel transformers to automatically construct (e.g.
34+
* parallelDevices = 2 will build a total of two transformers using the specified parameters)
3435
* @param type of 2W transformer
3536
* @param tapPos Tap position of this transformer
3637
* @param autoTap True, if the tap position of the transformer is adapted automatically
@@ -57,7 +58,8 @@ public Transformer2WInput(
5758
* @param id of the asset
5859
* @param nodeA higher voltage node
5960
* @param nodeB lower voltage node
60-
* @param parallelDevices Amount of singular transformers
61+
* @param parallelDevices overall amount of parallel transformers to automatically construct (e.g.
62+
* parallelDevices = 2 will build a total of two transformers using the specified parameters)
6163
* @param type of 2W transformer
6264
* @param tapPos Tap position of this transformer
6365
* @param autoTap True, if the tap position of the transformer is adapted automatically

‎src/main/java/edu/ie3/datamodel/models/input/connector/Transformer3WInput.java‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ public class Transformer3WInput extends TransformerInput implements HasType {
3737
* @param nodeA The higher voltage node
3838
* @param nodeB The middle voltage node
3939
* @param nodeC The lower voltage node
40-
* @param parallelDevices Amount of singular transformers
40+
* @param parallelDevices overall amount of parallel transformers to automatically construct (e.g.
41+
* parallelDevices = 2 will build a total of two transformers using the specified parameters)
4142
* @param type of 3W transformer
4243
* @param tapPos Tap Position of this transformer
4344
* @param autoTap true, if there is an automated regulation activated for this transformer
@@ -85,7 +86,8 @@ public Transformer3WInput(
8586
* @param nodeA The higher voltage node
8687
* @param nodeB The middle voltage node
8788
* @param nodeC The lower voltage node
88-
* @param parallelDevices Amount of singular transformers
89+
* @param parallelDevices overall amount of parallel transformers to automatically construct (e.g.
90+
* parallelDevices = 2 will build a total of two transformers using the specified parameters)
8991
* @param type of 3W transformer
9092
* @param tapPos Tap Position of this transformer
9193
* @param autoTap true, if there is an automated regulation activated for this transformer
@@ -136,7 +138,8 @@ public Transformer3WInput(
136138
* @param nodeA The higher voltage node
137139
* @param nodeB The middle voltage node
138140
* @param nodeC The lower voltage node
139-
* @param parallelDevices Amount of singular transformers
141+
* @param parallelDevices overall amount of parallel transformers to automatically construct (e.g.
142+
* parallelDevices = 2 will build a total of two transformers using the specified parameters)
140143
* @param type of 3W transformer
141144
* @param tapPos Tap Position of this transformer
142145
* @param autoTap true, if there is an automated regulation activated for this transformer
@@ -177,7 +180,8 @@ public Transformer3WInput(
177180
* @param nodeA The higher voltage node
178181
* @param nodeB The middle voltage node
179182
* @param nodeC The lower voltage node
180-
* @param parallelDevices Amount of singular transformers
183+
* @param parallelDevices overall amount of parallel transformers to automatically construct (e.g.
184+
* parallelDevices = 2 will build a total of two transformers using the specified parameters)
181185
* @param type of 3W transformer
182186
* @param tapPos Tap Position of this transformer
183187
* @param autoTap true, if there is an automated regulation activated for this transformer

‎src/main/java/edu/ie3/datamodel/models/input/connector/TransformerInput.java‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ public abstract class TransformerInput extends ConnectorInput {
2727
* @param id of the asset
2828
* @param nodeA Grid node at the high voltage winding
2929
* @param nodeB Grid node at the low voltage winding
30-
* @param parallelDevices Amount of parallel transformers
30+
* @param parallelDevices overall amount of parallel transformers to automatically construct (e.g.
31+
* parallelDevices = 2 will build a total of two transformers using the specified parameters)
3132
* @param tapPos Tap Position of this transformer
3233
* @param autoTap True, if the tap position of the transformer is adapted automatically
3334
*/
@@ -53,7 +54,8 @@ public TransformerInput(
5354
* @param id of the asset
5455
* @param nodeA Grid node at the high voltage winding
5556
* @param nodeB Grid node at the low voltage winding
56-
* @param parallelDevices Amount of parallel transformers
57+
* @param parallelDevices overall amount of parallel transformers to automatically construct (e.g.
58+
* parallelDevices = 2 will build a total of two transformers using the specified parameters)
5759
* @param tapPos Tap Position of this transformer
5860
* @param autoTap True, if the tap position of the transformer is adapted automatically
5961
*/

0 commit comments

Comments
 (0)