Skip to content

To/#371 clarify parallel devices param #373

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Jun 10, 2021
Merged

To/#371 clarify parallel devices param #373

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
82acc87
adjust javadocs documentation
t-ober Jun 7, 2021
6951ce7
adjust readthedocs documentation
t-ober Jun 7, 2021
644428e
update stable release version
t-ober Jun 7, 2021
346b90f
Merge branch 'dev' into to/#371-clarify-parallelDevices-param
t-ober Jun 7, 2021
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
2 changes: 1 addition & 1 deletion docs/readthedocs/gettingstarted.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ On `Maven central <https://search.maven.org/artifact/com.github.ie3-institute/Po
<dependency>
<groupId>com.github.ie3-institute</groupId>
<artifactId>PowerSystemDataModel</artifactId>
<version>1.1.0</version>
<version>2.0.0</version>
</dependency>

Snapshot releases
Expand Down
4 changes: 3 additions & 1 deletion docs/readthedocs/models/input/grid/line.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,9 @@ Entity Model
+-------------------+------+--------------------------------------------------------+
| nodeB | -- | |
+-------------------+------+--------------------------------------------------------+
| parallelDevices | -- | Amount of parallel devices of same attributes |
| parallelDevices | -- | | overall amount of parallel lines to automatically |
| | -- | | construct (e.g. parallelDevices = 2 will build a |
| | -- | | total of two lines using the specified parameters) |
+-------------------+------+--------------------------------------------------------+
| type | -- | |
+-------------------+------+--------------------------------------------------------+
Expand Down
48 changes: 25 additions & 23 deletions docs/readthedocs/models/input/grid/transformer2w.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,29 +50,31 @@ As obvious, the parameter can be used in T- as in 𝜋-equivalent circuit repres
Entity Model
""""""""""""

+-----------------+------+--------------------------------------------------------+
| Attribute | Unit | Remarks |
+=================+======+========================================================+
| uuid | -- | |
+-----------------+------+--------------------------------------------------------+
| id | -- | Human readable identifier |
+-----------------+------+--------------------------------------------------------+
| operator | -- | |
+-----------------+------+--------------------------------------------------------+
| operationTime | -- | Timely restriction of operation |
+-----------------+------+--------------------------------------------------------+
| nodeA | -- | Higher voltage node |
+-----------------+------+--------------------------------------------------------+
| nodeB | -- | Lower voltage node |
+-----------------+------+--------------------------------------------------------+
| parallelDevices | -- | Amount of parallel devices of same attributes |
+-----------------+------+--------------------------------------------------------+
| type | -- | |
+-----------------+------+--------------------------------------------------------+
| tapPos | -- | Current position of the tap changer |
+-----------------+------+--------------------------------------------------------+
| autoTap | -- | true, if there is a tap regulation apparent and active |
+-----------------+------+--------------------------------------------------------+
+-----------------+------+------------------------------------------------------------+
| Attribute | Unit | Remarks |
+=================+======+============================================================+
| uuid | -- | |
+-----------------+------+------------------------------------------------------------+
| id | -- | Human readable identifier |
+-----------------+------+------------------------------------------------------------+
| operator | -- | |
+-----------------+------+------------------------------------------------------------+
| operationTime | -- | Timely restriction of operation |
+-----------------+------+------------------------------------------------------------+
| nodeA | -- | Higher voltage node |
+-----------------+------+------------------------------------------------------------+
| nodeB | -- | Lower voltage node |
+-----------------+------+------------------------------------------------------------+
| parallelDevices | -- | | overall amount of parallel transformers to automatically |
| | -- | | construct (e.g. parallelDevices = 2 will build a |
| | -- | | total of two transformers using the specified parameters)|
+-----------------+------+------------------------------------------------------------+
| type | -- | |
+-----------------+------+------------------------------------------------------------+
| tapPos | -- | Current position of the tap changer |
+-----------------+------+------------------------------------------------------------+
| autoTap | -- | true, if there is a tap regulation apparent and active |
+-----------------+------+------------------------------------------------------------+

Caveats
^^^^^^^
Expand Down
52 changes: 27 additions & 25 deletions docs/readthedocs/models/input/grid/transformer3w.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,31 +70,33 @@ All impedances and admittances are given with respect to the higher voltage side
Entity Model
""""""""""""

+-----------------+------+--------------------------------------------------------+
| Attribute | Unit | Remarks |
+=================+======+========================================================+
| uuid | -- | |
+-----------------+------+--------------------------------------------------------+
| id | -- | Human readable identifier |
+-----------------+------+--------------------------------------------------------+
| operator | -- | |
+-----------------+------+--------------------------------------------------------+
| operationTime | -- | Timely restriction of operation |
+-----------------+------+--------------------------------------------------------+
| nodeA | -- | Higher voltage node |
+-----------------+------+--------------------------------------------------------+
| nodeB | -- | Intermediate voltage node |
+-----------------+------+--------------------------------------------------------+
| nodeC | -- | Lowest voltage node |
+-----------------+------+--------------------------------------------------------+
| parallelDevices | -- | Amount of parallel devices of same attributes |
+-----------------+------+--------------------------------------------------------+
| type | -- | |
+-----------------+------+--------------------------------------------------------+
| tapPos | -- | Current position of the tap changer |
+-----------------+------+--------------------------------------------------------+
| autoTap | -- | true, if there is a tap regulation apparent and active |
+-----------------+------+--------------------------------------------------------+
+-----------------+------+------------------------------------------------------------+
| Attribute | Unit | Remarks |
+=================+======+============================================================+
| uuid | -- | |
+-----------------+------+------------------------------------------------------------+
| id | -- | Human readable identifier |
+-----------------+------+------------------------------------------------------------+
| operator | -- | |
+-----------------+------+------------------------------------------------------------+
| operationTime | -- | Timely restriction of operation |
+-----------------+------+------------------------------------------------------------+
| nodeA | -- | Higher voltage node |
+-----------------+------+------------------------------------------------------------+
| nodeB | -- | Intermediate voltage node |
+-----------------+------+------------------------------------------------------------+
| nodeC | -- | Lowest voltage node |
+-----------------+------+------------------------------------------------------------+
| parallelDevices | -- | | overall amount of parallel transformers to automatically |
| | -- | | construct (e.g. parallelDevices = 2 will build a |
| | -- | | total of two transformers using the specified parameters)|
+-----------------+------+------------------------------------------------------------+
| type | -- | |
+-----------------+------+------------------------------------------------------------+
| tapPos | -- | Current position of the tap changer |
+-----------------+------+------------------------------------------------------------+
| autoTap | -- | true, if there is a tap regulation apparent and active |
+-----------------+------+------------------------------------------------------------+

Caveats
^^^^^^^
Expand Down
6 changes: 4 additions & 2 deletions src/main/java/edu/ie3/datamodel/models/input/connector/ConnectorInput.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ public abstract class ConnectorInput extends AssetInput implements HasNodes {
* @param operationTime Time for which the entity is operated
* @param nodeA Grid node at one side of the connector
* @param nodeB Grid node at the other side of the connector
* @param parallelDevices Amount of parallel devices
* @param parallelDevices overall amount of parallel devices to automatically construct (e.g.
* parallelDevices = 2 will build a total of two entities using the specified parameters)
*/
public ConnectorInput(
UUID uuid,
Expand All @@ -53,7 +54,8 @@ public ConnectorInput(
* @param id of the asset
* @param nodeA Grid node at one side of the connector
* @param nodeB Grid node at the other side of the connector
* @param parallelDevices Amount of parallel devices
* @param parallelDevices overall amount of parallel devices to automatically construct (e.g.
* parallelDevices = 2 will build a total of two entities using the specified parameters)
*/
public ConnectorInput(
UUID uuid, String id, NodeInput nodeA, NodeInput nodeB, int parallelDevices) {
Expand Down
6 changes: 4 additions & 2 deletions src/main/java/edu/ie3/datamodel/models/input/connector/LineInput.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ public class LineInput extends ConnectorInput implements HasType {
* @param operationTime Time for which the entity is operated
* @param nodeA Grid node at one side of the line
* @param nodeB Grid node at the other side of the line
* @param parallelDevices Amount of parallel lines
* @param parallelDevices overall amount of parallel lines to automatically construct (e.g.
* parallelDevices = 2 will build a total of two lines using the specified parameters)
* @param type of line
* @param length of this line
* @param geoPosition Coordinates of this line
Expand Down Expand Up @@ -75,7 +76,8 @@ public LineInput(
* @param id of the asset
* @param nodeA Grid node at one side of the line
* @param nodeB Grid node at the other side of the line
* @param parallelDevices Amount of parallel lines
* @param parallelDevices overall amount of parallel lines to automatically construct (e.g.
* parallelDevices = 2 will build a total of two lines using the specified parameters)
* @param type of line
* @param length of this line
* @param geoPosition Coordinates of this line
Expand Down
6 changes: 4 additions & 2 deletions src/main/java/edu/ie3/datamodel/models/input/connector/Transformer2WInput.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ public class Transformer2WInput extends TransformerInput implements HasType {
* @param operationTime Time for which the entity is operated
* @param nodeA higher voltage node
* @param nodeB lower voltage node
* @param parallelDevices Amount of singular transformers
* @param parallelDevices overall amount of parallel transformers to automatically construct (e.g.
* parallelDevices = 2 will build a total of two transformers using the specified parameters)
* @param type of 2W transformer
* @param tapPos Tap position of this transformer
* @param autoTap True, if the tap position of the transformer is adapted automatically
Expand All @@ -57,7 +58,8 @@ public Transformer2WInput(
* @param id of the asset
* @param nodeA higher voltage node
* @param nodeB lower voltage node
* @param parallelDevices Amount of singular transformers
* @param parallelDevices overall amount of parallel transformers to automatically construct (e.g.
* parallelDevices = 2 will build a total of two transformers using the specified parameters)
* @param type of 2W transformer
* @param tapPos Tap position of this transformer
* @param autoTap True, if the tap position of the transformer is adapted automatically
Expand Down
12 changes: 8 additions & 4 deletions src/main/java/edu/ie3/datamodel/models/input/connector/Transformer3WInput.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ public class Transformer3WInput extends TransformerInput implements HasType {
* @param nodeA The higher voltage node
* @param nodeB The middle voltage node
* @param nodeC The lower voltage node
* @param parallelDevices Amount of singular transformers
* @param parallelDevices overall amount of parallel transformers to automatically construct (e.g.
* parallelDevices = 2 will build a total of two transformers using the specified parameters)
* @param type of 3W transformer
* @param tapPos Tap Position of this transformer
* @param autoTap true, if there is an automated regulation activated for this transformer
Expand Down Expand Up @@ -85,7 +86,8 @@ public Transformer3WInput(
* @param nodeA The higher voltage node
* @param nodeB The middle voltage node
* @param nodeC The lower voltage node
* @param parallelDevices Amount of singular transformers
* @param parallelDevices overall amount of parallel transformers to automatically construct (e.g.
* parallelDevices = 2 will build a total of two transformers using the specified parameters)
* @param type of 3W transformer
* @param tapPos Tap Position of this transformer
* @param autoTap true, if there is an automated regulation activated for this transformer
Expand Down Expand Up @@ -136,7 +138,8 @@ public Transformer3WInput(
* @param nodeA The higher voltage node
* @param nodeB The middle voltage node
* @param nodeC The lower voltage node
* @param parallelDevices Amount of singular transformers
* @param parallelDevices overall amount of parallel transformers to automatically construct (e.g.
* parallelDevices = 2 will build a total of two transformers using the specified parameters)
* @param type of 3W transformer
* @param tapPos Tap Position of this transformer
* @param autoTap true, if there is an automated regulation activated for this transformer
Expand Down Expand Up @@ -177,7 +180,8 @@ public Transformer3WInput(
* @param nodeA The higher voltage node
* @param nodeB The middle voltage node
* @param nodeC The lower voltage node
* @param parallelDevices Amount of singular transformers
* @param parallelDevices overall amount of parallel transformers to automatically construct (e.g.
* parallelDevices = 2 will build a total of two transformers using the specified parameters)
* @param type of 3W transformer
* @param tapPos Tap Position of this transformer
* @param autoTap true, if there is an automated regulation activated for this transformer
Expand Down
6 changes: 4 additions & 2 deletions src/main/java/edu/ie3/datamodel/models/input/connector/TransformerInput.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ public abstract class TransformerInput extends ConnectorInput {
* @param id of the asset
* @param nodeA Grid node at the high voltage winding
* @param nodeB Grid node at the low voltage winding
* @param parallelDevices Amount of parallel transformers
* @param parallelDevices overall amount of parallel transformers to automatically construct (e.g.
* parallelDevices = 2 will build a total of two transformers using the specified parameters)
* @param tapPos Tap Position of this transformer
* @param autoTap True, if the tap position of the transformer is adapted automatically
*/
Expand All @@ -53,7 +54,8 @@ public TransformerInput(
* @param id of the asset
* @param nodeA Grid node at the high voltage winding
* @param nodeB Grid node at the low voltage winding
* @param parallelDevices Amount of parallel transformers
* @param parallelDevices overall amount of parallel transformers to automatically construct (e.g.
* parallelDevices = 2 will build a total of two transformers using the specified parameters)
* @param tapPos Tap Position of this transformer
* @param autoTap True, if the tap position of the transformer is adapted automatically
*/
Expand Down