Adjust SurfaceProperty:XXX IDD and fix/improve sunlit fraction schedule checks

doc/input-output-reference/src/overview/group-advanced-surface-concepts.tex

@@ -2713,7 +2713,7 @@ \subsubsection{References}\label{references-gnd-srfs}
 
 \subsection{SurfaceProperty:LocalEnvironment}\label{surfacePropertylocalEnvironment}
 
-The object links to an exterior surface object \textbf{BuildingSurface:Detailed} or an exterior fenestration object \textbf{FenestrationSurface:Detailed} and is used when there is a need to calculate surface level environmental data externally and import them into the simulation to override existing environmental data, including external solar shading fractions, local air velocity, temperature and humidity, and surrounding surface temperatures, sky view factor, ground surfaces view factors, ground surfaces temperature and ground surfaces reflectance. The object links to four optional objects including a schedule object declared by \textbf{Field: Sunlit Fraction Schedule Name}, a \textbf{\hyperref[surfacePropertySurroundingSurfaces]{SurfaceProperty:SurroundingSurfaces}} object declared by \textbf{Field: Surrounding Surfaces Object Name}, an \textbf{\hyperref[outdoorairnode]{OutdoorAir:Node}} object declared by \textbf{Field: Outdoor Air Node Name}, and a \textbf{\hyperref[surfacePropertyGroundSurfaces]{SurfaceProperty:GroundSurfaces}} object declared by
+The object links to an exterior surface object (e.g., \textbf{BuildingSurface:Detailed}) or an exterior fenestration object (e.g., \textbf{FenestrationSurface:Detailed}) and is used when there is a need to calculate surface level environmental data externally and import them into the simulation to override existing environmental data, including external solar shading fractions, local air velocity, temperature and humidity, and surrounding surface temperatures, sky view factor, ground surfaces view factors, ground surfaces temperature and ground surfaces reflectance. The object links to four optional objects including a schedule object declared by \textbf{Field: Sunlit Fraction Schedule Name}, a \textbf{\hyperref[surfacePropertySurroundingSurfaces]{SurfaceProperty:SurroundingSurfaces}} object declared by \textbf{Field: Surrounding Surfaces Object Name}, an \textbf{\hyperref[outdoorairnode]{OutdoorAir:Node}} object declared by \textbf{Field: Outdoor Air Node Name}, and a \textbf{\hyperref[surfacePropertyGroundSurfaces]{SurfaceProperty:GroundSurfaces}} object declared by
 \textbf{Field: Ground Surfaces Object Name}. The object provides inputs to calculate shading, solar radiation, zone air balance, and surface exterior heat balance.
 
 \subsubsection{Field: Name}\label{field-surf-localenv-name}

idd/Energy+.idd.in

@@ -18873,7 +18873,7 @@ SurfaceProperty:LocalEnvironment,
        \reference SurfaceLocalEnvironmentNames
    A2, \field Exterior Surface Name
        \type object-list
-       \object-list SurfaceNames
+       \object-list AllHeatTranSurfNames
        \note Enter the name of an exterior surface object
    A3, \field Sunlit Fraction Schedule Name
        \type object-list
@@ -18918,19 +18918,23 @@ SurfaceProperty:SurroundingSurfaces,
        \type alpha
        \reference SurroundingSurfacesNames
    N1, \field Sky View Factor
+       \type real
        \minimum 0.0
        \maximum 1.0
-       \default 0.5
+       \autocalculatable
+       \default autocalculate
        \note optional
    A2, \field Sky Temperature Schedule Name
        \type object-list
        \object-list ScheduleNames
        \note Schedule values are real numbers, -100.0 to 100.0, units C
        \note optional
    N2, \field Ground View Factor
+       \type real
        \minimum 0.0
        \maximum 1.0
-       \default 0.5
+       \autocalculatable
+       \default autocalculate
        \note optional
    A3, \field Ground Temperature Schedule Name
        \type object-list

src/EnergyPlus/HeatBalanceManager.cc

@@ -1812,11 +1812,11 @@ namespace HeatBalanceManager {
         // METHODOLOGY EMPLOYED:
         // The GetObjectItem routines are employed to retrieve the data.
 
-        SolarShading::GetShadowingInput(state);
-
         GetZoneData(state, ErrorsFound); // Read Zone data from input file
 
         SurfaceGeometry::SetupZoneGeometry(state, ErrorsFound);
+
+        SolarShading::GetShadowingInput(state);
     }
 
     void GetZoneData(EnergyPlusData &state, bool &ErrorsFound) // If errors found in input

src/EnergyPlus/HeatBalanceSurfaceManager.cc

@@ -9922,22 +9922,25 @@ void InitSurfacePropertyViewFactors(EnergyPlusData &state)
                 auto &SrdSurfsProperty = state.dataSurface->SurroundingSurfsProperty(SrdSurfsNum);
                 SurfsSkyViewFactor = SrdSurfsProperty.SkyViewFactor;
                 IsSkyViewFactorSet = SrdSurfsProperty.IsSkyViewFactorSet;
-                if (SurfsSkyViewFactor > 0.0) {
+                if (SurfsSkyViewFactor != DataSizing::AutoSize) {
                     SrdSurfsViewFactor += SurfsSkyViewFactor;
                 }
                 if (!Surface.IsSurfPropertyGndSurfacesDefined) {
-                    SrdSurfsViewFactor += SrdSurfsProperty.GroundViewFactor;
-                    IsGroundViewFactorSet = SrdSurfsProperty.IsGroundViewFactorSet;
                     GroundSurfsViewFactor = SrdSurfsProperty.GroundViewFactor;
+                    IsGroundViewFactorSet = SrdSurfsProperty.IsGroundViewFactorSet;
+                    if (GroundSurfsViewFactor != DataSizing::AutoSize) {
+                      SrdSurfsViewFactor += GroundSurfsViewFactor;
+                    }
                 }
                 for (int SrdSurfNum = 1; SrdSurfNum <= SrdSurfsProperty.TotSurroundingSurface; SrdSurfNum++) {
                     SrdSurfsViewFactor += SrdSurfsProperty.SurroundingSurfs(SrdSurfNum).ViewFactor;
                 }
             }
             if (Surface.IsSurfPropertyGndSurfacesDefined) {
                 GndSurfsNum = Surface.SurfPropertyGndSurfIndex;
-                IsGroundViewFactorSet = state.dataSurface->GroundSurfsProperty(GndSurfsNum).IsGroundViewFactorSet;
-                GroundSurfsViewFactor = state.dataSurface->GroundSurfsProperty(GndSurfsNum).SurfsViewFactorSum;
+                auto &GrndSurfsProperty = state.dataSurface->GroundSurfsProperty(GndSurfsNum);
+                GroundSurfsViewFactor = GrndSurfsProperty.SurfsViewFactorSum;
+                IsGroundViewFactorSet = GrndSurfsProperty.IsGroundViewFactorSet;
                 SrdSurfsViewFactor += GroundSurfsViewFactor;
             }
 

src/EnergyPlus/SolarShading.cc

@@ -494,12 +494,15 @@ void GetShadowingInput(EnergyPlusData &state)
                     EnergyPlus::format("Value entered=\"{}\" while no Schedule:File:Shading object is defined, InternalCalculation will be used.",
                                        state.dataIPShortCut->cAlphaArgs(aNum)));
             }
+            checkNotScheduledSurfacePresent(state);
         } else if (Util::SameString(state.dataIPShortCut->cAlphaArgs(aNum), "PolygonClipping")) {
             state.dataSysVars->shadingMethod = ShadingMethod::PolygonClipping;
             state.dataIPShortCut->cAlphaArgs(aNum) = "PolygonClipping";
+            checkNotScheduledSurfacePresent(state);
         } else if (Util::SameString(state.dataIPShortCut->cAlphaArgs(aNum), "PixelCounting")) {
             state.dataSysVars->shadingMethod = ShadingMethod::PixelCounting;
             state.dataIPShortCut->cAlphaArgs(aNum) = "PixelCounting";
+            checkNotScheduledSurfacePresent(state);
             if (NumNumbers >= 3) {
                 pixelRes = (unsigned)state.dataIPShortCut->rNumericArgs(3);
             }
@@ -531,6 +534,7 @@ void GetShadowingInput(EnergyPlusData &state)
     } else {
         state.dataIPShortCut->cAlphaArgs(aNum) = "PolygonClipping";
         state.dataSysVars->shadingMethod = ShadingMethod::PolygonClipping;
+        checkNotScheduledSurfacePresent(state);
     }
 
     aNum++;
@@ -831,7 +835,7 @@ void processShadowingInput(EnergyPlusData &state)
 
 void checkScheduledSurfacePresent(EnergyPlusData &state)
 {
-    // User has chosen "Scheduled" for sunlit fraction so check to see which surfaces don't have a schedule
+    // User has chosen "Scheduled" for sunlit fraction so check to see which surfaces don't have a schedule.
     int numNotDef = 0;
     int constexpr maxErrMessages = 50;
     auto &surfData = state.dataSurface;
@@ -846,7 +850,7 @@ void checkScheduledSurfacePresent(EnergyPlusData &state)
             if (numNotDef == 1) {
                 ShowWarningError(
                     state,
-                    EnergyPlus::format("ShadowCalculation specified Schedule for the Shading Calculation Method but no schedule provided for {}",
+                    EnergyPlus::format("ShadowCalculation specified Schedule for the Shading Calculation Method but no schedule provided for {}.",
                                        thisSurf.Name));
                 ShowContinueError(
                     state, "When Schedule is selected for the Shading Calculation Method and no schedule is provided for a particular surface,");
@@ -855,7 +859,37 @@ void checkScheduledSurfacePresent(EnergyPlusData &state)
                 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));
+                    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 checkNotScheduledSurfacePresent(EnergyPlusData &state)
+{
+    // User has *not* chosen "Scheduled" for sunlit fraction 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 Schedule 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

@@ -103,6 +103,8 @@ namespace SolarShading {
 
     void checkScheduledSurfacePresent(EnergyPlusData &state);
 
+    void checkNotScheduledSurfacePresent(EnergyPlusData &state);
+
     void AllocateModuleArrays(EnergyPlusData &state);
 
     void AnisoSkyViewFactors(EnergyPlusData &state);

src/EnergyPlus/SurfaceGeometry.cc

@@ -8183,9 +8183,9 @@ namespace SurfaceGeometry {
                 SrdSurfsProp.Name = s_ipsc->cAlphaArgs(1);
 
                 // N1: sky view factor
-                if (!s_ipsc->lNumericFieldBlanks(1)) {
-                    SrdSurfsProp.SkyViewFactor = s_ipsc->rNumericArgs(1);
-                    SrdSurfsProp.IsSkyViewFactorSet = true;
+                SrdSurfsProp.SkyViewFactor = s_ipsc->rNumericArgs(1);
+                if (SrdSurfsProp.SkyViewFactor != DataSizing::AutoSize) {
+                  SrdSurfsProp.IsSkyViewFactorSet = true;
                 }
 
                 // A2: sky temp sch name
@@ -8195,9 +8195,9 @@ namespace SurfaceGeometry {
                 }
 
                 // N2: ground view factor
-                if (!s_ipsc->lNumericFieldBlanks(2)) {
-                    SrdSurfsProp.GroundViewFactor = s_ipsc->rNumericArgs(2);
-                    SrdSurfsProp.IsGroundViewFactorSet = true;
+                SrdSurfsProp.GroundViewFactor = s_ipsc->rNumericArgs(2);
+                if (SrdSurfsProp.GroundViewFactor != DataSizing::AutoSize) {
+                  SrdSurfsProp.IsGroundViewFactorSet = true;
                 }
 
                 // A3: ground temp sch name