Add autosizing to Spawn

Buildings/Resources/C-Sources/EnergyPlus_24_2_0_Wrapper.c

@@ -36,14 +36,17 @@ void* allocate_Modelica_EnergyPlus_24_2_0(
   const char* idfVersion,
   const char* idfName,
   const char* epwName,
+  const char* epName,
+  const char* hvacZone,
+  const int autosizeHVAC,
+  const int use_sizingPeriods,
   int runPeriod_dayOfWeekForStartDay,
   int runPeriod_applyWeekEndHolidayRule,
   int runPeriod_use_weatherFileDaylightSavingPeriod,
   int runPeriod_use_weatherFileHolidaysAndSpecialDays,
   int runPeriod_use_weatherFileRainIndicators,
   int runPeriod_use_weatherFileSnowIndicators,
   double relativeSurfaceTolerance,
-  const char* epName,
   int usePrecompiledFMU,
   const char* fmuName,
   const char* buildingsRootFileLocation,
@@ -88,9 +91,12 @@ void* allocate_Modelica_EnergyPlus_24_2_0(
       idfVersion,
       idfName,
       epwName,
+      epName,
+      hvacZone,
+      autosizeHVAC,
+      use_sizingPeriods,
       &runPer,
       relativeSurfaceTolerance,
-      epName,
       usePrecompiledFMU,
       fmuName,
       buildingsRootFileLocation,

Buildings/Resources/C-Sources/EnergyPlus_24_2_0_Wrapper.h

@@ -49,9 +49,12 @@ extern void* allocate_Spawn_EnergyPlus_24_2_0(
   const char* idfVersion,
   const char* idfName,
   const char* epwName,
+  const char* epName,
+  const char* hvacZone,
+  const int autosizeHVAC,
+  const int use_sizingPeriods,
   const runPeriod* runPer,
   double relativeSurfaceTolerance,
-  const char* epName,
   int usePrecompiledFMU,
   const char* fmuName,
   const char* buildingsRootFileLocation,

Buildings/Resources/Scripts/travis/pyfmi/runSpawnFromOtherDirectory.py

@@ -79,7 +79,7 @@ def print_output(typ, stream):
 def run_test(pathVariable):
     # List of files to be moved
     fileMoves = [
-        {"src": os.path.abspath(os.path.join("Buildings", "Resources", "bin", "spawn-0.6.0-9f1b36b00b", "linux64")),
+        {"src": os.path.abspath(os.path.join("Buildings", "Resources", "bin", "spawn-0.6.0-5297abe3fb", "linux64")),
          "des": "my-bin"},
         {"src": os.path.abspath(os.path.join("Buildings", "Resources", "weatherdata")),
          "des": "some_weather_directory_that_the_fmu_does_not_know_about"},

Buildings/Resources/src/ThermalZones/EnergyPlus_24_2_0/C-Sources/BuildingInstantiate.c

@@ -62,30 +62,41 @@ void buildJSONKeyDoubleValue(
   buildJSONKeyLiteralValue(buffer, level, key, litVal, addComma, size, SpawnFormatError);
 }
 
-void openJSONModelBracket(char* *buffer, size_t* size, void (*SpawnFormatError)(const char *string, ...)){
-  saveAppend(buffer, "      {\n", size, SpawnFormatError);
+void openJSONModelBracket(char* *buffer, size_t level, size_t* size, void (*SpawnFormatError)(const char *string, ...)){
+  size_t iLevel;
+  for(iLevel = 0; iLevel < level; iLevel++)
+    saveAppend(buffer, "  ", size, SpawnFormatError);
+  saveAppend(buffer, "{\n", size, SpawnFormatError);
 }
 
 void closeJSONModelBracket(
-  char* *buffer, size_t i, size_t iMax, size_t* size,
+  char* *buffer, size_t level, size_t i, size_t iMax, size_t* size,
   void (*SpawnFormatError)(const char *string, ...)){
+  size_t iLevel;
+  for(iLevel = 0; iLevel < level; iLevel++)
+    saveAppend(buffer, "  ", size, SpawnFormatError);
   if (i < iMax -1)
-    saveAppend(buffer, "      },\n", size, SpawnFormatError);
+    saveAppend(buffer, "},\n", size, SpawnFormatError);
   else
-    saveAppend(buffer, "      }\n", size, SpawnFormatError);
+    saveAppend(buffer, "}\n", size, SpawnFormatError);
 }
 
 void closeJSONModelArrayBracket(
-  char* *buffer, size_t iMod, size_t nMod, size_t* size,
+  char* *buffer, size_t level, size_t iMod, size_t nMod, size_t* size,
   void (*SpawnFormatError)(const char *string, ...)){
+
+  size_t iLevel;
+  for(iLevel = 0; iLevel < level; iLevel++)
+    saveAppend(buffer, "  ", size, SpawnFormatError);
+
   /* Close json array bracket */
   if (iMod == nMod){
     /* There are no more other objects that belong to "model" */
-    saveAppend(buffer, "    ]\n", size, SpawnFormatError);
+    saveAppend(buffer, "]\n", size, SpawnFormatError);
   }
   else{
     /* There are other objects that belong to "model" */
-    saveAppend(buffer, "    ],\n", size, SpawnFormatError);
+    saveAppend(buffer, "],\n", size, SpawnFormatError);
   }
 }
 
@@ -117,6 +128,104 @@ char* getStartDayOfYear(
     return day;
 }
 
+void buildJSONModelStructureForEnergyPlusHVACZones(
+  const FMUBuilding* bui, char* *buffer, size_t iMod, size_t nMod, size_t* size){
+  size_t i;
+  size_t iWri;
+  size_t k;
+  size_t iHVACZones;
+  size_t nTheZon = 0;  /* Number of thermal zones */
+  size_t nHVACZones = 0; /* Number of HVACZones */
+  bool recorded;
+  char **arrHVACZones = NULL;
+  size_t *couTheZon = NULL;
+
+  SpawnObject** ptrSpaObj = (SpawnObject**)bui->exchange;
+
+  void (*SpawnFormatError)(const char *string, ...) = bui->SpawnFormatError;
+
+  /* Count how many thermal zones there are in each HVACZone */
+  /* Number of HVAC zones */
+  for(i = 0; i < bui->nExcObj; i++){
+    if ( ptrSpaObj[i]->objectType == THERMALZONE ) {
+      nTheZon++;
+    }
+  }
+  /* Array of names of HVACZone, or NULL if there are no more HVAC zones */
+  arrHVACZones = malloc(nTheZon * sizeof(char*));
+  if (arrHVACZones == NULL){
+    SpawnFormatError("%s", "Failed to allocate array for arrHVACZones.");
+  }
+  for(i = 0; i < nTheZon; i++)
+    arrHVACZones[i] = NULL;
+  /* Build set of names of all HVACZones */
+
+  for(i=0; i < bui->nExcObj; i++){
+      if ( ptrSpaObj[i]->objectType == THERMALZONE ) {
+        /* Check if we already have this HVACZone */
+        recorded = false;
+        for(k = 0; k < i; k++){
+          if ( ptrSpaObj[k]->objectType == THERMALZONE ){
+            if (strcmp(ptrSpaObj[i]->hvacZone, ptrSpaObj[k]->hvacZone) == 0){
+              /* Had the zone already */
+              recorded = true;
+            }
+          }
+        }
+        if (!recorded){
+          arrHVACZones[nHVACZones] = ptrSpaObj[i]->hvacZone;
+          nHVACZones++;
+        }
+    }
+  }
+  /* Create a size_t array with the number of thermal zones in each HVACZone.
+     This is used to avoid the comma after the last thermal zone. */
+  couTheZon = malloc(nHVACZones * sizeof(size_t));
+  if (couTheZon == NULL){
+    SpawnFormatError("%s", "Failed to allocate array for couTheZon.");
+  }
+
+  for(iHVACZones = 0; iHVACZones < nHVACZones; iHVACZones++){
+    couTheZon[iHVACZones] = 0;
+    for(i = 0; i < bui->nExcObj; i++){
+      if ( ptrSpaObj[i]->objectType == THERMALZONE ) {
+        if (strcmp(ptrSpaObj[i]->hvacZone, arrHVACZones[iHVACZones]) == 0){
+          couTheZon[iHVACZones]++;
+        }
+      }
+    }
+  }
+
+  /* Write the "hvacZones" objects */
+  saveAppend(buffer, "    \"", size, SpawnFormatError);
+  saveAppend(buffer, "hvacZones", size, SpawnFormatError);
+  saveAppend(buffer, "\": [\n", size, SpawnFormatError);
+  /* Write all thermalZones that belong to the hvacZone */
+  for(iHVACZones = 0; iHVACZones < nHVACZones; iHVACZones++){
+    openJSONModelBracket(buffer, 3, size, SpawnFormatError);
+    buildJSONKeyStringValue(buffer, 4, "name", arrHVACZones[iHVACZones], true, size, SpawnFormatError);
+    saveAppend(buffer, "          \"zones\": [\n", size, SpawnFormatError);
+
+    for(i = 0, iWri = 0; i < bui->nExcObj; i++){
+      if ( ptrSpaObj[i]->objectType == THERMALZONE ) {
+        /* Check if this thermal zone belongs to the HVACZone */
+        if (strcmp(ptrSpaObj[i]->hvacZone, arrHVACZones[iHVACZones]) == 0){
+          /* Found a match */
+          openJSONModelBracket(buffer, 6, size, SpawnFormatError);
+          buildJSONKeyStringValue(buffer, 6, "name", ptrSpaObj[i]->epName, false, size, SpawnFormatError);
+          closeJSONModelBracket(buffer, 6, iWri, couTheZon[iHVACZones], size, SpawnFormatError);
+          iWri++;
+        }
+      }
+    }
+    /* We are done iterating over all objects, close the array */
+    closeJSONModelArrayBracket(buffer, 5, 0, 0, size, SpawnFormatError);
+    closeJSONModelBracket(buffer, 3, iHVACZones, nHVACZones, size, SpawnFormatError);
+  }
+  closeJSONModelArrayBracket(buffer, 2, iMod, nMod, size, SpawnFormatError);
+  free(arrHVACZones);
+}
+
 void buildJSONModelStructureForEnergyPlus(
   const FMUBuilding* bui, char* *buffer, size_t* size, char** modelHash){
   size_t i;
@@ -154,6 +263,16 @@ void buildJSONModelStructureForEnergyPlus(
   /* weather file */
   buildJSONKeyStringValue(buffer, 2, "weather", bui->weather, true, size, SpawnFormatError);
 
+  /* Flag to request HVAC autosizing */
+  if (bui->autosizeHVAC) {
+    buildJSONKeyLiteralValue(buffer, 2, "autosize", "true", true, size, SpawnFormatError);
+    buildJSONKeyLiteralValue(buffer, 2, "runSimulationForSizingPeriods", bui->use_sizingPeriods ? "true": "false", true, size, SpawnFormatError);
+  }
+  else{
+    buildJSONKeyLiteralValue(buffer, 2, "autosize",                      "false", true, size, SpawnFormatError);
+    buildJSONKeyLiteralValue(buffer, 2, "runSimulationForSizingPeriods", "false", true, size, SpawnFormatError);
+  }
+
   /* Tolerance of solver for surface heat balance */
   buildJSONKeyDoubleValue(buffer, 2, "relativeSurfaceTolerance", bui->relativeSurfaceTolerance,
     false, size, SpawnFormatError);
@@ -191,22 +310,29 @@ void buildJSONModelStructureForEnergyPlus(
           saveAppend(buffer, "\": [\n", size, SpawnFormatError);
         }
         /* Write content */
-        openJSONModelBracket(buffer, size, SpawnFormatError);
+        openJSONModelBracket(buffer, 3, size, SpawnFormatError);
         saveAppend(buffer, ptrSpaObj[i]->jsonKeysValues, size, SpawnFormatError);
         saveAppend(buffer, "\n", size, SpawnFormatError);
-        closeJSONModelBracket(buffer, iWri, objectCount[objectType], size, SpawnFormatError);
+        closeJSONModelBracket(buffer, 3, iWri, objectCount[objectType], size, SpawnFormatError);
         iWri++;
       }
     }
 
     iMod += iWri;
-    if (iWri > 0)
-      closeJSONModelArrayBracket(buffer, iMod, nMod, size, SpawnFormatError);
+    if (iWri > 0){
+      closeJSONModelArrayBracket(buffer, 2, iMod, (objectType == 0) ? 0 : nMod, size, SpawnFormatError);
+    }
+
+    /* After the first object type, which is "zones", we also write the "hvacZones". */
+    if (objectType == 0){
+      buildJSONModelStructureForEnergyPlusHVACZones(bui, buffer, iWri, bui->nExcObj, size);
+    }
   }
 
   /* Close json object for model */
   saveAppend(buffer, "  },\n", size, SpawnFormatError);
 
+  /* Create the model hash */
   *modelHash = (char*)( cryptographicsHash(*buffer, bui->SpawnError) );
 
     /* fmu */
@@ -258,7 +384,7 @@ void writeModelStructureForEnergyPlus(const FMUBuilding* bui, char** modelicaBui
     SpawnFormatError("Failed to open '%s' with write mode.", *modelicaBuildingsJsonFile);
   fprintf(fp, "%s", buffer);
   fclose(fp);
-}
+  }
 
 void setAttributesReal(
   FMUBuilding* bui,

Buildings/Resources/src/ThermalZones/EnergyPlus_24_2_0/C-Sources/SpawnFMU.c

@@ -28,6 +28,8 @@ size_t AllocateBuildingDataStructure(
   const char* idfVersion,
   const char* idfName,
   const char* epwName,
+  const int autosizeHVAC,
+  const int use_sizingPeriods,
   const runPeriod* runPer,
   double relativeSurfaceTolerance,
   int usePrecompiledFMU,
@@ -140,6 +142,9 @@ size_t AllocateBuildingDataStructure(
     SpawnFormatError);
   strcpy(Buildings_FMUS[nFMU]->weather, epwName);
 
+  /* Set flag for autosizing HVAC */
+  Buildings_FMUS[nFMU]->autosizeHVAC = autosizeHVAC;
+  Buildings_FMUS[nFMU]->use_sizingPeriods = use_sizingPeriods;
   /* Assign the RunPeriod object */
   Buildings_FMUS[nFMU]->runPer = malloc(sizeof(runPeriod));
   if ( Buildings_FMUS[nFMU]->runPer == NULL )

Buildings/Resources/src/ThermalZones/EnergyPlus_24_2_0/C-Sources/SpawnFMU.h

@@ -23,10 +23,12 @@ size_t getBuildings_nFMU();
 size_t AllocateBuildingDataStructure(
   double startTime,
   const char* modelicaNameBuilding,
-  const char* idfName,
-  const char* epwName,
   const char* spawnExe,
   const char* idfVersion,
+  const char* idfName,
+  const char* epwName,
+  const int autosizeHVAC,
+  const int use_sizingPeriods,
   const runPeriod* runPer,
   double relativeSurfaceTolerance,
   int usePrecompiledFMU,

Buildings/Resources/src/ThermalZones/EnergyPlus_24_2_0/C-Sources/SpawnObjectAllocate.c

@@ -95,9 +95,12 @@ void* allocate_Spawn_EnergyPlus_24_2_0(
   const char* idfVersion,
   const char* idfName,
   const char* epwName,
+  const char* epName,
+  const char* hvacZone,
+  const int autosizeHVAC,
+  const int use_sizingPeriods,
   const runPeriod* runPer,
   double relativeSurfaceTolerance,
-  const char* epName,
   int usePrecompiledFMU,
   const char* fmuName,
   const char* buildingsRootFileLocation,
@@ -200,6 +203,22 @@ void* allocate_Spawn_EnergyPlus_24_2_0(
     SpawnFormatError);
   strcpy(ptrSpaObj->modelicaName, modelicaName);
 
+  /* Assign the EnergyPlus instance name */
+  mallocString(
+    strlen(epName)+1,
+    "Not enough memory in allocate_Spawn_EnergyPlus_9_6_0.c. to allocate EnergyPlus instance name.",
+    &(ptrSpaObj->epName),
+    SpawnFormatError);
+  strcpy(ptrSpaObj->epName, epName);
+
+  /* Assign the HVAC zone name */
+  mallocString(
+    strlen(hvacZone)+1,
+    "Not enough memory in allocate_Spawn_EnergyPlus_9_6_0.c. to allocate HVAC zone name.",
+    &(ptrSpaObj->hvacZone),
+    SpawnFormatError);
+  strcpy(ptrSpaObj->hvacZone, hvacZone);
+
   /* Assign the json name */
   mallocString(
     strlen(jsonName)+1,
@@ -326,6 +345,8 @@ void* allocate_Spawn_EnergyPlus_24_2_0(
       idfVersion,
       idfName,
       epwName,
+      autosizeHVAC,
+      use_sizingPeriods,
       runPer,
       relativeSurfaceTolerance,
       usePrecompiledFMU,

Buildings/Resources/src/ThermalZones/EnergyPlus_24_2_0/C-Sources/SpawnObjectAllocate.h

@@ -20,9 +20,12 @@ LBNL_Spawn_EXPORT void* allocate_Spawn_EnergyPlus_24_2_0(
   const char* idfVersion,
   const char* idfName,
   const char* epwName,
+  const char* epName,
+  const char* hvacZone,
+  const int autosizeHVAC,
+  const int use_sizingPeriods,
   const runPeriod* runPer,
   double relativeSurfaceTolerance,
-  const char* epName,
   int usePrecompiledFMU,
   const char* fmuName,
   const char* buildingsRootFileLocation,

Buildings/Resources/src/ThermalZones/EnergyPlus_24_2_0/C-Sources/SpawnTypes.h

@@ -86,6 +86,8 @@ typedef struct FMUBuilding
   char* idfVersion; /* IDF version with underscores, such as 24_2_0. This must be the same as is used as suffix for Buildings.ThermalZones.EnergyPlus_ */
   fmi2Byte* idfName; /* if usePrecompiledFMU == true, the user-specified fmu name, else the idf name */
   fmi2Byte* weather;
+  bool autosizeHVAC; /* If true, EnergyPlus is requested to run the HVAC sizing calculations */
+  bool use_sizingPeriods; /* If true, run HVAC sizing calculations on all the included SizingPeriod objects in the idf file */
   runPeriod* runPer; /* EnergyPlus RunPeriod */
   double relativeSurfaceTolerance; /* Relative surface tolerance for heat balance calculations */
   size_t nExcObj; /* Number of exc that use this FMU */
@@ -135,7 +137,8 @@ typedef struct SpawnObject
   int objectType; /* Type of the EnergyPlus object */
   FMUBuilding* bui; /* Pointer to building with this zone */
   char* modelicaName; /* Name of the Modelica instance of this zone */
-
+  char* epName; /* Name of the EnergyPlus instance in the idf file */
+  char* hvacZone;     /* Name of the HVAC zone that this room belongs to. For other objects, this will be "n/a". */
   char* jsonName;        /* Name of the json keyword */
   char* jsonKeysValues;  /* Keys and values string to be written to the json configuration file */
   char** parOutNames;

Buildings/Resources/src/ThermalZones/EnergyPlus_24_2_0/install.py

@@ -23,7 +23,7 @@
 # build_type is either custom or builds
 spawn_dists = [
     {"version": "0.6.0",
-     "commit": "9f1b36b00b",
+     "commit": "5297abe3fb",
      "build_type": "custom"}
 ]
 ###########################################################################