Merge remote-tracking branch 'origin/df/#1131-psdm-update-for-tap-water-demand' into df/#1131-psdm-update-for-tap-water-demand

danielfeismann · danielfeismann · commit 150bc52e2516 · 2025-02-21T08:46:30.000+01:00
# Conflicts:
#	CHANGELOG.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Enhance `TimeSeriesSource` with method to retrieve the previous value before a given key [#1182](https://github.com/ie3-institute/PowerSystemDataModel/issues/1182)
 - Added `BdewLoadProfileTimeSeries` [#1230](https://github.com/ie3-institute/PowerSystemDataModel/issues/1230)
 - Added `RandomLoadProfileTimeSeries` [#1232](https://github.com/ie3-institute/PowerSystemDataModel/issues/1232)
+- Attribute `pThermalRated` for `ThermalStorage`s [#679](https://github.com/ie3-institute/PowerSystemDataModel/issues/679)
+- Attributes `housingType` and `numberInhabitants` for `ThermalHouse`s [#1131](https://github.com/ie3-institute/PowerSystemDataModel/issues/1131)
+- Added domestic hot water storage model [#1131](https://github.com/ie3-institute/PowerSystemDataModel/issues/1131)
 - Extend ValidationUtils for validating ThermalGrids [#1216](https://github.com/ie3-institute/PowerSystemDataModel/issues/1216) 
 - Attribute `pThermalRated` for `ThermalStorage`s [#679](https://github.com/ie3-institute/PowerSystemDataModel/issues/679)
 - Attributes `housingType` and `numberInhabitants` for `ThermalHouse`s [#1131](https://github.com/ie3-institute/PowerSystemDataModel/issues/1131)
diff --git a/docs/readthedocs/io/ValidationUtils.md b/docs/readthedocs/io/ValidationUtils.md
@@ -74,7 +74,7 @@ The ValidationUtils include validation checks for...
         - HpTypeInput
         - StorageTypeInput
         - WecTypeInput
-- ThermalUnitValidationUtils
+- ThermalValidationUtils
     - ThermalUnitInput
         - ThermalSinkInput
             - ThermalHouseInput
diff --git a/docs/readthedocs/models/input/thermal/cylindricalstorage.md b/docs/readthedocs/models/input/thermal/cylindricalstorage.md
@@ -2,7 +2,7 @@
 
 # Cylindrical Thermal Storage
 
-Model of a cylindrical thermal storage using a fluent to store thermal energy.
+Model of a cylindrical thermal storage using a fluid to store thermal energy.
 
 ## Attributes, Units and Remarks
 
diff --git a/docs/readthedocs/models/input/thermal/domestichotwaterstorage.md b/docs/readthedocs/models/input/thermal/domestichotwaterstorage.md
@@ -2,7 +2,7 @@
 
 # Domestic Hot Water Storage
 
-Model of a domestic hot water storage using a fluent to store thermal energy.
+Model of a domestic hot water storage using a fluid to store thermal energy.
 
 ## Attributes, Units and Remarks
 
diff --git a/docs/readthedocs/models/result/participant/cylindricalstorage.md b/docs/readthedocs/models/result/participant/cylindricalstorage.md
@@ -2,7 +2,7 @@
 
 # Cylindrical Thermal Storage
 
-Result of a cylindrical thermal storage using a fluent to store thermal energy.
+Result of a cylindrical thermal storage using a fluid to store thermal energy.
 
 ## Attributes, Units and Remarks
 
diff --git a/docs/readthedocs/models/result/participant/domestichotwaterstorage.md b/docs/readthedocs/models/result/participant/domestichotwaterstorage.md
@@ -2,7 +2,7 @@
 
 # Domestic Hot Water Storage
 
-Result of a domestic hot water storage using a fluent to store thermal energy.
+Result of a domestic hot water storage using a fluid to store thermal energy.
 
 ## Attributes, Units and Remarks
 
diff --git a/src/main/java/edu/ie3/datamodel/io/factory/input/AbstractThermalStorageInputFactory.java b/src/main/java/edu/ie3/datamodel/io/factory/input/AbstractThermalStorageInputFactory.java
@@ -0,0 +1,54 @@
+/*
+ * © 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.input;
+
+import edu.ie3.datamodel.models.StandardUnits;
+import edu.ie3.datamodel.models.input.AssetInput;
+import edu.ie3.util.quantities.interfaces.SpecificHeatCapacity;
+import javax.measure.quantity.Power;
+import javax.measure.quantity.Temperature;
+import javax.measure.quantity.Volume;
+import tech.units.indriya.ComparableQuantity;
+
+public abstract class AbstractThermalStorageInputFactory<T extends AssetInput>
+extends AssetInputEntityFactory<T, ThermalUnitInputEntityData> {
+
+  private static final String STORAGE_VOLUME_LVL = "storageVolumeLvl";
+  private static final String INLET_TEMP = "inletTemp";
+  private static final String RETURN_TEMP = "returnTemp";
+  private static final String C = "c";
+  private static final String P_THERMAL_MAX = "pThermalMax";
+
+  public AbstractThermalStorageInputFactory(Class<T> clazz) {
+    super(clazz);
+  }
+
+  @Override
+  protected String[] getAdditionalFields() {
+    return new String[] {STORAGE_VOLUME_LVL, INLET_TEMP, RETURN_TEMP, C, P_THERMAL_MAX};
+  }
+
+  protected ComparableQuantity<Volume> getStorageVolumeLvl(ThermalUnitInputEntityData data) {
+    return data.getQuantity(STORAGE_VOLUME_LVL, StandardUnits.VOLUME);
+  }
+
+  protected ComparableQuantity<Temperature> getInletTemp(ThermalUnitInputEntityData data) {
+    return data.getQuantity(INLET_TEMP, StandardUnits.TEMPERATURE);
+  }
+
+  protected ComparableQuantity<Temperature> getReturnTemp(ThermalUnitInputEntityData data) {
+    return data.getQuantity(RETURN_TEMP, StandardUnits.TEMPERATURE);
+  }
+
+  protected ComparableQuantity<SpecificHeatCapacity> getSpecificHeatCapacity(
+      ThermalUnitInputEntityData data) {
+    return data.getQuantity(C, StandardUnits.SPECIFIC_HEAT_CAPACITY);
+  }
+
+  protected ComparableQuantity<Power> getMaxThermalPower(ThermalUnitInputEntityData data) {
+    return data.getQuantity(P_THERMAL_MAX, StandardUnits.ACTIVE_POWER_IN);
+  }
+}
diff --git a/src/main/java/edu/ie3/datamodel/io/factory/input/CylindricalStorageInputFactory.java b/src/main/java/edu/ie3/datamodel/io/factory/input/CylindricalStorageInputFactory.java
@@ -6,62 +6,37 @@
 package edu.ie3.datamodel.io.factory.input;
 
 import edu.ie3.datamodel.models.OperationTime;
-import edu.ie3.datamodel.models.StandardUnits;
 import edu.ie3.datamodel.models.input.OperatorInput;
 import edu.ie3.datamodel.models.input.thermal.CylindricalStorageInput;
 import edu.ie3.datamodel.models.input.thermal.ThermalBusInput;
-import edu.ie3.util.quantities.interfaces.SpecificHeatCapacity;
 import java.util.UUID;
-import javax.measure.quantity.Power;
-import javax.measure.quantity.Temperature;
-import javax.measure.quantity.Volume;
-import tech.units.indriya.ComparableQuantity;
 
 public class CylindricalStorageInputFactory
-    extends AssetInputEntityFactory<CylindricalStorageInput, ThermalUnitInputEntityData> {
-  private static final String STORAGE_VOLUME_LVL = "storageVolumeLvl";
-  private static final String INLET_TEMP = "inletTemp";
-  private static final String RETURN_TEMP = "returnTemp";
-  private static final String C = "c";
-  private static final String P_THERMAL_MAX = "pThermalMax";
+    extends AbstractThermalStorageInputFactory<CylindricalStorageInput> {
 
   public CylindricalStorageInputFactory() {
     super(CylindricalStorageInput.class);
   }
 
-  @Override
-  protected String[] getAdditionalFields() {
-    return new String[] {STORAGE_VOLUME_LVL, INLET_TEMP, RETURN_TEMP, C, P_THERMAL_MAX};
-  }
-
   @Override
   protected CylindricalStorageInput buildModel(
       ThermalUnitInputEntityData data,
       UUID uuid,
       String id,
       OperatorInput operator,
       OperationTime operationTime) {
+
     final ThermalBusInput bus = data.getBusInput();
-    final ComparableQuantity<Volume> storageVolumeLvl =
-        data.getQuantity(STORAGE_VOLUME_LVL, StandardUnits.VOLUME);
-    final ComparableQuantity<Temperature> inletTemp =
-        data.getQuantity(INLET_TEMP, StandardUnits.TEMPERATURE);
-    final ComparableQuantity<Temperature> returnTemp =
-        data.getQuantity(RETURN_TEMP, StandardUnits.TEMPERATURE);
-    final ComparableQuantity<SpecificHeatCapacity> c =
-        data.getQuantity(C, StandardUnits.SPECIFIC_HEAT_CAPACITY);
-    final ComparableQuantity<Power> pThermalMax =
-        data.getQuantity(P_THERMAL_MAX, StandardUnits.ACTIVE_POWER_IN);
     return new CylindricalStorageInput(
         uuid,
         id,
         operator,
         operationTime,
         bus,
-        storageVolumeLvl,
-        inletTemp,
-        returnTemp,
-        c,
-        pThermalMax);
+        getStorageVolumeLvl(data),
+        getInletTemp(data),
+        getReturnTemp(data),
+        getSpecificHeatCapacity(data),
+        getMaxThermalPower(data));
   }
 }
diff --git a/src/main/java/edu/ie3/datamodel/io/factory/input/DomesticHotWaterStorageInputFactory.java b/src/main/java/edu/ie3/datamodel/io/factory/input/DomesticHotWaterStorageInputFactory.java
@@ -6,62 +6,37 @@
 package edu.ie3.datamodel.io.factory.input;
 
 import edu.ie3.datamodel.models.OperationTime;
-import edu.ie3.datamodel.models.StandardUnits;
 import edu.ie3.datamodel.models.input.OperatorInput;
 import edu.ie3.datamodel.models.input.thermal.DomesticHotWaterStorageInput;
 import edu.ie3.datamodel.models.input.thermal.ThermalBusInput;
-import edu.ie3.util.quantities.interfaces.SpecificHeatCapacity;
 import java.util.UUID;
-import javax.measure.quantity.Power;
-import javax.measure.quantity.Temperature;
-import javax.measure.quantity.Volume;
-import tech.units.indriya.ComparableQuantity;
 
 public class DomesticHotWaterStorageInputFactory
-    extends AssetInputEntityFactory<DomesticHotWaterStorageInput, ThermalUnitInputEntityData> {
-  private static final String STORAGE_VOLUME_LVL = "storageVolumeLvl";
-  private static final String INLET_TEMP = "inletTemp";
-  private static final String RETURN_TEMP = "returnTemp";
-  private static final String C = "c";
-  private static final String P_THERMAL_MAX = "pThermalMax";
+    extends AbstractThermalStorageInputFactory<DomesticHotWaterStorageInput> {
 
   public DomesticHotWaterStorageInputFactory() {
     super(DomesticHotWaterStorageInput.class);
   }
 
-  @Override
-  protected String[] getAdditionalFields() {
-    return new String[] {STORAGE_VOLUME_LVL, INLET_TEMP, RETURN_TEMP, C, P_THERMAL_MAX};
-  }
-
   @Override
   protected DomesticHotWaterStorageInput buildModel(
       ThermalUnitInputEntityData data,
       UUID uuid,
       String id,
       OperatorInput operator,
       OperationTime operationTime) {
+
     final ThermalBusInput bus = data.getBusInput();
-    final ComparableQuantity<Volume> storageVolumeLvl =
-        data.getQuantity(STORAGE_VOLUME_LVL, StandardUnits.VOLUME);
-    final ComparableQuantity<Temperature> inletTemp =
-        data.getQuantity(INLET_TEMP, StandardUnits.TEMPERATURE);
-    final ComparableQuantity<Temperature> returnTemp =
-        data.getQuantity(RETURN_TEMP, StandardUnits.TEMPERATURE);
-    final ComparableQuantity<SpecificHeatCapacity> c =
-        data.getQuantity(C, StandardUnits.SPECIFIC_HEAT_CAPACITY);
-    final ComparableQuantity<Power> pThermalMax =
-        data.getQuantity(P_THERMAL_MAX, StandardUnits.ACTIVE_POWER_IN);
     return new DomesticHotWaterStorageInput(
         uuid,
         id,
         operator,
         operationTime,
         bus,
-        storageVolumeLvl,
-        inletTemp,
-        returnTemp,
-        c,
-        pThermalMax);
+        getStorageVolumeLvl(data),
+        getInletTemp(data),
+        getReturnTemp(data),
+        getSpecificHeatCapacity(data),
+        getMaxThermalPower(data));
   }
 }
diff --git a/src/main/java/edu/ie3/datamodel/models/input/thermal/DomesticHotWaterStorageInput.java b/src/main/java/edu/ie3/datamodel/models/input/thermal/DomesticHotWaterStorageInput.java
@@ -115,66 +115,5 @@ public static class DomesticHotWaterStorageInputCopyBuilder
     public DomesticHotWaterStorageInputCopyBuilder(DomesticHotWaterStorageInput entity) {
       super(entity);
     }
-
-    @Override
-    public DomesticHotWaterStorageInputCopyBuilder storageVolumeLvl(
-        ComparableQuantity<Volume> storageVolumeLvl) {
-      this.storageVolumeLvl = storageVolumeLvl;
-      return this;
-    }
-
-    @Override
-    public DomesticHotWaterStorageInputCopyBuilder inletTemp(
-        ComparableQuantity<Temperature> inletTemp) {
-      this.inletTemp = inletTemp;
-      return this;
-    }
-
-    @Override
-    public DomesticHotWaterStorageInputCopyBuilder returnTemp(
-        ComparableQuantity<Temperature> returnTemp) {
-      this.returnTemp = returnTemp;
-      return this;
-    }
-
-    @Override
-    public DomesticHotWaterStorageInputCopyBuilder c(ComparableQuantity<SpecificHeatCapacity> c) {
-      this.c = c;
-      return this;
-    }
-
-    @Override
-    public DomesticHotWaterStorageInputCopyBuilder pThermalMax(
-        ComparableQuantity<Power> pThermalMax) {
-      this.pThermalMax = pThermalMax;
-      return this;
-    }
-
-    @Override
-    public DomesticHotWaterStorageInputCopyBuilder scale(Double factor) {
-      storageVolumeLvl(this.storageVolumeLvl.multiply(factor));
-      pThermalMax(this.pThermalMax.multiply(factor));
-      return this;
-    }
-
-    @Override
-    public DomesticHotWaterStorageInput build() {
-      return new DomesticHotWaterStorageInput(
-          getUuid(),
-          getId(),
-          getOperator(),
-          getOperationTime(),
-          getThermalBus(),
-          this.storageVolumeLvl,
-          this.inletTemp,
-          this.returnTemp,
-          this.c,
-          this.pThermalMax);
-    }
-
-    @Override
-    protected DomesticHotWaterStorageInputCopyBuilder thisInstance() {
-      return this;
-    }
   }
 }
diff --git a/src/main/java/edu/ie3/datamodel/utils/validation/ThermalValidationUtils.java b/src/main/java/edu/ie3/datamodel/utils/validation/ThermalValidationUtils.java
@@ -60,42 +60,6 @@ private ThermalValidationUtils() {
     return exceptions;
   }
 
-  /**
-   * Validates a thermal grid if:
-   *
-   * <ul>
-   *   <li>it is not null
-   * </ul>
-   *
-   * A "distribution" method, that forwards the check request to specific implementations to fulfill
-   * the checking task, based on the class of the given object.
-   *
-   * @param thermalGrid ThermalGrid to validate
-   * @return a list of try objects either containing an {@link ValidationException} or an empty
-   *     Success
-   */
-  protected static List<Try<Void, ? extends ValidationException>> check(ThermalGrid thermalGrid) {
-    Try<Void, InvalidEntityException> isNull = checkNonNull(thermalGrid, "a thermal grid");
-
-    if (isNull.isFailure()) {
-      return List.of(isNull);
-    }
-
-    List<Try<Void, ? extends ValidationException>> exceptions = new ArrayList<>();
-
-    // Validate houses
-    for (ThermalHouseInput house : thermalGrid.houses()) {
-      exceptions.addAll(checkThermalHouse(house));
-    }
-
-    // Validate storages
-    for (ThermalStorageInput storage : thermalGrid.storages()) {
-      exceptions.addAll(check(storage));
-    }
-
-    return exceptions;
-  }
-
   /**
    * Validates a thermal grid if:
    *
diff --git a/src/main/java/edu/ie3/datamodel/utils/validation/ValidationUtils.java b/src/main/java/edu/ie3/datamodel/utils/validation/ValidationUtils.java
@@ -157,8 +157,6 @@ else if (ThermalUnitInput.class.isAssignableFrom(assetInput.getClass()))
       exceptions.addAll(ThermalValidationUtils.check((ThermalUnitInput) assetInput));
     else if (ThermalGrid.class.isAssignableFrom(assetInput.getClass()))
       exceptions.addAll(ThermalValidationUtils.check((ThermalUnitInput) assetInput));
-    else if (ThermalGrid.class.isAssignableFrom(assetInput.getClass()))
-      exceptions.addAll(ThermalUnitValidationUtils.check((ThermalUnitInput) assetInput));
     else {
       logNotImplemented(assetInput);
     }
diff --git a/src/test/groovy/edu/ie3/datamodel/utils/validation/ThermalValidationUtilsTest.groovy b/src/test/groovy/edu/ie3/datamodel/utils/validation/ThermalValidationUtilsTest.groovy

Original file line number	Diff line number	Diff line change
`@@ -157,8 +157,6 @@ else if (ThermalUnitInput.class.isAssignableFrom(assetInput.getClass()))`
`157`	`157`	`exceptions.addAll(ThermalValidationUtils.check((ThermalUnitInput) assetInput));`
`158`	`158`	`else if (ThermalGrid.class.isAssignableFrom(assetInput.getClass()))`
`159`	`159`	`exceptions.addAll(ThermalValidationUtils.check((ThermalUnitInput) assetInput));`
`160`		`- else if (ThermalGrid.class.isAssignableFrom(assetInput.getClass()))`
`161`		`- exceptions.addAll(ThermalUnitValidationUtils.check((ThermalUnitInput) assetInput));`
`162`	`160`	`else {`
`163`	`161`	`logNotImplemented(assetInput);`
`164`	`162`	`}`