Refactor external shading schedule checks into one method, and move it downsteam closer to other related checks.

Author: joseph-robertson

src/EnergyPlus/HeatBalanceManager.cc

@@ -1822,15 +1822,6 @@ namespace HeatBalanceManager {
         // SetupZoneGeometry includes the call to GetSurfaceData for
         // populating surfData = state.dataSurface.
         SurfaceGeometry::SetupZoneGeometry(state, ErrorsFound);
-
-        // Surface schedule consistency checks need surfaces to be populated, but
-        // Imported shading can set external shading schedule in the same
-        // way that sunlit fraction schedule can.
-        if (state.dataSysVars->shadingMethod == DataSystemVariables::ShadingMethod::Scheduled) {
-            SolarShading::checkScheduledSurfacePresent(state);
-        } else if (state.dataSysVars->shadingMethod != DataSystemVariables::ShadingMethod::Imported) {
-            SolarShading::checkNotScheduledOrImportedSurfacePresent(state);
-        }
     }
 
     void GetZoneData(EnergyPlusData &state, bool &ErrorsFound) // If errors found in input

src/EnergyPlus/SolarShading.cc

@@ -197,6 +197,7 @@ void InitSolarCalculations(EnergyPlusData &state)
         if (state.dataSolarShading->GetInputFlag) {
             checkShadingSurfaceSchedules(state);
             processShadowingInput(state);
+            checkSurfaceExternalShadingSchedules(state);
             state.dataSolarShading->GetInputFlag = false;
             state.dataSolarShading->MaxHCV =
                 (((max(15, s_surf->MaxVerticesPerSurface) + 16) / 16) * 16) - 1; // Assure MaxHCV+1 is multiple of 16 for 128 B alignment
@@ -760,13 +761,8 @@ void processShadowingInput(EnergyPlusData &state)
 
     if (state.dataSysVars->shadingMethod == DataSystemVariables::ShadingMethod::Imported) {
         for (auto &surf : state.dataSurface->Surface) {
-            if ((surf.surfExternalShadingSched = Sched::GetSchedule(state, surf.Name + "_shading")) != nullptr) {
+            if ((surf.surfExternalShadingSched = Sched::GetSchedule(state, Util::makeUPPER(surf.Name + "_shading"))) != nullptr) {
                 surf.SurfSchedExternalShadingFrac = true;
-            } else {
-                ShowWarningError(
-                    state,
-                    EnergyPlus::format("processShadowingInput: sunlit fraction schedule not found for {} when using ImportedShading.", surf.Name));
-                ShowContinueError(state, "These values are set to 1.0.");
             }
         }
     }
@@ -828,9 +824,11 @@ void processShadowingInput(EnergyPlusData &state)
     }
 }
 
-void checkScheduledSurfacePresent(EnergyPlusData &state)
+void checkSurfaceExternalShadingSchedules(EnergyPlusData &state)
 {
-    // User has chosen "Scheduled" for shading calculation method so check to see which surfaces don't have a schedule.
+    // #9275: refactor warnings around Shadow Calculation Method and sunlit fraction schedules.
+    // - User has chosen "Scheduled" or "Imported" for shading calculation method so check to see which surfaces don't have a schedule.
+    // - User has *not* chosen "Scheduled" or "Imported" for shading calculation method so check to see which surfaces *have* a schedule.
     int numNotDef = 0;
     int constexpr maxErrMessages = 50;
     auto &surfData = state.dataSurface;
@@ -840,51 +838,49 @@ void checkScheduledSurfacePresent(EnergyPlusData &state)
              thisSurf.Class == SurfaceClass::Overhang || thisSurf.Class == SurfaceClass::Fin)) {
             continue; // skip shading surfaces
         }
-        if (!thisSurf.SurfSchedExternalShadingFrac) {
-            numNotDef += 1;
-            if (numNotDef == 1) {
-                ShowWarningError(
-                    state,
-                    EnergyPlus::format("ShadowCalculation specified Scheduled for the Shading Calculation Method but no schedule provided for {}.",
-                                       thisSurf.Name));
-                ShowContinueError(
-                    state, "When Scheduled is selected for the Shading Calculation Method and no schedule is provided for a particular surface,");
-                ShowContinueError(
-                    state, "EnergyPlus will assume that the surface is not shaded.  Use SurfaceProperty:LocalEnvironment to specify a schedule");
-                ShowContinueError(state, "for sunlit fraction if this was not desired.  Otherwise, this surface will not be shaded at all.");
-            } else if (numNotDef <= maxErrMessages) {
-                ShowWarningError(
-                    state, EnergyPlus::format("No schedule was provided for {} either.  See above error message for more details.", thisSurf.Name));
+        if ((state.dataSysVars->shadingMethod == DataSystemVariables::ShadingMethod::Scheduled) ||
+            (state.dataSysVars->shadingMethod == DataSystemVariables::ShadingMethod::Imported)) {
+            if (!thisSurf.SurfSchedExternalShadingFrac) {
+                numNotDef += 1;
+                if (numNotDef == 1) {
+                    if (state.dataSysVars->shadingMethod == DataSystemVariables::ShadingMethod::Scheduled) {
+                        ShowWarningError(
+                            state,
+                            EnergyPlus::format("ShadowCalculation specified \"Scheduled\" for the Shading Calculation Method but no schedule provided for {}.",
+                                               thisSurf.Name));
+                        ShowContinueError(
+                            state, "When \"Scheduled\" is selected for the Shading Calculation Method and no schedule is provided for a particular surface,");
+                        ShowContinueError(
+                            state, "EnergyPlus will assume that the surface is not shaded (i.e., values are set to 1.0). Use SurfaceProperty:LocalEnvironment to specify a schedule");
+                    } else if (state.dataSysVars->shadingMethod == DataSystemVariables::ShadingMethod::Imported) {
+                        ShowWarningError(
+                            state,
+                            EnergyPlus::format("ShadowCalculation specified \"Imported\" for the Shading Calculation Method but no schedule provided for {}.",
+                                               thisSurf.Name));
+                        ShowContinueError(
+                            state, "When \"Imported\" is selected for the Shading Calculation Method and no schedule is provided for a particular surface,");
+                        ShowContinueError(
+                            state, "EnergyPlus will assume that the surface is not shaded (i.e., values are set to 1.0). Use Schedule:File:Shading to specify a schedule");
+                    }
+                    ShowContinueError(state, "for sunlit fraction if this was not desired. Otherwise, this surface will not be shaded at all.");
+                } else if (numNotDef <= maxErrMessages) {
+                    ShowWarningError(
+                        state, EnergyPlus::format("No schedule was provided for {} either. See above error message for more details.", thisSurf.Name));
+                }
             }
-        }
-    }
-    if (numNotDef > maxErrMessages) {
-        ShowContinueError(state, EnergyPlus::format("This message is only shown for the first {} occurrences of this issue.", maxErrMessages));
-    }
-}
-
-void checkNotScheduledOrImportedSurfacePresent(EnergyPlusData &state)
-{
-    // User has *not* chosen "Scheduled" or "Imported" for shading calculation method so check to see which surfaces *have* a schedule.
-    int numNotDef = 0;
-    int constexpr maxErrMessages = 50;
-    auto &surfData = state.dataSurface;
-    for (int surfNum = 1; surfNum <= surfData->TotSurfaces; ++surfNum) {
-        auto &thisSurf = surfData->Surface(surfNum);
-        if ((thisSurf.Class == SurfaceClass::Shading || thisSurf.Class == SurfaceClass::Detached_F || thisSurf.Class == SurfaceClass::Detached_B ||
-             thisSurf.Class == SurfaceClass::Overhang || thisSurf.Class == SurfaceClass::Fin)) {
-            continue; // skip shading surfaces
-        }
-        if (thisSurf.SurfSchedExternalShadingFrac) {
-            numNotDef += 1;
-            if (numNotDef == 1) {
-                ShowWarningError(
-                    state,
-                    EnergyPlus::format("ShadowCalculation did not specify Scheduled or Imported for the Shading Calculation Method but schedule provided for {}.",
-                                       thisSurf.Name));
-            } else if (numNotDef <= maxErrMessages) {
-                ShowWarningError(state,
-                                 EnergyPlus::format("Schedule was also provided for {}.  See above error message for more details.", thisSurf.Name));
+        } else {
+            if (thisSurf.SurfSchedExternalShadingFrac) {
+                numNotDef += 1;
+                if (numNotDef == 1) {
+                    ShowWarningError(
+                        state,
+                        EnergyPlus::format(
+                            "ShadowCalculation did not specify \"Scheduled\" or \"Imported\" for the Shading Calculation Method but schedule provided for {}.",
+                            thisSurf.Name));
+                } else if (numNotDef <= maxErrMessages) {
+                    ShowWarningError(state,
+                                     EnergyPlus::format("Schedule was also provided for {}. See above error message for more details.", thisSurf.Name));
+                }
             }
         }
     }

src/EnergyPlus/SolarShading.hh

@@ -101,9 +101,7 @@ namespace SolarShading {
 
     void processShadowingInput(EnergyPlusData &state);
 
-    void checkScheduledSurfacePresent(EnergyPlusData &state);
-
-    void checkNotScheduledOrImportedSurfacePresent(EnergyPlusData &state);
+    void checkSurfaceExternalShadingSchedules(EnergyPlusData &state);
 
     void AllocateModuleArrays(EnergyPlusData &state);