Introducing energy demand for warm water heating

CHANGELOG.md

@@ -36,6 +36,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added option to directly zip the output files [#793](https://github.com/ie3-institute/simona/issues/793)
 - Added weatherData HowTo for Copernicus ERA5 data [#967](https://github.com/ie3-institute/simona/issues/967)
 - Add some quote to 'printGoodbye' [#997](https://github.com/ie3-institute/simona/issues/997)
+- Integration test for thermal grids [#878](https://github.com/ie3-institute/simona/issues/878)
 
 ### Changed
 - Adapted to changed data source in PSDM [#435](https://github.com/ie3-institute/simona/issues/435)
@@ -131,6 +132,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fixed ThermalStorageResults having multiple entries [#924](https://github.com/ie3-institute/simona/issues/924)
 - Fix filter for thermal result checking for lastTick not for currentTick [#1008](https://github.com/ie3-institute/simona/issues/1008)
 - Fixed `CHANGELOG` entry for issue ([#103](https://github.com/ie3-institute/simona/issues/103)) [#941](https://github.com/ie3-institute/simona/issues/941)
+- Fixed Hp results leading to overheating house and other effects [#827](https://github.com/ie3-institute/simona/issues/827)
+- Fixed thermal storage getting recharged when empty [#827](https://github.com/ie3-institute/simona/issues/827)
 
 ## [3.0.0] - 2023-08-07
 

docs/readthedocs/models.md

@@ -28,6 +28,7 @@ maxdepth: 1
 models/bm_model
 models/chp_model
 models/cts_model
+models/dhws_model
 models/evcs_model
 models/hp_model
 models/load_model

docs/readthedocs/models/cts_model.md

@@ -3,7 +3,7 @@
 This page documents the functionality of the cylindrical thermal storage available in SIMONA.
 
 ## Behaviour
-This storage model operates on volumes, although the functions it provides for other models all operate with energy. Internally the storage model converts energy to volume and vice versa with formulas specified below. Furthermore it is assumed that the storage medium is water. Also the model holds a variable for the current storage level.
+This storage model operates on volumes, although the functions it provides for other models all operate with energy. Internally the storage model converts energy to volume and vice versa with formulas specified below. Furthermore it is assumed that the storage medium is water. Also the model holds a variable for the current storage level. At initialisation the storage will be empty.
 
 ## Attributes, Units and Remarks
 

docs/readthedocs/models/dhws_model.md

@@ -0,0 +1,56 @@
+(dhws_model)=
+# Domestic Hot Water Storage
+This page documents the functionality of the domestic hot water storage available in SIMONA.
+
+## Behaviour
+This storage model operates on volumes, although the functions it provides for other models all operate with energy. Internally the storage model converts energy to volume and vice versa with formulas specified below. Furthermore it is assumed that the storage medium is water. Also the model holds a variable for the current storage level. At initialisation the storage will be full. Domestic hot water storage will be refilled when the state of charge will be below 20 % or when the required water demand can not be covered by the stored energy in the storage itself.
+
+## Attributes, Units and Remarks
+
+Please refer to  {doc}`PowerSystemDataModel - CTS Model <psdm:models/input/thermal/domestichotwaterstorage>` for Attributes and Units used in this Model.
+
+## Calculations
+### Maximal storage capacity
+As the name suggests this storage has a cylindric form, hence its maximum storage capacity $V_{st, max}$ can be given by:
+
+$$
+V_{st, max} = \pi \cdot r^2 \cdot h
+$$
+
+### Conversions of energy and volume
+
+In this model the change of stored energy (heat) is represented by the change of the volume of the storage medium. This relation between stored heat and volume change is given by:
+
+$$
+V = (\frac{W}{c \cdot (tE - tA)})
+$$
+
+with
+W = energy to be converted to volume
+V = resulting volume
+tE = return temperature
+tA = inlet temperature
+c = $1,15 \frac{kWh}{m^3 \cdot K}$
+
+The original equation is given by:
+
+$$
+\Delta V_{st} = (\frac{\dot{Q_{th}} \cdot \Delta t}{c \cdot (tA - tE)})
+$$
+
+Reference:
+
+* {cite:cts}`Quaschning.2013`
+
+
+That is the mathematical description of loading and unloading processes concerning the buffer storage. Whenever heat is stored within the storage or removed from the storage this equation is used. This includes the case that the whole heat demand is satisfied by the storage.
+
+The same relationship is used to determine the quantity of heat which is stored in the storage by converting the equation to:
+
+$$
+W = V \cdot c \cdot (tE - tA)
+$$
+
+## Store/Take energy
+
+This calculation is performed as follows: An amount of energy is specified for storing or taking. The model then changes the storage level and returns if it exceeded the maximum (when storing energy) or the minimum (when taking energy).

docs/readthedocs/models/thermal_house_model.md

@@ -6,7 +6,7 @@ This page documents the functionality of the thermal house available in SIMONA.
 
 ## Behaviour
 
-This house model represents the thermal behaviour of a building. This reflects a simple shoe box with a thermal capacity and with transmission losses.
+This house model represents the thermal behaviour of a building. This reflects a simple shoe box with a thermal capacity and with transmission losses for its heating demand. As well the hot water demand (tap water) based on the number of inhabitants and the housing type on hourly basis is considered. 
 
 ## Attributes, Units and Remarks
 

src/main/resources/config/config-template.conf

@@ -51,7 +51,7 @@ EvcsRuntimeConfig {
   baseRuntimeConfig: BaseRuntimeConfig # this entry is ignored by the config generator,
   # but cannot removed bc otherwise EvcsRuntimeConfig is handled as String
   chargingStrategy: String | "maxPower" # can be one of maxPower, constantPower, gridOrientedScheduling or marketOrientedScheduling
-  lowestEvSoc: Double | 0.2 # Defines the lowest possible state of charge (SoC) that an EV is allowed to uncharge in vehicle to grid (V2G) mode
+  lowestEvSoc: Double | 0.2 # Defines the lowest possible state of charge (SoC) that an EV is allowed to discharge in vehicle to grid (V2G) mode
 }
 
 #@define extends BaseRuntimeConfig

src/main/scala/edu/ie3/simona/agent/ValueStore.scala

@@ -22,7 +22,7 @@ import scala.collection.SortedMap
   */
 final case class ValueStore[+D](
     maxTickSpan: Long,
-    private val store: SortedMap[Long, D] = SortedMap.empty[Long, D],
+    store: SortedMap[Long, D] = SortedMap.empty[Long, D],
 ) {
 
   /** Determine the lastly known data tick, if available. Includes the given

src/main/scala/edu/ie3/simona/agent/participant/ParticipantAgentFundamentals.scala

@@ -54,7 +54,6 @@ import edu.ie3.simona.event.ResultEvent
 import edu.ie3.simona.event.ResultEvent.{
   FlexOptionsResultEvent,
   ParticipantResultEvent,
-  ThermalResultEvent,
 }
 import edu.ie3.simona.event.notifier.NotifierConfig
 import edu.ie3.simona.exceptions.CriticalFailureException
@@ -1912,8 +1911,9 @@ protected trait ParticipantAgentFundamentals[
   def buildResultEvent[R <: ResultEntity](
       result: R
   ): Option[ResultEvent] = result match {
-    case thermalResult: ThermalUnitResult =>
-      Some(ThermalResultEvent(thermalResult))
+    case thermalUnitResult: ThermalUnitResult =>
+      Some(ResultEvent.ThermalResultEvent(thermalUnitResult))
+
     case unsupported =>
       log.debug(
         s"Results of class '${unsupported.getClass.getSimpleName}' are currently not supported."

src/main/scala/edu/ie3/simona/agent/participant/hp/HpAgentFundamentals.scala

@@ -313,7 +313,11 @@ trait HpAgentFundamentals
       calcRelevantData: HpRelevantData,
       nodalVoltage: squants.Dimensionless,
       model: HpModel,
-  ): HpState = model.determineState(modelState, calcRelevantData)
+  ): HpState = {
+    val (_, _, state) =
+      model.determineState(modelState, calcRelevantData)
+    state
+  }
 
   /** Abstract definition, individual implementations found in individual agent
     * fundamental classes
@@ -428,6 +432,12 @@ trait HpAgentFundamentals
     HpRelevantData(
       tick,
       weatherData.temp.inKelvin,
+      baseStateData.startDate,
+      baseStateData.model.thermalGrid.house.map(_.houseInhabitants).getOrElse {
+        throw new InconsistentStateException(
+          s"The model ${baseStateData.model.thermalGrid.house} was not provided with the needed number of inhabitants."
+        )
+      },
     )
   }
 

src/main/scala/edu/ie3/simona/event/ResultEvent.scala

@@ -16,9 +16,19 @@ import edu.ie3.datamodel.models.result.system.{
   FlexOptionsResult,
   SystemParticipantResult,
 }
-import edu.ie3.datamodel.models.result.thermal.ThermalUnitResult
+import edu.ie3.datamodel.models.result.thermal.{
+  CylindricalStorageResult,
+  DomesticHotWaterStorageResult,
+  ThermalHouseResult,
+  ThermalUnitResult,
+}
 import edu.ie3.simona.agent.grid.GridResultsSupport.PartialTransformer3wResult
 import edu.ie3.simona.event.listener.ResultEventListener
+import tech.units.indriya.ComparableQuantity
+
+import java.time.ZonedDateTime
+import java.util.UUID
+import javax.measure.quantity.{Energy, Power, Temperature}
 
 sealed trait ResultEvent extends Event with ResultEventListener.Request
 
@@ -44,6 +54,78 @@ object ResultEvent {
       thermalResult: ThermalUnitResult
   ) extends ResultEvent
 
+  object ThermalHouseResult {
+    def unapply(result: ThermalHouseResult): Option[
+      (
+          ZonedDateTime,
+          UUID,
+          ComparableQuantity[Power],
+          ComparableQuantity[Temperature],
+      )
+    ] = {
+      if (result != null) {
+        Some(
+          (
+            result.getTime,
+            result.getInputModel,
+            result.getqDot,
+            result.getIndoorTemperature,
+          )
+        )
+      } else {
+        None
+      }
+    }
+  }
+
+  object CylindricalThermalStorageResult {
+    def unapply(result: CylindricalStorageResult): Option[
+      (
+          ZonedDateTime,
+          UUID,
+          ComparableQuantity[Power],
+          ComparableQuantity[Energy],
+      )
+    ] = {
+      if (result != null) {
+        Some(
+          (
+            result.getTime,
+            result.getInputModel,
+            result.getqDot,
+            result.getEnergy,
+          )
+        )
+      } else {
+        None
+      }
+    }
+  }
+
+  object DomesticHotWaterStorageResult {
+    def unapply(result: DomesticHotWaterStorageResult): Option[
+      (
+          ZonedDateTime,
+          UUID,
+          ComparableQuantity[Power],
+          ComparableQuantity[Energy],
+      )
+    ] = {
+      if (result != null) {
+        Some(
+          (
+            result.getTime,
+            result.getInputModel,
+            result.getqDot,
+            result.getEnergy,
+          )
+        )
+      } else {
+        None
+      }
+    }
+  }
+
   /** Event that holds all grid calculation results of a power flow calculation.
     * The usage of a type is necessary here, to avoid passing in other instances
     * of [[edu.ie3.datamodel.models.result.ResultEntity]] except of the wanted