Merge branch 'dev' into sp/#1202-flex-result-to-em

ie3-institute · Feb 18, 2025 · 09cd24e · 09cd24e
2 parents 5202f66 + 6ad5199
commit 09cd24e
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 32 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -133,6 +133,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Removing generated methods and cleaning up in config [#1170](https://github.com/ie3-institute/simona/issues/1170)
 - Changed `pvInput` values in `PvInputTestData` to more realistic values [#1144](https://github.com/ie3-institute/simona/issues/1144)
 - Refactor `RuntimeConfig` [#1172](https://github.com/ie3-institute/simona/issues/1172)
+- Renamed some methods and variables within `ThermalGrid` and `ThermalHouse` [#1193](https://github.com/ie3-institute/simona/issues/1193)
 
 ### Fixed
 - Fix rendering of references in documentation [#505](https://github.com/ie3-institute/simona/issues/505)

diff --git a/src/main/scala/edu/ie3/simona/model/thermal/ThermalGrid.scala b/src/main/scala/edu/ie3/simona/model/thermal/ThermalGrid.scala
@@ -67,7 +67,7 @@ final case class ThermalGrid(
       house.zip(lastHpState.thermalGridState.houseState) match {
         case Some((thermalHouse, lastHouseState)) =>
           val (updatedHouseState, _) =
-            thermalHouse.determineState(
+            thermalHouse.updateState(
               relevantData,
               lastHouseState,
               lastHpState.ambientTemperature.getOrElse(
@@ -476,7 +476,7 @@ final case class ThermalGrid(
   ): (Option[ThermalHouseState], Option[ThermalThreshold], Power) = {
     (house, state.houseState) match {
       case (Some(thermalHouse), Some(lastHouseState)) =>
-        val (newState, threshold) = thermalHouse.determineState(
+        val (newState, threshold) = thermalHouse.updateState(
           relevantData,
           lastHouseState,
           lastAmbientTemperature,
@@ -489,7 +489,7 @@ final case class ThermalGrid(
           )
         ) {
           val (fullHouseState, maybeFullHouseThreshold) =
-            thermalHouse.determineState(
+            thermalHouse.updateState(
               relevantData,
               lastHouseState,
               lastAmbientTemperature,
@@ -580,8 +580,8 @@ final case class ThermalGrid(
     /* House will be left with no influx in all cases. Determine if and when a threshold is reached */
     val maybeUpdatedHouseState =
       house.zip(lastThermalGridState.houseState).map {
-        case (house, houseState) =>
-          house.determineState(
+        case (thermalHouse, houseState) =>
+          thermalHouse.updateState(
             relevantData,
             houseState,
             lastAmbientTemperature,
@@ -678,7 +678,7 @@ final case class ThermalGrid(
           )
         ),
       )
-      val revisedHouseState = thermalHouse.determineState(
+      val revisedHouseState = thermalHouse.updateState(
         relevantData,
         formerHouseState.getOrElse(
           throw new InconsistentStateException(

diff --git a/src/main/scala/edu/ie3/simona/model/thermal/ThermalHouse.scala b/src/main/scala/edu/ie3/simona/model/thermal/ThermalHouse.scala
@@ -16,7 +16,7 @@ import edu.ie3.simona.model.participant.HpModel.HpRelevantData
 import edu.ie3.simona.model.thermal.ThermalGrid.ThermalEnergyDemand
 import edu.ie3.simona.model.thermal.ThermalHouse.ThermalHouseThreshold.{
   HouseTemperatureLowerBoundaryReached,
-  HouseTemperatureUpperBoundaryReached,
+  HouseTemperatureTargetOrUpperBoundaryReached,
 }
 import edu.ie3.simona.model.thermal.ThermalHouse.{
   ThermalHouseState,
@@ -234,7 +234,7 @@ final case class ThermalHouse(
     * @return
     *   Updated state and the tick in which the next threshold is reached
     */
-  def determineState(
+  def updateState(
       relevantData: HpRelevantData,
       state: ThermalHouseState,
       lastAmbientTemperature: Temperature,
@@ -315,7 +315,7 @@ final case class ThermalHouse(
         upperBoundaryTemperature,
         innerTemperature,
         resultingQDot,
-      ).map(HouseTemperatureUpperBoundaryReached)
+      ).map(HouseTemperatureTargetOrUpperBoundaryReached)
     } else {
       /* House is in perfect balance */
       None
@@ -399,7 +399,7 @@ object ThermalHouse {
     final case class HouseTemperatureLowerBoundaryReached(
         override val tick: Long
     ) extends ThermalThreshold
-    final case class HouseTemperatureUpperBoundaryReached(
+    final case class HouseTemperatureTargetOrUpperBoundaryReached(
         override val tick: Long
     ) extends ThermalThreshold
   }

diff --git a/src/test/scala/edu/ie3/simona/model/participant/HpModelSpec.scala b/src/test/scala/edu/ie3/simona/model/participant/HpModelSpec.scala
@@ -11,7 +11,7 @@ import edu.ie3.simona.model.thermal.ThermalGrid.ThermalGridState
 import edu.ie3.simona.model.thermal.ThermalHouse.ThermalHouseState
 import edu.ie3.simona.model.thermal.ThermalHouse.ThermalHouseThreshold.{
   HouseTemperatureLowerBoundaryReached,
-  HouseTemperatureUpperBoundaryReached,
+  HouseTemperatureTargetOrUpperBoundaryReached,
 }
 import edu.ie3.simona.model.thermal.ThermalStorage.ThermalStorageState
 import edu.ie3.simona.ontology.messages.flex.MinMaxFlexibilityMessage.ProvideMinMaxFlexOptions
@@ -55,7 +55,7 @@ class HpModelSpec
             true,
             95,
             15.6,
-            Some(HouseTemperatureUpperBoundaryReached(31711)),
+            Some(HouseTemperatureTargetOrUpperBoundaryReached(31711)),
           ),
           (
             HpState(
@@ -70,7 +70,7 @@ class HpModelSpec
             true,
             95,
             16.4,
-            Some(HouseTemperatureUpperBoundaryReached(30642)),
+            Some(HouseTemperatureTargetOrUpperBoundaryReached(30642)),
           ),
           (
             HpState(
@@ -85,7 +85,7 @@ class HpModelSpec
             true,
             95,
             18.0,
-            Some(HouseTemperatureUpperBoundaryReached(27771)),
+            Some(HouseTemperatureTargetOrUpperBoundaryReached(27771)),
           ),
           (
             HpState(
@@ -450,7 +450,7 @@ class HpModelSpec
                   Some(ThermalHouseState(0L, Celsius(21), Kilowatts(0))),
                   Some(ThermalStorageState(0L, KilowattHours(0), Kilowatts(0))),
                 ),
-                Some(HouseTemperatureUpperBoundaryReached(0L)),
+                Some(HouseTemperatureTargetOrUpperBoundaryReached(0L)),
               ),
               (95.0, 0.0, 95.0),
             ),
@@ -471,7 +471,7 @@ class HpModelSpec
                   Some(ThermalHouseState(0L, Celsius(21), Kilowatts(0))),
                   Some(ThermalStorageState(0L, KilowattHours(20), Kilowatts(0))),
                 ),
-                Some(HouseTemperatureUpperBoundaryReached(0L)),
+                Some(HouseTemperatureTargetOrUpperBoundaryReached(0L)),
               ),
               (95.0, 0.0, 95.0),
             ),
@@ -494,7 +494,7 @@ class HpModelSpec
                   Some(ThermalHouseState(0L, Celsius(21), Kilowatts(0))),
                   Some(ThermalStorageState(0L, KilowattHours(0), Kilowatts(0))),
                 ),
-                Some(HouseTemperatureUpperBoundaryReached(0L)),
+                Some(HouseTemperatureTargetOrUpperBoundaryReached(0L)),
               ),
               (95.0, 0.0, 95.0),
             ),
@@ -515,7 +515,7 @@ class HpModelSpec
                   Some(ThermalHouseState(0L, Celsius(21), Kilowatts(0))),
                   Some(ThermalStorageState(0L, KilowattHours(20), Kilowatts(0))),
                 ),
-                Some(HouseTemperatureUpperBoundaryReached(0L)),
+                Some(HouseTemperatureTargetOrUpperBoundaryReached(0L)),
               ),
               (0.0, 0.0, 95.0),
             ),
@@ -539,7 +539,7 @@ class HpModelSpec
                   Some(ThermalHouseState(0L, Celsius(21), Kilowatts(0))),
                   Some(ThermalStorageState(0L, KilowattHours(0), Kilowatts(0))),
                 ),
-                Some(HouseTemperatureUpperBoundaryReached(0L)),
+                Some(HouseTemperatureTargetOrUpperBoundaryReached(0L)),
               ),
               (95.0, 0.0, 95.0),
             ),
@@ -560,7 +560,7 @@ class HpModelSpec
                   Some(ThermalHouseState(0L, Celsius(21), Kilowatts(0))),
                   Some(ThermalStorageState(0L, KilowattHours(20), Kilowatts(0))),
                 ),
-                Some(HouseTemperatureUpperBoundaryReached(0L)),
+                Some(HouseTemperatureTargetOrUpperBoundaryReached(0L)),
               ),
               (95.0, 0.0, 95.0),
             ),
@@ -583,7 +583,7 @@ class HpModelSpec
                   Some(ThermalHouseState(0L, Celsius(21), Kilowatts(0))),
                   Some(ThermalStorageState(0L, KilowattHours(0), Kilowatts(0))),
                 ),
-                Some(HouseTemperatureUpperBoundaryReached(0L)),
+                Some(HouseTemperatureTargetOrUpperBoundaryReached(0L)),
               ),
               (95.0, 0.0, 95.0),
             ),
@@ -605,7 +605,7 @@ class HpModelSpec
                   Some(ThermalHouseState(0L, Celsius(21), Kilowatts(0))),
                   Some(ThermalStorageState(0L, KilowattHours(20), Kilowatts(0))),
                 ),
-                Some(HouseTemperatureUpperBoundaryReached(0L)),
+                Some(HouseTemperatureTargetOrUpperBoundaryReached(0L)),
               ),
               (0.0, 0.0, 95.0),
             ),
@@ -628,7 +628,7 @@ class HpModelSpec
                     ThermalStorageState(0L, KilowattHours(500), Kilowatts(0))
                   ),
                 ),
-                Some(HouseTemperatureUpperBoundaryReached(0L)),
+                Some(HouseTemperatureTargetOrUpperBoundaryReached(0L)),
               ),
               (0.0, 0.0, 95.0),
             ),
@@ -651,7 +651,7 @@ class HpModelSpec
                     ThermalStorageState(0L, KilowattHours(500), Kilowatts(0))
                   ),
                 ),
-                Some(HouseTemperatureUpperBoundaryReached(0L)),
+                Some(HouseTemperatureTargetOrUpperBoundaryReached(0L)),
               ),
               (0.0, 0.0, 0.0),
             ),

diff --git a/src/test/scala/edu/ie3/simona/model/thermal/ThermalGridWithHouseAndStorageSpec.scala b/src/test/scala/edu/ie3/simona/model/thermal/ThermalGridWithHouseAndStorageSpec.scala
@@ -12,7 +12,7 @@ import edu.ie3.simona.model.thermal.ThermalGrid.ThermalGridState
 import edu.ie3.simona.model.thermal.ThermalHouse.ThermalHouseState
 import edu.ie3.simona.model.thermal.ThermalHouse.ThermalHouseThreshold.{
   HouseTemperatureLowerBoundaryReached,
-  HouseTemperatureUpperBoundaryReached,
+  HouseTemperatureTargetOrUpperBoundaryReached,
 }
 import edu.ie3.simona.model.thermal.ThermalStorage.ThermalStorageState
 import edu.ie3.simona.model.thermal.ThermalStorage.ThermalStorageThreshold.{
@@ -354,7 +354,7 @@ class ThermalGridWithHouseAndStorageSpec
               ),
               testGridQDotInfeed,
             ),
-            Some(HouseTemperatureUpperBoundaryReached(3600L)),
+            Some(HouseTemperatureTargetOrUpperBoundaryReached(3600L)),
           )
         )
         val maybeStorageState = Some(
@@ -488,7 +488,11 @@ class ThermalGridWithHouseAndStorageSpec
                 Some(
                   (
                     ThermalHouseState(houseTick, _, revisedQDotHouse),
-                    Some(HouseTemperatureUpperBoundaryReached(houseWarmTick)),
+                    Some(
+                      HouseTemperatureTargetOrUpperBoundaryReached(
+                        houseWarmTick
+                      )
+                    ),
                   )
                 ),
                 Some(
@@ -562,7 +566,7 @@ class ThermalGridWithHouseAndStorageSpec
           case _ => fail("Thermal grid state has been calculated wrong.")
         }
         reachedThreshold shouldBe Some(
-          HouseTemperatureUpperBoundaryReached(7372L)
+          HouseTemperatureTargetOrUpperBoundaryReached(7372L)
         )
       }
 

diff --git a/src/test/scala/edu/ie3/simona/model/thermal/ThermalGridWithHouseOnlySpec.scala b/src/test/scala/edu/ie3/simona/model/thermal/ThermalGridWithHouseOnlySpec.scala
@@ -12,7 +12,7 @@ import edu.ie3.simona.model.thermal.ThermalGrid.ThermalGridState
 import edu.ie3.simona.model.thermal.ThermalHouse.ThermalHouseState
 import edu.ie3.simona.model.thermal.ThermalHouse.ThermalHouseThreshold.{
   HouseTemperatureLowerBoundaryReached,
-  HouseTemperatureUpperBoundaryReached,
+  HouseTemperatureTargetOrUpperBoundaryReached,
 }
 import edu.ie3.simona.test.common.UnitSpec
 import edu.ie3.util.scala.quantities.DefaultQuantities.{zeroKW, zeroKWh}
@@ -216,7 +216,7 @@ class ThermalGridWithHouseOnlySpec extends UnitSpec with ThermalHouseTestData {
           case _ => fail("Thermal grid state has been calculated wrong.")
         }
         reachedThreshold shouldBe Some(
-          HouseTemperatureUpperBoundaryReached(7372L)
+          HouseTemperatureTargetOrUpperBoundaryReached(7372L)
         )
       }
     }
@@ -238,7 +238,9 @@ class ThermalGridWithHouseOnlySpec extends UnitSpec with ThermalHouseTestData {
                   Some(ThermalHouseState(tick, innerTemperature, qDot)),
                   None,
                 ),
-                Some(HouseTemperatureUpperBoundaryReached(thresholdTick)),
+                Some(
+                  HouseTemperatureTargetOrUpperBoundaryReached(thresholdTick)
+                ),
               ) =>
             tick shouldBe 0L
             innerTemperature should approximate(Celsius(18.9999d))

diff --git a/src/test/scala/edu/ie3/simona/model/thermal/ThermalHouseSpec.scala b/src/test/scala/edu/ie3/simona/model/thermal/ThermalHouseSpec.scala
@@ -78,7 +78,7 @@ class ThermalHouseSpec extends UnitSpec with HpInputTestData {
       val initialHousestate = startingState(house)
       val lastAmbientTemperature = Temperature(15, Celsius)
 
-      val (thermalHouseState, threshold) = house.determineState(
+      val (thermalHouseState, threshold) = house.updateState(
         relevantData,
         initialHousestate,
         lastAmbientTemperature,