fix besmod export and clarify example and variable names

Author: HvanderStok

teaser/data/output/besmod_output.py

@@ -163,16 +163,16 @@ def export_besmod(
     for i, bldg in enumerate(buildings):
         bldg.bldg_height = bldg.number_of_floors * bldg.height_of_floors
         start_time_zones = []
-        width_zones = []
-        amplitude_zones = []
+        hours_set_back_zones = []
+        d_temp_set_back_zones = []
         t_set_zone_nominal = []
         for tz in bldg.thermal_zones:
             heating_profile = tz.use_conditions.heating_profile
-            t_set_nominal, start_time, width, amplitude = _convert_heating_profile(heating_profile)
+            t_set_nominal, start_time, hours_set_back, d_temp_set_back = _convert_heating_profile(heating_profile)
             t_set_zone_nominal.append(t_set_nominal)
-            amplitude_zones.append(amplitude)
+            d_temp_set_back_zones.append(d_temp_set_back)
             start_time_zones.append(start_time)
-            width_zones.append(width)
+            hours_set_back_zones.append(hours_set_back)
 
         bldg_path = os.path.join(path, bldg.name)
         utilities.create_path(bldg_path)
@@ -195,9 +195,9 @@ def write_example_mo(example_template, example):
                     TSetZone_nominal=t_set_zone_nominal,
                     QBuiOld_flow_design=QBuiOld_flow_design[bldg.name],
                     THydSupOld_design=t_hyd_sup_old_design_bldg[bldg.name],
-                    setBakTSetZone_amplitude=amplitude_zones,
-                    setBakTSetZone_startTime=start_time_zones,
-                    setBakTSetZone_width=width_zones))
+                    dTSetBack=d_temp_set_back_zones,
+                    startTimeSetBack=start_time_zones,
+                    hoursSetBack=hours_set_back_zones))
                 model_file.close()
 
         for exp in examples:
@@ -370,8 +370,8 @@ def _convert_heating_profile(heating_profile):
     This function analyzes a 24-hour heating profile to extract:
     - The nominal temperature.
     - Start time of setbacks (if any).
-    - Width of setback intervals.
-    - Amplitude of the heating variation.
+    - hours_set_back of setback intervals.
+    - d_temp_set_back of the heating variation.
 
     Parameters
     ----------
@@ -384,10 +384,10 @@ def _convert_heating_profile(heating_profile):
         Maximum temperature in the profile, used as the nominal set point.
     start_time : int
         Start time of the setback interval in seconds.
-    width : float
-        Width of the setback interval as a percentage of the day.
-    amplitude : float
-        Difference between the minimum and nominal temperatures.
+    hours_set_back : float
+        hours of the setback interval in h.
+    d_temp_set_back : float
+        Absolute difference between the minimum and nominal temperatures.
 
     Raises
     ------
@@ -404,25 +404,25 @@ def _convert_heating_profile(heating_profile):
             change_count += 1
             change_indexes.append(i)
     t_set_zone_nominal = max(heating_profile)
-    amplitude = abs(min(heating_profile) - t_set_zone_nominal)
+    d_temp_set_back = abs(min(heating_profile) - t_set_zone_nominal)
     if change_count == 0:
-        amplitude = 0
+        d_temp_set_back = 0
         start_time = 0
-        width = 1e-50
+        hours_set_back = 0
     elif change_count == 1:
         if heating_profile[0] < heating_profile[-1]:
             start_time = 0
-            width = change_indexes[0]
+            hours_set_back = change_indexes[0]
         else:
             start_time = change_indexes[0] * 3600
-            width = (24 - change_indexes[0])
+            hours_set_back = (24 - change_indexes[0])
     elif change_count == 2:
         start_time = change_indexes[1] * 3600
-        width = (24 - change_indexes[1] + change_indexes[0])
+        hours_set_back = (24 - change_indexes[1] + change_indexes[0])
     else:
         raise ValueError("You have more than two temperature intervals in the heating profile."
                          "BESMod can only handel one heating set back.")
-    return t_set_zone_nominal, start_time, width * 3600, amplitude
+    return t_set_zone_nominal, start_time, hours_set_back, d_temp_set_back
 
 
 def _get_next_higher_year_value(years_dict, given_year):

teaser/data/output/modelicatemplate/BESMod/Example_GasBoilerBuildingOnly

@@ -5,10 +5,9 @@ model GasBoilerBuildingOnly${bldg.name}
     redeclare ${bldg.name} building,
     userProfiles(fileNameIntGains=Modelica.Utilities.Files.loadResource(
         "modelica://${bldg.parent.name}/${bldg.name}/InternalGains_${bldg.name}.txt"),
-        nigSetBack(
-            dTSetBack=${get_list(setBakTSetZone_amplitude)},
-            timeSetBack=${get_list(setBakTSetZone_width)},
-            startTimeSetBack=${get_list(setBakTSetZone_startTime)})),
+        dTSetBack=${get_list(dTSetBack)},
+        hoursSetBack=${get_list(hoursSetBack)},
+        startTimeSetBack=${get_list(startTimeSetBack)}),
     systemParameters(nZones=${len(bldg.thermal_zones)},
                      TSetZone_nominal=${get_list(TSetZone_nominal)},
                      TOda_nominal=${TOda_nominal},

teaser/data/output/modelicatemplate/BESMod/Example_HeatPumpMonoenergetic

@@ -7,10 +7,9 @@ model HeatPumpMonoenergetic${bldg.name}
       energyDynamics=Modelica.Fluid.Types.Dynamics.FixedInitial),
     userProfiles(fileNameIntGains=Modelica.Utilities.Files.loadResource(
       "modelica://${bldg.parent.name}/${bldg.name}/InternalGains_${bldg.name}.txt"),
-      nigSetBack(
-            dTSetBack=${get_list(setBakTSetZone_amplitude)},
-            timeSetBack=${get_list(setBakTSetZone_width)},
-            startTimeSetBack=${get_list(setBakTSetZone_startTime)})),
+      dTSetBack=${get_list(dTSetBack)},
+      hoursSetBack=${get_list(hoursSetBack)},
+      startTimeSetBack=${get_list(startTimeSetBack)}),
     systemParameters(
         nZones=${len(bldg.thermal_zones)},
         TSetZone_nominal=${get_list(TSetZone_nominal)},

teaser/data/output/modelicatemplate/BESMod/Example_TEASERHeatLoadCalculation

@@ -6,10 +6,9 @@ model TEASERHeatLoadCalculation${bldg.name}
     userProfiles(
         fileNameIntGains=Modelica.Utilities.Files.loadResource(
         "modelica://${bldg.parent.name}/${bldg.name}/InternalGains_${bldg.name}.txt"),
-        nigSetBack(
-            dTSetBack=${get_list(setBakTSetZone_amplitude)},
-            timeSetBack=${get_list(setBakTSetZone_width)},
-            startTimeSetBack=${get_list(setBakTSetZone_startTime)})),
+        dTSetBack=${get_list(dTSetBack)},
+        hoursSetBack=${get_list(hoursSetBack)},
+        startTimeSetBack=${get_list(startTimeSetBack)}),
     systemParameters(nZones=${len(bldg.thermal_zones)},
                      TSetZone_nominal=${get_list(TSetZone_nominal)},
                      TOda_nominal=${TOda_nominal},

teaser/examples/e11_export_besmod_models.py

@@ -74,9 +74,37 @@ def example_export_besmod():
 
     # In the examples, the parameters for BESMod.Systems.UserProfiles.TEASERProfiles are configured,
     # including internal gains and heating profiles for each zone.
-    # BESMod requires 24-hour heating profiles, which are used
-    # to define the parameters of the `setBakTSetZone` Pulse block.
+    # BESMod requires 24-hour heating profiles in the export here, which are used
+    # to define the set-back parameters. Setting these parameters directly or the use of TSet file
+    # is not supported in the export here. Either override them later or  use the custom export option shown below.
     # By default, the TEASER profiles are applied, but these can be customized if needed.
+    # For example, we modify the heating profile of the first thermal zone of the first building here:
+    prj.buildings[0].thermal_zones[0].use_conditions.heating_profile = [
+            290.15,  #0-1
+            290.15,  #1-2
+            290.15,  #2-3
+            290.15,  #3-4
+            290.15,  #4-5
+            293.15,  #5-6
+            293.15,  #6-7
+            293.15,  #7-8
+            293.15,  #8-9
+            293.15,  #9-10
+            293.15,  #10-11
+            293.15,  #11-12
+            293.15,  #12-13
+            293.15,  #13-14
+            293.15,  #14-15
+            293.15,  #15-16
+            293.15,  #16-17
+            293.15,  #17-18
+            293.15,  #18-19
+            293.15,  #19-20
+            293.15,  #20-21
+            293.15,  #21-22
+            290.15,  #22-23
+            290.15   #23-24
+        ]
 
     # Additionally, location-specific parameters must be set, which can be achieved using the following function.
     # The default values provided here correspond to Mannheim.
@@ -151,9 +179,9 @@ def example_export_besmod():
     #       redeclare BESMod.Systems.UserProfiles.TEASERProfiles
     #       userProfiles(fileNameIntGains=Modelica.Utilities.Files.loadResource(
     #               "modelica://${bldg.parent.name}/${bldg.name}/InternalGains_${bldg.name}.txt"),
-    #                dTSetBack=${get_list(setBakTSetZone_amplitude)},
-    #                hoursSetBack=${get_list(setBakTSetZone_width)},
-    #                startTimeSetBack=${get_list(setBakTSetZone_startTime)}),
+    #                dTSetBack=${get_list(dTSetBack)},
+    #                hoursSetBack=${get_list(hoursSetBack)},
+    #                startTimeSetBack=${get_list(startTimeSetBack)})),
     #     systemParameters(nZones=${len(bldg.thermal_zones)},
     #                      QBui_flow_nominal = building.QRec_flow_nominal,
     #                      TOda_nominal =${TOda_nominal},