Translate EMS Example Files to PythonPlugin

src/EnergyPlus/EMSManager.cc

@@ -304,7 +304,10 @@ namespace EMSManager {
         anyProgramRan = false;
         if (!AnyEnergyManagementSystemInModel) return; // quick return if nothing to do
 
-        if (iCalledFrom == DataGlobals::emsCallFromBeginNewEvironment) BeginEnvrnInitializeRuntimeLanguage();
+        if (iCalledFrom == DataGlobals::emsCallFromBeginNewEvironment) {
+            BeginEnvrnInitializeRuntimeLanguage();
+            PluginManagement::onBeginEnvironment();
+        }
 
         InitEMS(iCalledFrom);
 

src/EnergyPlus/PluginManager.cc

@@ -407,6 +407,17 @@ namespace PluginManagement {
         callbacks[iCalledFrom].push_back(f);
     }
 
+    void onBeginEnvironment() {
+        // reset vars and trends -- sensors and actuators are reset by EMS
+        for (auto & v : globalVariableValues) {
+            v = 0;
+        }
+        // reinitialize trend variables so old data are purged
+        for (auto & tr : trends) {
+            tr.reset();
+        }
+    }
+
     int PluginManager::numActiveCallbacks()
     {
         return (int)callbacks.size();
@@ -422,8 +433,8 @@ namespace PluginManagement {
 #if LINK_WITH_PYTHON == 1
         for (auto &plugin : plugins) {
             if (plugin.runDuringWarmup || !DataGlobals::WarmupFlag) {
-                plugin.run(iCalledFrom);
-                anyRan = true;
+                bool const didOneRun = plugin.run(iCalledFrom);
+                if (didOneRun) anyRan = true;
             }
         }
 #endif
@@ -1191,8 +1202,9 @@ namespace PluginManagement {
     }
 
 #if LINK_WITH_PYTHON == 1
-    void PluginInstance::run(int iCalledFrom) const
+    bool PluginInstance::run(int iCalledFrom) const
     {
+        // returns true if a plugin actually ran
         const char *functionName = nullptr;
         if (iCalledFrom == DataGlobals::emsCallFromBeginNewEvironment) {
             if (this->bHasBeginNewEnvironment) {
@@ -1266,7 +1278,7 @@ namespace PluginManagement {
 
         // leave if we didn't find a match
         if (!functionName) {
-            return;
+            return false;
         }
 
         // then call the main function
@@ -1297,10 +1309,12 @@ namespace PluginManagement {
         if (EnergyPlus::PluginManagement::apiErrorFlag) {
             EnergyPlus::ShowFatalError("API problems encountered while running plugin cause program termination.");
         }
+        return true;
     }
 #else
-    void PluginInstance::run(int EP_UNUSED(iCalledFrom)) const
+    bool PluginInstance::run(int EP_UNUSED(iCalledFrom)) const
     {
+        return false;
     }
 #endif
 

src/EnergyPlus/PluginManager.hh

@@ -63,6 +63,7 @@ namespace PluginManagement {
 
     void registerNewCallback(int iCalledFrom, const std::function<void ()>& f);
     void runAnyRegisteredCallbacks(int iCalledFrom, bool &anyRan);
+    void onBeginEnvironment();
     std::string pythonStringForUsage();
 
     void clear_state();
@@ -96,7 +97,7 @@ namespace PluginManagement {
 
         // methods
         static void reportPythonError();
-        void run(int iCallingPoint) const; // calls main() on this plugin instance
+        bool run(int iCallingPoint) const; // calls main() on this plugin instance
 
         // plugin calling point hooks
         const char * sHookBeginNewEnvironment = "on_begin_new_environment";
@@ -185,6 +186,12 @@ namespace PluginManagement {
                 this->times.push_back(-loop * DataGlobals::TimeStepZone);
             }
         }
+        void reset() {
+            this->values.clear();
+            for (int i = 1; i <= this->numValues; i++) {
+                this->values.push_back(0);
+            }
+        }
     };
 
     extern std::unique_ptr<PluginManager> pluginManager;

src/EnergyPlus/RuntimeLanguageProcessor.cc

@@ -3060,7 +3060,7 @@ namespace RuntimeLanguageProcessor {
                             }
                         } else if (UnitsB == "" && UnitsA != "") {
                             UnitsB = UnitsA;
-                            ShowWarningError(RoutineName + cCurrentModuleObject + "=\"" + cAlphaArgs(1) + " using deprecated units designation.");
+                            ShowWarningError(RoutineName + cCurrentModuleObject + "=\"" + cAlphaArgs(1) + "\" using deprecated units designation.");
                             ShowContinueError("...Units entered in " + cAlphaFieldNames(1) + " (deprecated use)=\"" + UnitsA + "\"");
                         }
                     }
@@ -3228,7 +3228,7 @@ namespace RuntimeLanguageProcessor {
                             }
                         } else if (UnitsB == "" && UnitsA != "") {
                             UnitsB = UnitsA;
-                            ShowWarningError(RoutineName + cCurrentModuleObject + "=\"" + cAlphaArgs(1) + " using deprecated units designation.");
+                            ShowWarningError(RoutineName + cCurrentModuleObject + "=\"" + cAlphaArgs(1) + "\" using deprecated units designation.");
                             ShowContinueError("...Units entered in " + cAlphaFieldNames(1) + " (deprecated use)=\"" + UnitsA + "\"");
                         }
                     }

testfiles/CMakeLists.txt

@@ -415,14 +415,23 @@ ADD_SIMULATION_TEST(IDF_FILE PurchAirWithDaylightingAndShadeControl.idf EPW_FILE
 ADD_SIMULATION_TEST(IDF_FILE PurchAirWithDaylightingAngleFac.idf EPW_FILE USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw)
 ADD_SIMULATION_TEST(IDF_FILE PurchAirWithDoubleFacadeDaylighting.idf EPW_FILE USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw)
 if (LINK_WITH_PYTHON)
+ADD_SIMULATION_TEST(IDF_FILE PythonPluginAirflowNetworkOpeningControlByHumidity.idf EPW_FILE USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw)
+ADD_SIMULATION_TEST(IDF_FILE PythonPluginConstantVolumePurchasedAir.idf EPW_FILE USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw)
+ADD_SIMULATION_TEST(IDF_FILE PythonPluginCurveOverride_PackagedTerminalHeatPump.idf EPW_FILE USA_FL_Miami.Intl.AP.722020_TMY3.epw)
 ADD_SIMULATION_TEST(IDF_FILE PythonPluginCustomOutputVariable.idf EPW_FILE USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw)
-ADD_SIMULATION_TEST(IDF_FILE PythonPluginCustomTrendVariable.idf EPW_FILE USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw)
 ADD_SIMULATION_TEST(IDF_FILE PythonPluginCustomSchedule.idf EPW_FILE USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw)
-ADD_SIMULATION_TEST(IDF_FILE PythonPluginLrgOff_GridStorageSmoothing.idf EPW_FILE USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw)
-ADD_SIMULATION_TEST(IDF_FILE PythonPluginWindowShadeControl.idf EPW_FILE USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw)
+ADD_SIMULATION_TEST(IDF_FILE PythonPluginDemandManager_LargeOffice.idf EPW_FILE USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw)
 ADD_SIMULATION_TEST(IDF_FILE PythonPluginDiscreteAirSystemSizes.idf EPW_FILE USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw)
+ADD_SIMULATION_TEST(IDF_FILE PythonPluginPlantLoopOverrideControl.idf EPW_FILE USA_FL_Orlando.Intl.AP.722050_TMY3.epw)
+ADD_SIMULATION_TEST(IDF_FILE PythonPluginPlantOperation_largeOff.idf EPW_FILE USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw)
+ADD_SIMULATION_TEST(IDF_FILE PythonPluginReplaceTraditionalManagers_LargeOffice.idf EPW_FILE USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw)
 ADD_SIMULATION_TEST(IDF_FILE PythonPluginTestMathAndKill.idf EPW_FILE USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw EXPECT_FATAL)  # Expected to Fatal
+ADD_SIMULATION_TEST(IDF_FILE PythonPluginThermochromicWindow.idf EPW_FILE USA_NV_Las.Vegas-McCarran.Intl.AP.723860_TMY3.epw)
 ADD_SIMULATION_TEST(IDF_FILE PythonPluginUserDefined5ZoneAirCooled.idf EPW_FILE USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw)
+ADD_SIMULATION_TEST(IDF_FILE PythonPluginUserDefinedWindACAuto.idf EPW_FILE USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw)
+ADD_SIMULATION_TEST(IDF_FILE PythonPluginWindowShadeControl.idf EPW_FILE USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw)
+ADD_SIMULATION_TEST(IDF_FILE PythonPluginLrgOff_GridStorageSmoothing.idf EPW_FILE USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw)
+ADD_SIMULATION_TEST(IDF_FILE PythonPluginCustomTrendVariable.idf EPW_FILE USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw)
 endif()
 ADD_SIMULATION_TEST(IDF_FILE QTFtest.idf EPW_FILE USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw)
 ADD_SIMULATION_TEST(IDF_FILE RadHiTempElecTermReheat.idf EPW_FILE USA_IL_Chicago-OHare.Intl.AP.725300_TMY3.epw)

testfiles/EMSCurveOverride_PackagedTerminalHeatPump.idf

@@ -2115,3 +2115,6 @@
     HTML;                    !- Column Separator
 
 !-   ===========  ALL OBJECTS IN CLASS: OUTPUT:VARIABLE ===========
+  Output:Variable,Zone1PTHPDXCoolCoil,Cooling Coil Total Cooling Rate,timestep;
+  Output:Variable,Zone2PTHPDXCoolCoil,Cooling Coil Total Cooling Rate,timestep;
+  Output:Variable,Zone3PTHPDXCoolCoil,Cooling Coil Total Cooling Rate,timestep;

testfiles/EMSUserDefinedWindACAuto.idf

@@ -1716,6 +1716,8 @@
 
   Output:Variable,*,Zone 1 WinAC Electricity Power,hourly;
 
+  Output:Variable,*,Zone 1 WinAC Electricity Consumption,hourly;
+
   Output:Variable,Zone1WindACAirOutletNode,System Node Mass Flow Rate,hourly;
 
   Output:Variable,Zone2WindACAirOutletNode,System Node Mass Flow Rate,hourly;