Merge pull request #1098 from ie3-institute/ms/#1097-add-congestion-result

Adding `CongestionResult`.

Author: sebastian-peter

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Enhancing `VoltageLevel` with `equals` method [#1063](https://github.com/ie3-institute/PowerSystemDataModel/issues/1063)
 - `ConnectorValidationUtils` checks if parallel devices is > 0 [#1077](https://github.com/ie3-institute/PowerSystemDataModel/issues/1077)
 - `GridContainerValidationUtils` checks the connectivity for all defined operation time intervals [#1091](https://github.com/ie3-institute/PowerSystemDataModel/issues/1091)
+- Implemented a `CongestionResult` [#1097](https://github.com/ie3-institute/PowerSystemDataModel/issues/1097)
 
 ### Fixed
 - Fixed `MappingEntryies` not getting processed by adding `Getter` methods for record fields [#1084](https://github.com/ie3-institute/PowerSystemDataModel/issues/1084) 

docs/readthedocs/models/models.md

@@ -185,6 +185,7 @@ result/grid/switch
 result/grid/transformer
 result/grid/transformer2w
 result/grid/transformer3w
+result/grid/congestion
 ```
 
 ### Participant Related Models

docs/readthedocs/models/result/grid/congestion.md

@@ -0,0 +1,51 @@
+(congestion-result)=
+
+# Congestion
+
+Representation of a congestion result for a given subnet.
+
+## Attributes, Units and Remarks
+
+```{eval-rst}
+.. list-table::
+   :widths: 33 33 33
+   :header-rows: 1
+
+
+   * - Attribute
+     - Unit
+     - Remarks
+
+   * - time
+     - ZonedDateTime
+     - date and time for the produced result
+   
+   * - subgrid
+     - --
+     - Sub grid number
+
+   * - vMin
+     - p.u.
+     - minimal voltage of the subnet
+
+   * - vMax
+     - p.u.
+     - maximal voltage of the subnet
+
+   * - voltage
+     - --
+     - Boolean indicator, if a voltage congestion occurred
+
+   * - line
+     - --
+     - Boolean indicator, if a line congestion occurred
+
+   * - transformer
+     - --
+     - Boolean indicator, if a transformer congestion occurred
+```
+
+## Caveats
+
+Nothing - at least not known.
+If you found something, please contact us!

src/main/java/edu/ie3/datamodel/io/factory/result/CongestionResultFactory.java

@@ -0,0 +1,52 @@
+/*
+ * © 2024. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+*/
+package edu.ie3.datamodel.io.factory.result;
+
+import static edu.ie3.util.quantities.PowerSystemUnits.PU;
+
+import edu.ie3.datamodel.io.factory.EntityData;
+import edu.ie3.datamodel.models.result.CongestionResult;
+import java.time.ZonedDateTime;
+import java.time.format.DateTimeFormatter;
+import java.util.List;
+import java.util.Set;
+import javax.measure.quantity.Dimensionless;
+import tech.units.indriya.ComparableQuantity;
+
+public class CongestionResultFactory extends ResultEntityFactory<CongestionResult> {
+  private static final String SUBGRID = "subgrid";
+  private static final String VMIN = "vMin";
+  private static final String VMAX = "vMax";
+  private static final String VOLTAGE = "voltage";
+  private static final String LINE = "line";
+  private static final String TRANSFORMER = "transformer";
+
+  public CongestionResultFactory() {
+    super(CongestionResult.class);
+  }
+
+  public CongestionResultFactory(DateTimeFormatter dateTimeFormatter) {
+    super(dateTimeFormatter, CongestionResult.class);
+  }
+
+  @Override
+  protected List<Set<String>> getFields(Class<?> entityClass) {
+    return List.of(newSet(TIME, SUBGRID, VMIN, VMAX, VOLTAGE, LINE, TRANSFORMER));
+  }
+
+  @Override
+  protected CongestionResult buildModel(EntityData data) {
+    ZonedDateTime zdtTime = timeUtil.toZonedDateTime(data.getField(TIME));
+    int subgrid = data.getInt(SUBGRID);
+    ComparableQuantity<Dimensionless> vMin = data.getQuantity(VMIN, PU);
+    ComparableQuantity<Dimensionless> vMax = data.getQuantity(VMAX, PU);
+    boolean voltage = data.getBoolean(VOLTAGE);
+    boolean line = data.getBoolean(LINE);
+    boolean transformer = data.getBoolean(TRANSFORMER);
+
+    return new CongestionResult(zdtTime, subgrid, vMin, vMax, voltage, line, transformer);
+  }
+}

src/main/java/edu/ie3/datamodel/io/factory/result/ConnectorResultFactory.java

@@ -20,7 +20,7 @@
 import javax.measure.quantity.ElectricCurrent;
 import tech.units.indriya.ComparableQuantity;
 
-public class ConnectorResultFactory extends ResultEntityFactory<ConnectorResult> {
+public class ConnectorResultFactory extends ModelResultFactory<ConnectorResult> {
 
   private static final String IAMAG = "iAMag";
   private static final String IAANG = "iAAng";

src/main/java/edu/ie3/datamodel/io/factory/result/FlexOptionsResultFactory.java

@@ -14,7 +14,7 @@
 import javax.measure.quantity.Power;
 import tech.units.indriya.ComparableQuantity;
 
-public class FlexOptionsResultFactory extends ResultEntityFactory<FlexOptionsResult> {
+public class FlexOptionsResultFactory extends ModelResultFactory<FlexOptionsResult> {
 
   private static final String P_REF = "pRef";
   private static final String P_MIN = "pMin";

src/main/java/edu/ie3/datamodel/io/factory/result/ModelResultFactory.java

@@ -0,0 +1,23 @@
+/*
+ * © 2024. TU Dortmund University,
+ * Institute of Energy Systems, Energy Efficiency and Energy Economics,
+ * Research group Distribution grid planning and operation
+*/
+package edu.ie3.datamodel.io.factory.result;
+
+import edu.ie3.datamodel.models.result.ModelResultEntity;
+import java.time.format.DateTimeFormatter;
+
+public abstract class ModelResultFactory<T extends ModelResultEntity>
+    extends ResultEntityFactory<T> {
+  protected static final String INPUT_MODEL = "inputModel";
+
+  protected ModelResultFactory(Class<? extends T>... allowedClasses) {
+    super(allowedClasses);
+  }
+
+  protected ModelResultFactory(
+      DateTimeFormatter dateTimeFormatter, Class<? extends T>... allowedClasses) {
+    super(dateTimeFormatter, allowedClasses);
+  }
+}

src/main/java/edu/ie3/datamodel/io/factory/result/NodeResultFactory.java

@@ -15,7 +15,7 @@
 import javax.measure.quantity.Dimensionless;
 import tech.units.indriya.ComparableQuantity;
 
-public class NodeResultFactory extends ResultEntityFactory<NodeResult> {
+public class NodeResultFactory extends ModelResultFactory<NodeResult> {
   private static final String VMAG = "vMag";
   private static final String VANG = "vAng";
 

src/main/java/edu/ie3/datamodel/io/factory/result/ResultEntityFactory.java

@@ -21,7 +21,6 @@
 abstract class ResultEntityFactory<T extends ResultEntity> extends EntityFactory<T, EntityData> {
 
   protected static final String TIME = "time";
-  protected static final String INPUT_MODEL = "inputModel";
 
   protected final TimeUtil timeUtil;
 

src/main/java/edu/ie3/datamodel/io/factory/result/SwitchResultFactory.java

@@ -11,7 +11,7 @@
 import java.time.format.DateTimeFormatter;
 import java.util.*;
 
-public class SwitchResultFactory extends ResultEntityFactory<SwitchResult> {
+public class SwitchResultFactory extends ModelResultFactory<SwitchResult> {
 
   private static final String CLOSED = "closed";