src/energyplus/ForwardTranslator/ForwardTranslateShadingControl.cpp
| Line | Branch | Exec | Source |
|---|---|---|---|
| 1 | /*********************************************************************************************************************** | ||
| 2 | * OpenStudio(R), Copyright (c) Alliance for Energy Innovation, LLC. | ||
| 3 | * See also https://openstudio.net/license | ||
| 4 | ***********************************************************************************************************************/ | ||
| 5 | |||
| 6 | #include "../ForwardTranslator.hpp" | ||
| 7 | |||
| 8 | #include "../../model/ShadingControl.hpp" | ||
| 9 | #include "../../model/Construction.hpp" | ||
| 10 | #include "../../model/ShadingMaterial.hpp" | ||
| 11 | #include "../../model/Schedule.hpp" | ||
| 12 | #include "../../model/Space.hpp" | ||
| 13 | #include "../../model/ThermalZone.hpp" | ||
| 14 | #include "../../model/SubSurface.hpp" | ||
| 15 | #include "../../model/DaylightingControl.hpp" | ||
| 16 | #include "../../model/AdditionalProperties.hpp" | ||
| 17 | |||
| 18 | #include "../../utilities/idf/IdfExtensibleGroup.hpp" | ||
| 19 | |||
| 20 | #include <utilities/idd/WindowShadingControl_FieldEnums.hxx> | ||
| 21 | #include "../../utilities/idd/IddEnums.hpp" | ||
| 22 | #include <utilities/idd/IddEnums.hxx> | ||
| 23 | |||
| 24 | using namespace openstudio::model; | ||
| 25 | |||
| 26 | namespace openstudio { | ||
| 27 | |||
| 28 | namespace energyplus { | ||
| 29 | |||
| 30 | 4 | boost::optional<IdfObject> ForwardTranslator::translateShadingControl(model::ShadingControl& modelObject) { | |
| 31 | // after pre-processing in ForwardTranslator, all ShadingControls should only reference subsurfaces in a single zone | ||
| 32 | // additionally, the additional property "Shading Control Sequence Number" is set as an integer | ||
| 33 | |||
| 34 |
1/1✓ Branch 1 taken 4 times.
|
4 | std::vector<SubSurface> subSurfaces = modelObject.subSurfaces(); |
| 35 | |||
| 36 |
1/2✗ Branch 1 not taken.
✓ Branch 2 taken 4 times.
|
4 | if (subSurfaces.empty()) { |
| 37 | ✗ | LOG(Warn, modelObject.briefDescription() << " does not control any SubSurfaces, it will not be translated"); | |
| 38 | ✗ | return boost::none; | |
| 39 | } | ||
| 40 |
10/16✓ Branch 1 taken 4 times.
✓ Branch 4 taken 1 time.
✓ Branch 5 taken 3 times.
✓ Branch 7 taken 1 time.
✓ Branch 10 taken 1 time.
✗ Branch 11 not taken.
✓ Branch 12 taken 1 time.
✓ Branch 13 taken 3 times.
✓ Branch 15 taken 4 times.
✗ Branch 16 not taken.
✓ Branch 18 taken 1 time.
✓ Branch 19 taken 3 times.
✗ Branch 20 not taken.
✗ Branch 21 not taken.
✗ Branch 23 not taken.
✗ Branch 24 not taken.
|
4 | if (!modelObject.shadingMaterial() && !modelObject.construction()) { |
| 41 |
7/7✓ Branch 1 taken 1 time.
✓ Branch 4 taken 1 time.
✓ Branch 7 taken 1 time.
✓ Branch 10 taken 1 time.
✓ Branch 14 taken 1 time.
✓ Branch 17 taken 1 time.
✓ Branch 20 taken 1 time.
|
1 | LOG(Error, modelObject.briefDescription() << " does not have either a Shading Material or a Construction assigned, it will not be translated"); |
| 42 | 1 | return boost::none; | |
| 43 | } | ||
| 44 | |||
| 45 | // Read this now, since we'll use it to test if a Warn is needed | ||
| 46 |
1/1✓ Branch 1 taken 3 times.
|
3 | std::string shadingControlType = modelObject.shadingControlType(); |
| 47 | |||
| 48 |
5/8✓ Branch 1 taken 3 times.
✓ Branch 3 taken 3 times.
✗ Branch 4 not taken.
✓ Branch 6 taken 3 times.
✗ Branch 9 not taken.
✓ Branch 10 taken 3 times.
✗ Branch 11 not taken.
✓ Branch 12 taken 3 times.
|
3 | if (modelObject.isControlTypeValueNeedingSetpoint1() && !modelObject.setpoint()) { |
| 49 | ✗ | LOG(Error, modelObject.briefDescription() << " is using Shading Control Type '" << shadingControlType | |
| 50 | << "' which requires a Setpoint which is missing, it will not be translated"); | ||
| 51 | ✗ | return boost::none; | |
| 52 | } | ||
| 53 | |||
| 54 |
6/8✓ Branch 1 taken 3 times.
✓ Branch 3 taken 1 time.
✓ Branch 4 taken 2 times.
✓ Branch 6 taken 1 time.
✗ Branch 9 not taken.
✓ Branch 10 taken 1 time.
✗ Branch 11 not taken.
✓ Branch 12 taken 3 times.
|
3 | if (modelObject.isControlTypeValueNeedingSetpoint2() && !modelObject.setpoint2()) { |
| 55 | ✗ | LOG(Error, modelObject.briefDescription() << " is using Shading Control Type '" << shadingControlType | |
| 56 | << "' which requires a Setpoint2 which is missing, it will not be translated"); | ||
| 57 | ✗ | return boost::none; | |
| 58 | } | ||
| 59 | |||
| 60 |
4/12✓ Branch 1 taken 3 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 3 times.
✗ Branch 6 not taken.
✗ Branch 9 not taken.
✗ Branch 10 not taken.
✗ Branch 11 not taken.
✓ Branch 12 taken 3 times.
✗ Branch 14 not taken.
✓ Branch 15 taken 3 times.
✗ Branch 16 not taken.
✗ Branch 17 not taken.
|
3 | if (modelObject.isControlTypeValueRequiringSchedule() && !modelObject.schedule()) { |
| 61 | ✗ | LOG(Error, modelObject.briefDescription() << " is using Shading Control Type '" << shadingControlType | |
| 62 | << "' which requires a Schedule which is missing, it will not be translated"); | ||
| 63 | ✗ | return boost::none; | |
| 64 | } | ||
| 65 | |||
| 66 |
2/2✓ Branch 1 taken 3 times.
✓ Branch 4 taken 3 times.
|
3 | IdfObject idfObject(openstudio::IddObjectType::WindowShadingControl); |
| 67 | |||
| 68 |
1/1✓ Branch 1 taken 3 times.
|
3 | m_idfObjects.push_back(idfObject); |
| 69 | |||
| 70 |
3/3✓ Branch 1 taken 3 times.
✓ Branch 4 taken 3 times.
✓ Branch 7 taken 3 times.
|
3 | idfObject.setString(WindowShadingControlFields::Name, modelObject.name().get()); |
| 71 | |||
| 72 | 3 | std::string zoneName; | |
| 73 | 3 | boost::optional<ThermalZone> zone; | |
| 74 |
2/2✓ Branch 5 taken 4 times.
✓ Branch 6 taken 3 times.
|
7 | for (const auto& subSurface : subSurfaces) { |
| 75 |
1/1✓ Branch 1 taken 4 times.
|
4 | boost::optional<Space> space = subSurface.space(); |
| 76 |
1/2✓ Branch 0 taken 4 times.
✗ Branch 1 not taken.
|
4 | if (space) { |
| 77 |
2/2✓ Branch 1 taken 4 times.
✓ Branch 4 taken 4 times.
|
4 | boost::optional<ThermalZone> thermalZone = space->thermalZone(); |
| 78 |
1/2✓ Branch 0 taken 4 times.
✗ Branch 1 not taken.
|
4 | if (thermalZone) { |
| 79 |
2/2✓ Branch 1 taken 3 times.
✓ Branch 2 taken 1 time.
|
4 | if (zoneName.empty()) { |
| 80 |
2/2✓ Branch 1 taken 3 times.
✓ Branch 4 taken 3 times.
|
3 | zoneName = thermalZone->nameString(); |
| 81 |
1/1✓ Branch 1 taken 3 times.
|
3 | zone = thermalZone; |
| 82 |
3/4✓ Branch 1 taken 1 time.
✓ Branch 4 taken 1 time.
✗ Branch 8 not taken.
✓ Branch 9 taken 1 time.
|
1 | } else if (zoneName != thermalZone->nameString()) { |
| 83 | ✗ | LOG(Warn, modelObject.briefDescription() << " controls SubSurfaces in multiple zones"); | |
| 84 | } | ||
| 85 | } else { | ||
| 86 | ✗ | LOG(Error, "Cannot find ThermalZone for " << subSurface.briefDescription() << " referencing " << modelObject.briefDescription()); | |
| 87 | } | ||
| 88 | 4 | } else { | |
| 89 | ✗ | LOG(Error, "Cannot find Space for " << subSurface.briefDescription() << " referencing " << modelObject.briefDescription()); | |
| 90 | } | ||
| 91 | 4 | } | |
| 92 |
1/1✓ Branch 1 taken 3 times.
|
3 | idfObject.setString(WindowShadingControlFields::ZoneName, zoneName); |
| 93 | |||
| 94 |
1/1✓ Branch 1 taken 3 times.
|
3 | idfObject.setString(WindowShadingControlFields::ShadingControlType, shadingControlType); |
| 95 | |||
| 96 |
1/2✓ Branch 0 taken 3 times.
✗ Branch 1 not taken.
|
3 | if (zone) { |
| 97 |
2/2✓ Branch 1 taken 3 times.
✓ Branch 4 taken 3 times.
|
3 | boost::optional<DaylightingControl> daylightingControl = zone->primaryDaylightingControl(); |
| 98 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 3 times.
|
3 | if (daylightingControl) { |
| 99 | ✗ | idfObject.setString(WindowShadingControlFields::DaylightingControlObjectName, daylightingControl->nameString()); | |
| 100 | } else { | ||
| 101 | // Warn only if a Shading Control Type that relies on DaylightingControl object is used | ||
| 102 | // We would probably need to warn if "Glare Control Is Active" was "Yes", | ||
| 103 | // but there's no setter in Model API and we default it to "No" later in this file | ||
| 104 |
11/26✓ Branch 1 taken 3 times.
✓ Branch 4 taken 3 times.
✓ Branch 6 taken 3 times.
✗ Branch 7 not taken.
✓ Branch 9 taken 3 times.
✓ Branch 12 taken 3 times.
✗ Branch 14 not taken.
✓ Branch 15 taken 3 times.
✓ Branch 16 taken 3 times.
✗ Branch 17 not taken.
✓ Branch 19 taken 3 times.
✗ Branch 20 not taken.
✓ Branch 21 taken 3 times.
✗ Branch 22 not taken.
✓ Branch 24 taken 3 times.
✗ Branch 25 not taken.
✗ Branch 26 not taken.
✓ Branch 27 taken 3 times.
✗ Branch 28 not taken.
✗ Branch 29 not taken.
✗ Branch 31 not taken.
✗ Branch 32 not taken.
✗ Branch 33 not taken.
✗ Branch 34 not taken.
✗ Branch 36 not taken.
✗ Branch 37 not taken.
|
15 | if (istringEqual("MeetDaylightIlluminanceSetpoint", shadingControlType) || istringEqual("OnIfHighGlare", shadingControlType)) { |
| 105 | ✗ | LOG(Warn, "Cannot find DaylightingControl for " << modelObject.briefDescription() << ", while the Shading Control Type is '" | |
| 106 | << shadingControlType << "'."); | ||
| 107 | } | ||
| 108 | } | ||
| 109 | 3 | } else { | |
| 110 | ✗ | LOG(Error, "Cannot find ThermalZone for " << modelObject.briefDescription()); | |
| 111 | } | ||
| 112 | |||
| 113 |
3/3✓ Branch 1 taken 3 times.
✓ Branch 4 taken 3 times.
✓ Branch 7 taken 3 times.
|
9 | boost::optional<int> sequenceNumber = modelObject.additionalProperties().getFeatureAsInteger("Shading Control Sequence Number"); |
| 114 |
1/2✓ Branch 0 taken 3 times.
✗ Branch 1 not taken.
|
3 | if (sequenceNumber) { |
| 115 |
2/2✓ Branch 1 taken 3 times.
✓ Branch 4 taken 3 times.
|
3 | idfObject.setInt(WindowShadingControlFields::ShadingControlSequenceNumber, *sequenceNumber); |
| 116 | } else { | ||
| 117 | ✗ | LOG(Error, modelObject.briefDescription() << " has unknown Shading Control Sequence Number"); | |
| 118 | } | ||
| 119 | |||
| 120 |
1/1✓ Branch 1 taken 3 times.
|
3 | std::string shadingType = modelObject.shadingType(); |
| 121 |
3/4✓ Branch 1 taken 3 times.
✓ Branch 4 taken 3 times.
✗ Branch 7 not taken.
✓ Branch 8 taken 3 times.
|
6 | if (istringEqual("InteriorDaylightRedirectionDevice", shadingType)) { |
| 122 | ✗ | idfObject.setString(WindowShadingControlFields::ShadingType, "InteriorBlind"); | |
| 123 | } else { | ||
| 124 |
1/1✓ Branch 1 taken 3 times.
|
3 | idfObject.setString(WindowShadingControlFields::ShadingType, shadingType); |
| 125 | } | ||
| 126 | |||
| 127 |
1/1✓ Branch 1 taken 3 times.
|
3 | boost::optional<Construction> construction = modelObject.construction(); |
| 128 |
1/1✓ Branch 1 taken 3 times.
|
3 | boost::optional<ShadingMaterial> shadingMaterial = modelObject.shadingMaterial(); |
| 129 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 3 times.
|
3 | if (construction) { |
| 130 | ✗ | idfObject.setString(WindowShadingControlFields::ConstructionwithShadingName, construction->name().get()); | |
| 131 |
1/2✓ Branch 0 taken 3 times.
✗ Branch 1 not taken.
|
3 | } else if (shadingMaterial) { |
| 132 |
4/4✓ Branch 1 taken 3 times.
✓ Branch 4 taken 3 times.
✓ Branch 7 taken 3 times.
✓ Branch 10 taken 3 times.
|
3 | idfObject.setString(WindowShadingControlFields::ShadingDeviceMaterialName, shadingMaterial->name().get()); |
| 133 | } | ||
| 134 | |||
| 135 |
2/3✓ Branch 1 taken 3 times.
✓ Branch 3 taken 3 times.
✗ Branch 4 not taken.
|
3 | if (modelObject.isControlTypeValueAllowingSchedule()) { |
| 136 |
1/1✓ Branch 1 taken 3 times.
|
3 | boost::optional<Schedule> schedule = modelObject.schedule(); |
| 137 |
2/2✓ Branch 0 taken 1 time.
✓ Branch 1 taken 2 times.
|
3 | if (schedule) { |
| 138 |
4/4✓ Branch 1 taken 1 time.
✓ Branch 4 taken 1 time.
✓ Branch 7 taken 1 time.
✓ Branch 10 taken 1 time.
|
1 | idfObject.setString(WindowShadingControlFields::ScheduleName, schedule->name().get()); |
| 139 |
2/2✓ Branch 1 taken 1 time.
✓ Branch 4 taken 1 time.
|
2 | idfObject.setString(WindowShadingControlFields::ShadingControlIsScheduled, "Yes"); |
| 140 | } else { | ||
| 141 |
2/2✓ Branch 1 taken 2 times.
✓ Branch 4 taken 2 times.
|
4 | idfObject.setString(WindowShadingControlFields::ShadingControlIsScheduled, "No"); |
| 142 | } | ||
| 143 | 3 | } else { | |
| 144 | ✗ | idfObject.setString(WindowShadingControlFields::ShadingControlIsScheduled, "No"); | |
| 145 | } | ||
| 146 | |||
| 147 |
2/3✓ Branch 1 taken 3 times.
✓ Branch 3 taken 3 times.
✗ Branch 4 not taken.
|
3 | if (modelObject.isControlTypeValueNeedingSetpoint1()) { |
| 148 |
3/3✓ Branch 1 taken 3 times.
✓ Branch 4 taken 3 times.
✓ Branch 7 taken 3 times.
|
3 | idfObject.setDouble(WindowShadingControlFields::Setpoint, modelObject.setpoint().get()); |
| 149 | } | ||
| 150 | |||
| 151 |
12/17✓ Branch 1 taken 3 times.
✓ Branch 3 taken 2 times.
✓ Branch 4 taken 1 time.
✓ Branch 6 taken 2 times.
✓ Branch 9 taken 2 times.
✗ Branch 11 not taken.
✓ Branch 12 taken 2 times.
✓ Branch 13 taken 2 times.
✓ Branch 14 taken 1 time.
✓ Branch 16 taken 2 times.
✓ Branch 17 taken 1 time.
✓ Branch 18 taken 1 time.
✓ Branch 19 taken 2 times.
✗ Branch 20 not taken.
✗ Branch 21 not taken.
✗ Branch 23 not taken.
✗ Branch 24 not taken.
|
7 | if (modelObject.glareControlIsActive() || istringEqual("OnIfHighGlare", shadingControlType)) { |
| 152 |
2/2✓ Branch 1 taken 1 time.
✓ Branch 4 taken 1 time.
|
2 | idfObject.setString(WindowShadingControlFields::GlareControlIsActive, "Yes"); |
| 153 | } else { | ||
| 154 |
2/2✓ Branch 1 taken 2 times.
✓ Branch 4 taken 2 times.
|
4 | idfObject.setString(WindowShadingControlFields::GlareControlIsActive, "No"); |
| 155 | } | ||
| 156 | |||
| 157 |
1/1✓ Branch 1 taken 3 times.
|
3 | boost::optional<Schedule> slatAngleSchedule = modelObject.slatAngleSchedule(); |
| 158 |
1/2✗ Branch 0 not taken.
✓ Branch 1 taken 3 times.
|
3 | if (slatAngleSchedule) { |
| 159 | ✗ | idfObject.setString(WindowShadingControlFields::SlatAngleScheduleName, slatAngleSchedule->name().get()); | |
| 160 | ✗ | idfObject.setString(WindowShadingControlFields::TypeofSlatAngleControlforBlinds, "ScheduledSlatAngle"); | |
| 161 | } else { | ||
| 162 |
4/5✓ Branch 1 taken 3 times.
✓ Branch 4 taken 3 times.
✓ Branch 7 taken 3 times.
✓ Branch 11 taken 3 times.
✗ Branch 12 not taken.
|
9 | if (!istringEqual("ScheduledSlatAngle", modelObject.typeofSlatAngleControlforBlinds())) { |
| 163 |
2/2✓ Branch 1 taken 3 times.
✓ Branch 4 taken 3 times.
|
3 | idfObject.setString(WindowShadingControlFields::TypeofSlatAngleControlforBlinds, modelObject.typeofSlatAngleControlforBlinds()); |
| 164 | } | ||
| 165 | } | ||
| 166 | |||
| 167 |
3/3✓ Branch 1 taken 3 times.
✓ Branch 3 taken 1 time.
✓ Branch 4 taken 2 times.
|
3 | if (modelObject.isControlTypeValueNeedingSetpoint2()) { |
| 168 |
3/3✓ Branch 1 taken 1 time.
✓ Branch 4 taken 1 time.
✓ Branch 7 taken 1 time.
|
1 | idfObject.setDouble(WindowShadingControlFields::Setpoint2, modelObject.setpoint2().get()); |
| 169 | } | ||
| 170 | |||
| 171 |
2/2✓ Branch 1 taken 3 times.
✓ Branch 4 taken 3 times.
|
3 | idfObject.setString(WindowShadingControlFields::MultipleSurfaceControlType, modelObject.multipleSurfaceControlType()); |
| 172 | |||
| 173 |
1/1✓ Branch 1 taken 3 times.
|
3 | idfObject.clearExtensibleGroups(); |
| 174 |
2/2✓ Branch 5 taken 4 times.
✓ Branch 6 taken 3 times.
|
7 | for (const SubSurface& subSurface : subSurfaces) { |
| 175 |
1/1✓ Branch 1 taken 4 times.
|
4 | IdfExtensibleGroup group = idfObject.pushExtensibleGroup(); |
| 176 |
2/4✓ Branch 1 taken 4 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 4 times.
✗ Branch 6 not taken.
|
4 | OS_ASSERT(group.numFields() == 1); |
| 177 |
2/2✓ Branch 1 taken 4 times.
✓ Branch 4 taken 4 times.
|
4 | group.setString(0, subSurface.nameString()); |
| 178 | 4 | } | |
| 179 | |||
| 180 |
1/1✓ Branch 1 taken 3 times.
|
3 | return idfObject; |
| 181 | 4 | } | |
| 182 | |||
| 183 | } // namespace energyplus | ||
| 184 | |||
| 185 | } // namespace openstudio | ||
| 186 |