Skip to content

Commit

Permalink
Merge pull request #10621 from NREL/10299CheckConvexityChangeCheckFor…
Browse files Browse the repository at this point in the history 
…ShadowCalculations

Produce Convexity Check Warning Only When Appropriate
  • Loading branch information
@Myoldmopar
Myoldmopar authored Jul 25, 2024
2 parents ef02672 + 08909a8 commit 18f5c3f
Show file tree
Hide file tree
Showing 6 changed files with 376 additions and 102 deletions.
5 changes: 5 additions & 0 deletions src/EnergyPlus/DataSystemVariables.hh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,11 @@ struct SystemVarsData : BaseGlobalStruct
bool ReportExtShadingSunlitFrac = false; // when true, the sunlit fraction for all surfaces are exported as a csv format output
bool DisableGroupSelfShading = false; // when true, defined shadowing surfaces group is ignored when calculating sunlit fraction
bool DisableAllSelfShading = false; // when true, all external shadowing surfaces is ignored when calculating sunlit fraction
bool DisableSelfShadingWithinGroup = false;
bool DisableSelfShadingBetweenGroup = false;

int shadingGroupsNum = 0; // number of shading groups
Array1D_string shadingGroupZoneListNames; // array of zone names in user input

bool TrackAirLoopEnvFlag = false; // If TRUE generates a file with runtime statistics for each HVAC
// controller on each air loop
Expand Down
2 changes: 2 additions & 0 deletions src/EnergyPlus/HeatBalanceManager.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1967,6 +1967,8 @@ 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);
Expand Down
185 changes: 96 additions & 89 deletions src/EnergyPlus/SolarShading.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ void InitSolarCalculations(EnergyPlusData &state)

if (state.dataSolarShading->GetInputFlag) {
checkShadingSurfaceSchedules(state);
GetShadowingInput(state);
processShadowingInput(state);
state.dataSolarShading->GetInputFlag = false;
state.dataSolarShading->MaxHCV =
(((max(15, state.dataSurface->MaxVerticesPerSurface) + 16) / 16) * 16) - 1; // Assure MaxHCV+1 is multiple of 16 for 128 B alignment
Expand Down Expand Up @@ -513,18 +513,6 @@ void GetShadowingInput(EnergyPlusData &state)
state.dataSysVars->shadingMethod = ShadingMethod::PolygonClipping;
}

if ((state.dataSysVars->shadingMethod == DataSystemVariables::ShadingMethod::PixelCounting) &&
state.dataSolarShading->anyScheduledShadingSurface) {
ShowSevereError(state, "The Shading Calculation Method of choice is \"PixelCounting\"; ");
ShowContinueError(state, "and there is at least one shading surface of type ");
ShowContinueError(state, "Shading:Site:Detailed, Shading:Building:Detailed, or Shading:Zone:Detailed, ");
ShowContinueError(state, "that has an active transmittance schedule value greater than zero or may vary.");
ShowContinueError(state, "With \"PixelCounting\" Shading Calculation Method, the shading surfaces will be treated as ");
ShowContinueError(state, "completely opaque (transmittance = 0) during the shading calculation, ");
ShowContinueError(state, "which may result in inaccurate or unexpected results.");
ShowContinueError(state, "It is suggested switching to another Shading Calculation Method, such as \"PolygonClipping\".");
}

aNum++;
if (NumAlphas >= aNum) {
if (Util::SameString(state.dataIPShortCut->cAlphaArgs(aNum), "Periodic")) {
Expand Down Expand Up @@ -628,30 +616,11 @@ void GetShadowingInput(EnergyPlusData &state)
state.dataIPShortCut->cAlphaArgs(aNum) = "No";
state.dataSysVars->ReportExtShadingSunlitFrac = false;
}
if (state.dataSysVars->shadingMethod == ShadingMethod::Imported) {
int ExtShadingSchedNum;
for (int SurfNum = 1; SurfNum <= state.dataSurface->TotSurfaces; ++SurfNum) {
ExtShadingSchedNum = ScheduleManager::GetScheduleIndex(state, state.dataSurface->Surface(SurfNum).Name + "_shading");
if (ExtShadingSchedNum != 0) {
state.dataSurface->Surface(SurfNum).SurfSchedExternalShadingFrac = true;
state.dataSurface->Surface(SurfNum).SurfExternalShadingSchInd = ExtShadingSchedNum;
} else {
ShowWarningError(state,
format("{}: sunlit fraction schedule not found for {} when using ImportedShading.",
cCurrentModuleObject,
state.dataSurface->Surface(SurfNum).Name));
ShowContinueError(state, "These values are set to 1.0.");
}
}
}

bool DisableSelfShadingWithinGroup = false;
bool DisableSelfShadingBetweenGroup = false;

aNum++;
if (NumAlphas >= aNum) {
if (Util::SameString(state.dataIPShortCut->cAlphaArgs(aNum), "Yes")) {
DisableSelfShadingWithinGroup = true;
state.dataSysVars->DisableSelfShadingWithinGroup = true;
state.dataIPShortCut->cAlphaArgs(aNum) = "Yes";
} else if (Util::SameString(state.dataIPShortCut->cAlphaArgs(aNum), "No")) {
state.dataIPShortCut->cAlphaArgs(aNum) = "No";
Expand All @@ -667,7 +636,7 @@ void GetShadowingInput(EnergyPlusData &state)
aNum++;
if (NumAlphas >= aNum) {
if (Util::SameString(state.dataIPShortCut->cAlphaArgs(aNum), "Yes")) {
DisableSelfShadingBetweenGroup = true;
state.dataSysVars->DisableSelfShadingBetweenGroup = true;
state.dataIPShortCut->cAlphaArgs(aNum) = "Yes";
} else if (Util::SameString(state.dataIPShortCut->cAlphaArgs(aNum), "No")) {
state.dataIPShortCut->cAlphaArgs(aNum) = "No";
Expand All @@ -680,66 +649,17 @@ void GetShadowingInput(EnergyPlusData &state)
state.dataIPShortCut->cAlphaArgs(aNum) = "No";
}

if (DisableSelfShadingBetweenGroup && DisableSelfShadingWithinGroup) {
if (state.dataSysVars->DisableSelfShadingBetweenGroup && state.dataSysVars->DisableSelfShadingWithinGroup) {
state.dataSysVars->DisableAllSelfShading = true;
} else if (DisableSelfShadingBetweenGroup || DisableSelfShadingWithinGroup) {
} else if (state.dataSysVars->DisableSelfShadingBetweenGroup || state.dataSysVars->DisableSelfShadingWithinGroup) {
state.dataSysVars->DisableGroupSelfShading = true;
}

aNum++;
int SurfZoneGroup, CurZoneGroup;
if (state.dataSysVars->DisableGroupSelfShading) {
Array1D_int DisableSelfShadingGroups;
int NumOfShadingGroups;
if (NumAlphas >= aNum) {
// Read all shading groups
NumOfShadingGroups = NumAlphas - (aNum - 1);
DisableSelfShadingGroups.allocate(NumOfShadingGroups);
for (int i = 1; i <= NumOfShadingGroups; i++) {
Found = Util::FindItemInList(
state.dataIPShortCut->cAlphaArgs(i + (aNum - 1)), state.dataHeatBal->ZoneList, state.dataHeatBal->NumOfZoneLists);
if (Found != 0) DisableSelfShadingGroups(i) = Found;
}

for (int SurfNum = 1; SurfNum <= state.dataSurface->TotSurfaces; SurfNum++) {
if (state.dataSurface->Surface(SurfNum).ExtBoundCond == 0) { // Loop through all exterior surfaces
SurfZoneGroup = 0;
// Check the shading zone group of each exterior surface
for (int ZoneGroupLoop = 1; ZoneGroupLoop <= NumOfShadingGroups; ZoneGroupLoop++) { // Loop through all defined shading groups
CurZoneGroup = DisableSelfShadingGroups(ZoneGroupLoop);
for (int ZoneNum = 1; ZoneNum <= state.dataHeatBal->ZoneList(CurZoneGroup).NumOfZones;
ZoneNum++) { // Loop through all zones in the zone list
if (state.dataSurface->Surface(SurfNum).Zone == state.dataHeatBal->ZoneList(CurZoneGroup).Zone(ZoneNum)) {
SurfZoneGroup = CurZoneGroup;
break;
}
}
}
// if a surface is not in any zone group, no self shading is disabled for this surface
if (SurfZoneGroup != 0) {
// if DisableSelfShadingWithinGroup, add all zones in the same zone group to the surface's disabled zone list
// if DisableSelfShadingBetweenGroups, add all zones in all other zone groups to the surface's disabled zone list
for (int ZoneGroupLoop = 1; ZoneGroupLoop <= NumOfShadingGroups; ZoneGroupLoop++) { // Loop through all defined shading groups
CurZoneGroup = DisableSelfShadingGroups(ZoneGroupLoop);
if (SurfZoneGroup == CurZoneGroup && DisableSelfShadingWithinGroup) {
for (int ZoneNum = 1; ZoneNum <= state.dataHeatBal->ZoneList(CurZoneGroup).NumOfZones;
ZoneNum++) { // Loop through all zones in the zone list
state.dataSurface->SurfShadowDisabledZoneList(SurfNum).push_back(
state.dataHeatBal->ZoneList(CurZoneGroup).Zone(ZoneNum));
}
} else if (SurfZoneGroup != CurZoneGroup && DisableSelfShadingBetweenGroup) {
for (int ZoneNum = 1; ZoneNum <= state.dataHeatBal->ZoneList(CurZoneGroup).NumOfZones; ZoneNum++) {
state.dataSurface->SurfShadowDisabledZoneList(SurfNum).push_back(
state.dataHeatBal->ZoneList(CurZoneGroup).Zone(ZoneNum));
}
}
}
}
}
}
} else {
ShowFatalError(state, "No Shading groups are defined when disabling grouped self shading.");
}
state.dataSysVars->shadingGroupsNum = NumAlphas - (aNum - 1);
state.dataSysVars->shadingGroupZoneListNames.allocate(state.dataSysVars->shadingGroupsNum);
for (int numZone = 1; numZone <= state.dataSysVars->shadingGroupsNum; ++numZone) {
state.dataSysVars->shadingGroupZoneListNames(numZone) = state.dataIPShortCut->cAlphaArgs(aNum - 1 + numZone);
}

if (!state.dataSysVars->DetailedSolarTimestepIntegration && state.dataSurface->ShadingTransmittanceVaries &&
Expand Down Expand Up @@ -796,6 +716,93 @@ void GetShadowingInput(EnergyPlusData &state)
state.dataIPShortCut->cAlphaArgs(7));
}

void processShadowingInput(EnergyPlusData &state)
{
// all shadow input processing that needed zones and surfaces to already be read into data (part of fix for Defect #10299)

if ((state.dataSysVars->shadingMethod == DataSystemVariables::ShadingMethod::PixelCounting) &&
state.dataSolarShading->anyScheduledShadingSurface) {
ShowSevereError(state, "The Shading Calculation Method of choice is \"PixelCounting\"; ");
ShowContinueError(state, "and there is at least one shading surface of type ");
ShowContinueError(state, "Shading:Site:Detailed, Shading:Building:Detailed, or Shading:Zone:Detailed, ");
ShowContinueError(state, "that has an active transmittance schedule value greater than zero or may vary.");
ShowContinueError(state, "With \"PixelCounting\" Shading Calculation Method, the shading surfaces will be treated as ");
ShowContinueError(state, "completely opaque (transmittance = 0) during the shading calculation, ");
ShowContinueError(state, "which may result in inaccurate or unexpected results.");
ShowContinueError(state, "It is suggested switching to another Shading Calculation Method, such as \"PolygonClipping\".");
}

if (state.dataSysVars->shadingMethod == DataSystemVariables::ShadingMethod::Imported) {
int ExtShadingSchedNum;
for (int SurfNum = 1; SurfNum <= state.dataSurface->TotSurfaces; ++SurfNum) {
ExtShadingSchedNum = ScheduleManager::GetScheduleIndex(state, state.dataSurface->Surface(SurfNum).Name + "_shading");
if (ExtShadingSchedNum != 0) {
state.dataSurface->Surface(SurfNum).SurfSchedExternalShadingFrac = true;
state.dataSurface->Surface(SurfNum).SurfExternalShadingSchInd = ExtShadingSchedNum;
} else {
ShowWarningError(state,
format("processShadowingInput: sunlit fraction schedule not found for {} when using ImportedShading.",
state.dataSurface->Surface(SurfNum).Name));
ShowContinueError(state, "These values are set to 1.0.");
}
}
}

int SurfZoneGroup, CurZoneGroup;
int Found = 0;
if (state.dataSysVars->DisableGroupSelfShading) {
Array1D_int DisableSelfShadingGroups;
int NumOfShadingGroups = state.dataSysVars->shadingGroupsNum;
if (NumOfShadingGroups > 0) {
DisableSelfShadingGroups.allocate(NumOfShadingGroups);
for (int i = 1; i <= NumOfShadingGroups; i++) {
Found = Util::FindItemInList(
state.dataSysVars->shadingGroupZoneListNames(i), state.dataHeatBal->ZoneList, state.dataHeatBal->NumOfZoneLists);
if (Found != 0) DisableSelfShadingGroups(i) = Found;
}

for (int SurfNum = 1; SurfNum <= state.dataSurface->TotSurfaces; SurfNum++) {
if (state.dataSurface->Surface(SurfNum).ExtBoundCond == 0) { // Loop through all exterior surfaces
SurfZoneGroup = 0;
// Check the shading zone group of each exterior surface
for (int ZoneGroupLoop = 1; ZoneGroupLoop <= NumOfShadingGroups; ZoneGroupLoop++) { // Loop through all defined shading groups
CurZoneGroup = DisableSelfShadingGroups(ZoneGroupLoop);
for (int ZoneNum = 1; ZoneNum <= state.dataHeatBal->ZoneList(CurZoneGroup).NumOfZones;
ZoneNum++) { // Loop through all zones in the zone list
if (state.dataSurface->Surface(SurfNum).Zone == state.dataHeatBal->ZoneList(CurZoneGroup).Zone(ZoneNum)) {
SurfZoneGroup = CurZoneGroup;
break;
}
}
}
// if a surface is not in any zone group, no self shading is disabled for this surface
if (SurfZoneGroup != 0) {
// if DisableSelfShadingWithinGroup, add all zones in the same zone group to the surface's disabled zone list
// if DisableSelfShadingBetweenGroups, add all zones in all other zone groups to the surface's disabled zone list
for (int ZoneGroupLoop = 1; ZoneGroupLoop <= NumOfShadingGroups; ZoneGroupLoop++) { // Loop through all defined shading groups
CurZoneGroup = DisableSelfShadingGroups(ZoneGroupLoop);
if (SurfZoneGroup == CurZoneGroup && state.dataSysVars->DisableSelfShadingWithinGroup) {
for (int ZoneNum = 1; ZoneNum <= state.dataHeatBal->ZoneList(CurZoneGroup).NumOfZones;
ZoneNum++) { // Loop through all zones in the zone list
state.dataSurface->SurfShadowDisabledZoneList(SurfNum).push_back(
state.dataHeatBal->ZoneList(CurZoneGroup).Zone(ZoneNum));
}
} else if (SurfZoneGroup != CurZoneGroup && state.dataSysVars->DisableSelfShadingBetweenGroup) {
for (int ZoneNum = 1; ZoneNum <= state.dataHeatBal->ZoneList(CurZoneGroup).NumOfZones; ZoneNum++) {
state.dataSurface->SurfShadowDisabledZoneList(SurfNum).push_back(
state.dataHeatBal->ZoneList(CurZoneGroup).Zone(ZoneNum));
}
}
}
}
}
}
} else {
ShowFatalError(state, "No Shading groups are defined when disabling grouped self shading.");
}
}
}

void checkScheduledSurfacePresent(EnergyPlusData &state)
{
// User has chosen "Scheduled" for sunlit fraction so check to see which surfaces don't have a schedule
Expand Down
2 changes: 2 additions & 0 deletions src/EnergyPlus/SolarShading.hh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ namespace SolarShading {

void GetShadowingInput(EnergyPlusData &state);

void processShadowingInput(EnergyPlusData &state);

void checkScheduledSurfacePresent(EnergyPlusData &state);

void AllocateModuleArrays(EnergyPlusData &state);
Expand Down
7 changes: 4 additions & 3 deletions src/EnergyPlus/SurfaceGeometry.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@
#include <EnergyPlus/DataIPShortCuts.hh>
#include <EnergyPlus/DataLoopNode.hh>
#include <EnergyPlus/DataReportingFlags.hh>
#include <EnergyPlus/DataSystemVariables.hh>
#include <EnergyPlus/DataViewFactorInformation.hh>
#include <EnergyPlus/DataWindowEquivalentLayer.hh>
#include <EnergyPlus/DataZoneEquipment.hh>
Expand Down Expand Up @@ -15680,9 +15681,9 @@ namespace SurfaceGeometry {

if (SignFlag != PrevSignFlag) {
if (state.dataGlobal->DisplayExtraWarnings && surfaceTmp.ExtSolar &&
(state.dataHeatBal->SolarDistribution != DataHeatBalance::Shadowing::Minimal) &&
// Warn only once
surfaceTmp.IsConvex) {
(state.dataHeatBal->SolarDistribution != DataHeatBalance::Shadowing::Minimal) && surfaceTmp.IsConvex &&
!state.dataSysVars->SutherlandHodgman &&
(state.dataSysVars->shadingMethod == DataSystemVariables::ShadingMethod::PolygonClipping)) {
ShowWarningError(state,
format("CheckConvexity: Zone=\"{}\", Surface=\"{}\" is non-convex.",
state.dataHeatBal->Zone(surfaceTmp.Zone).Name,
Expand Down
Loading

10 comments on commit 18f5c3f

@nrel-bot-3
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

develop (Myoldmopar) - x86_64-MacOS-10.18-clang-15.0.0: OK (2863 of 2863 tests passed, 0 test warnings)

Build Badge Test Badge

@nrel-bot
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

develop (Myoldmopar) - Win64-Windows-10-VisualStudio-16: OK (2861 of 2862 tests passed, 0 test warnings)

Failures:\n

EnergyPlusFixture Test Summary

  • Passed: 1574
  • Failed: 1

Build Badge Test Badge

@nrel-bot-2c
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

develop (Myoldmopar) - x86_64-Linux-Ubuntu-22.04-gcc-11.4: OK (2884 of 2884 tests passed, 0 test warnings)

Build Badge Test Badge

@nrel-bot-2c
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

develop (Myoldmopar) - x86_64-Linux-Ubuntu-22.04-gcc-11.4-UnitTestsCoverage-Debug: OK (2070 of 2070 tests passed, 0 test warnings)

Build Badge Test Badge Coverage Badge

@nrel-bot-2
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

develop (Myoldmopar) - x86_64-Linux-Ubuntu-22.04-gcc-11.4-IntegrationCoverage-Debug: OK (795 of 795 tests passed, 0 test warnings)

Build Badge Test Badge Coverage Badge

@nrel-bot-2
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

10630-AFN-fan-array-bounds (Myoldmopar) - x86_64-Linux-Ubuntu-22.04-gcc-11.4: OK (3695 of 3695 tests passed, 0 test warnings)

Build Badge Test Badge

@nrel-bot
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

10630-AFN-fan-array-bounds (Myoldmopar) - Win64-Windows-10-VisualStudio-16: OK (2862 of 2862 tests passed, 0 test warnings)

Build Badge Test Badge

@nrel-bot-3
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

10630-AFN-fan-array-bounds (Myoldmopar) - x86_64-MacOS-10.18-clang-15.0.0: OK (3654 of 3654 tests passed, 0 test warnings)

Build Badge Test Badge

@nrel-bot-2b
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

10630-AFN-fan-array-bounds (Myoldmopar) - x86_64-Linux-Ubuntu-22.04-gcc-11.4-IntegrationCoverage-Debug: OK (795 of 795 tests passed, 0 test warnings)

Build Badge Test Badge Coverage Badge

@nrel-bot-2c
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

10630-AFN-fan-array-bounds (Myoldmopar) - x86_64-Linux-Ubuntu-22.04-gcc-11.4-UnitTestsCoverage-Debug: OK (2070 of 2070 tests passed, 0 test warnings)

Build Badge Test Badge Coverage Badge

Please sign in to comment.