Introduce a storage model for domestic hot water

CHANGELOG.md

@@ -16,7 +16,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - 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 [#1253](https://github.com/ie3-institute/PowerSystemDataModel/issues/1253) 
+- Attributes `housingType` and `numberInhabitants` for `ThermalHouse`s [#1253](https://github.com/ie3-institute/PowerSystemDataModel/issues/1253)
+- Added domestic hot water storage model [#1257](https://github.com/ie3-institute/PowerSystemDataModel/issues/1257)
 
 ### Fixed
 - Removing opened `SwitchInput` during connectivity check [#1221](https://github.com/ie3-institute/PowerSystemDataModel/issues/1221)

docs/readthedocs/models/input/thermal/domestichotwaterstorage.md

@@ -0,0 +1,64 @@
+(domestichotwaterstorage-model)=
+
+# Domestic Hot Water Storage
+
+Model of a domestic hot water storage using a fluid to store thermal energy.
+
+## Attributes, Units and Remarks
+
+```{eval-rst}
+.. list-table::
+   :widths: 33 33 33
+   :header-rows: 1
+
+
+   * - Attribute
+     - Unit
+     - Remarks
+
+   * - uuid
+     - --
+     -
+
+   * - id
+     - --
+     - Human readable identifier
+
+   * - operator
+     - --
+     -
+
+   * - operationTime
+     - --
+     - Timely restriction of operation
+
+   * - thermalBus
+     - --
+     - Connection point to the thermal system
+
+   * - storageVolumeLvl
+     - m³
+     - Overall available storage volume
+
+   * - inletTemp
+     - °C
+     - Temperature of the inlet
+
+   * - returnTemp
+     - °C
+     - Temperature of the outlet
+
+   * - c
+     - kWh / (K :math:`\cdot` m³)
+     - Specific heat capacity of the storage medium
+
+   * - pThermalMax
+     - kW
+     - Maximum permissible thermal power of the storage
+
+```
+
+## Caveats
+
+Nothing - at least not known.
+If you found something, please contact us!

docs/readthedocs/models/models.md

@@ -129,6 +129,7 @@ maxdepth: 1
 input/thermal/thermalbus
 input/thermal/thermalhouse
 input/thermal/cylindricalstorage
+input/thermal/domestichotwaterstorage
 ```
 
 ### Participant Related Models
@@ -209,6 +210,7 @@ result/participant/thermalstorage
 result/participant/thermalunit
 result/participant/thermalhouse
 result/participant/cylindricalstorage
+result/participant/domestichotwaterstorage
 result/participant/systemparticipant
 result/participant/flexoption
 result/participant/em

docs/readthedocs/models/result/participant/domestichotwaterstorage.md

@@ -0,0 +1,44 @@
+(domestichotwaterstorage-result)=
+
+# Domestic Hot Water Storage
+
+Result of a domestic hot water storage using a fluid to store thermal energy.
+
+## Attributes, Units and Remarks
+
+```{eval-rst}
+.. list-table::
+   :widths: 33 33 33
+   :header-rows: 1
+
+
+   * - Attribute
+     - Unit
+     - Remarks
+
+   * - time
+     - --
+     - date and time for the produced result
+
+   * - inputModel
+     - --
+     - uuid for the associated input model
+
+   * - energy
+     - MWh
+     -
+
+   * - qDot
+     - MW
+     - heat demand of the sink
+
+   * - fillLevel
+     - --
+     -
+
+```
+
+## Caveats
+
+Nothing - at least not known.
+If you found something, please contact us!

docs/uml/main/EntitySourceClassDiagram.puml

@@ -130,6 +130,7 @@ class ResultEntitySource {
     + Set<EvResult> getEvResults() throws SourceException
     + Set<HpResult> getHpResults() throws SourceException
     + Set<CylindricalStorageResult> getCylindricalStorageResult() throws SourceException
+    + Set<DomesticHotStorageResult> getDomesticHotWaterStorageResult() throws SourceException
     + Set<ThermalHouseResult> getThermalHouseResults() throws SourceException
     + Set<EmResult> getEmResults() throws SourceException
     + Set<CongestionResult> getCongestionResults() throws SourceException
@@ -179,6 +180,7 @@ class ThermalSource {
     - TypeSource typeSource
     - ThermalBusInputFactory thermalBusInputFactory
     - CylindricalStorageInputFactory cylindricalStorageInputFactory
+    - DomesticHotWaterStorageInputFactory domesticHotWaterStorageInputFactory
     - ThermalHouseInputFactory thermalHouseInputFactory
     + ThermalSource(TypeSource, DataSource)
     + Map<UUID, ThermalBusInput> getThermalBuses() throws SourceException
@@ -187,8 +189,10 @@ class ThermalSource {
     + Map<UUID, ThermalStorageInput> getThermalStorages(Map<UUID, OperatorInput>, Map<UUID, ThermalBusInput>) throws SourceException
     + Map<UUID, ThermalHouseInput> getThermalHouses() throws SourceException
     + Map<UUID, ThermalHouseInput> getThermalHouses(Map<UUID, OperatorInput>, Map<UUID, ThermalBusInput>) throws SourceException
-    + Set<CylindricalStorageInput> getCylindricStorages() throws SourceException
-    + Set<CylindricalStorageInput> getCylindricStorages(Map<UUID, OperatorInput>, Map<UUID, ThermalBusInput>) throws SourceException
+    + Set<CylindricalStorageInput> getCylindricalStorages() throws SourceException
+    + Set<CylindricalStorageInput> getCylindricalStorages(Map<UUID, OperatorInput>, Map<UUID, ThermalBusInput>) throws SourceException
+    + Set<DomesticHotWaterStorageInput> getDomesticHotWaterStorages() throws SourceException
+    + Set<DomesticHotWaterStorageInput> getDomesticHotWaterStorages(Map<UUID, OperatorInput>, Map<UUID, ThermalBusInput>) throws SourceException
 }
 
 abstract class TimeSeriesMappingSource {

docs/uml/main/OutputDatamodelConcept.puml

@@ -130,10 +130,16 @@ package models {
             }
             ThermalUnitResult <|-- ThermalStorageResult
 
-            class CylindricalStorageResult {
+            Abstract class AbstractThermalStorageResult {
             - fillLevel: ComparableQuantity<Dimensionless> [%]
             }
-            ThermalStorageResult <|-- CylindricalStorageResult
+            ThermalStorageResult <|-- AbstractThermalStorageResult
+
+            class CylindricalStorageResult {}
+            AbstractThermalStorageResult <|-- CylindricalStorageResult
+
+             class DomesticHotWaterStorageResult {}
+            AbstractThermalStorageResult <|-- DomesticHotWaterStorageResult
         }
     }
 }

docs/uml/main/input/DefaultInputDirectoryHierarchy.puml

@@ -9,7 +9,7 @@ package <gridname>(.tar.gz) {
             label "line_input.csv\n//measurement_unit_input.csv//\nnode_input.csv\n//switch_input.csv//\ntransformer_2_w_input.csv\n//transformer_3_w_input.csv//"
         }
         package "//thermal//" as th {
-            label "//cylindrical_storage_input.csv//\n//thermal_bus_input.csv//\n//thermal_house_input.csv//"
+            label "//cylindrical_storage_input.csv//\n//domestic_hot_water_storage_input.csv//\n//thermal_bus_input.csv//\n//thermal_house_input.csv//"
         }
         package participants {
             label "//bm_input.csv//\n//chp_input.csv//\n//ev_input.csv//\n//evcs_input.csv//\n//fixed_feed_in_input.csv//\n//hp_input.csv//\n//load_input.csv//\n//pv_input.csv//\n//storage_input.csv//\n//wec_input.csv//"

docs/uml/main/input/DefaultResultDirectoryHierarchy.puml

@@ -6,7 +6,7 @@ package <gridname>(.tar.gz) {
             label "//line_result.csv//\n//node_result.csv//\n//switch_result.csv//\n//transformer_2_w_result.csv//\n//transformer_3_w_result.csv//"
         }
         package "//thermal//" {
-            label "//cylindrical_storage_result.csv//\n//thermal_bus_result.csv//\n//thermal_house_result.csv//"
+            label "//cylindrical_storage_result.csv//\n//domestic_hot_water_storage_result.csv//\n//thermal_bus_result.csv//\n//thermal_house_result.csv//"
         }
         package "//participants//" {
             label "//bm_result.csv//\n//chp_result.csv//\n//ev_result.csv//\n//evcs_result.csv//\n//fixed_feed_in_result.csv//\n//hp_result.csv//\n//load_result.csv//\n//pv_result.csv//\n//storage_result.csv//\n//wec_result.csv//"

docs/uml/main/input/ThermalDatamodelConcept.puml

@@ -115,14 +115,26 @@ package models {
             abstract class ThermalStorageInput
             ThermalStorageInput --|> ThermalUnitInput
 
+            abstract class AbstractStorageInput
+            AbstractStorageInput --|> ThermalStorageInput
+
             class CylindricalStorageInput {
                 - storageVolumeLvl: ComparableQuantity<Volume> [m³]
                 - inletTemp: ComparableQuantity<Temperature> [°C]
                 - returnTemp: ComparableQuantity<Temperature> [°C]
                 - c: ComparableQuantity<SpecificHeatCapacity> [kWh/(K*m³)]
                 - pThermalMax: ComparableQuantity<Power> [kW]
             }
-            CylindricalStorageInput --|> ThermalStorageInput
+            CylindricalStorageInput --|> AbstractStorageInput
+
+            class DomesticHotWaterStorageInput {
+                - storageVolumeLvl: ComparableQuantity<Volume> [m³]
+                - inletTemp: ComparableQuantity<Temperature> [°C]
+                - returnTemp: ComparableQuantity<Temperature> [°C]
+                - c: ComparableQuantity<SpecificHeatCapacity> [kWh/(K*m³)]
+                - pThermalMax: ComparableQuantity<Power> [kW]
+            }
+            DomesticHotWaterStorageInput --|> AbstractStorageInput
         }
     }
 }

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);
+  }
+}

src/main/java/edu/ie3/datamodel/io/factory/input/CylindricalStorageInputFactory.java

@@ -6,63 +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);
 
+    final ThermalBusInput bus = data.getBusInput();
     return new CylindricalStorageInput(
         uuid,
         id,
         operator,
         operationTime,
         bus,
-        storageVolumeLvl,
-        inletTemp,
-        returnTemp,
-        c,
-        pThermalMax);
+        getStorageVolumeLvl(data),
+        getInletTemp(data),
+        getReturnTemp(data),
+        getSpecificHeatCapacity(data),
+        getMaxThermalPower(data));
   }
 }

src/main/java/edu/ie3/datamodel/io/factory/input/DomesticHotWaterStorageInputFactory.java

@@ -0,0 +1,42 @@
+/*
+ * © 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.OperationTime;
+import edu.ie3.datamodel.models.input.OperatorInput;
+import edu.ie3.datamodel.models.input.thermal.DomesticHotWaterStorageInput;
+import edu.ie3.datamodel.models.input.thermal.ThermalBusInput;
+import java.util.UUID;
+
+public class DomesticHotWaterStorageInputFactory
+    extends AbstractThermalStorageInputFactory<DomesticHotWaterStorageInput> {
+
+  public DomesticHotWaterStorageInputFactory() {
+    super(DomesticHotWaterStorageInput.class);
+  }
+
+  @Override
+  protected DomesticHotWaterStorageInput buildModel(
+      ThermalUnitInputEntityData data,
+      UUID uuid,
+      String id,
+      OperatorInput operator,
+      OperationTime operationTime) {
+
+    final ThermalBusInput bus = data.getBusInput();
+    return new DomesticHotWaterStorageInput(
+        uuid,
+        id,
+        operator,
+        operationTime,
+        bus,
+        getStorageVolumeLvl(data),
+        getInletTemp(data),
+        getReturnTemp(data),
+        getSpecificHeatCapacity(data),
+        getMaxThermalPower(data));
+  }
+}