GCC Code Coverage Report


Directory: ./
Coverage: low: ≥ 0% medium: ≥ 75.0% high: ≥ 90.0%
Coverage Exec / Excl / Total
Lines: 60.0% 3 / 0 / 5
Functions: 60.0% 3 / 0 / 5
Branches: -% 0 / 0 / 0

src/model/SizingZone.hpp
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 #ifndef MODEL_SIZINGZONE_HPP
7 #define MODEL_SIZINGZONE_HPP
8
9 #include "ModelAPI.hpp"
10 #include "ModelObject.hpp"
11
12 namespace openstudio {
13
14 namespace model {
15
16 class ThermalZone;
17 class Schedule;
18
19 namespace detail {
20
21 class SizingZone_Impl;
22
23 } // namespace detail
24
25 /** SizingZone is a ModelObject that wraps the OpenStudio IDD object 'OS:Sizing:Zone'. */
26 class MODEL_API SizingZone : public ModelObject
27 {
28 public:
29 /** @name Constructors and Destructors */
30 //@{
31
32 explicit SizingZone(const Model& model, const ThermalZone& thermalZone);
33
34 4841 virtual ~SizingZone() override = default;
35 // Default the copy and move operators because the virtual dtor is explicit
36 795 SizingZone(const SizingZone& other) = default;
37 796 SizingZone(SizingZone&& other) = default;
38 ✗ SizingZone& operator=(const SizingZone&) = default;
39 ✗ SizingZone& operator=(SizingZone&&) = default;
40
41 //@}
42
43 static IddObjectType iddObjectType();
44
45 static std::vector<std::string> coolingDesignAirFlowMethodValues();
46 static std::vector<std::string> heatingDesignAirFlowMethodValues();
47 static std::vector<std::string> zoneCoolingDesignSupplyAirTemperatureInputMethodValues();
48 static std::vector<std::string> zoneHeatingDesignSupplyAirTemperatureInputMethodValues();
49 static std::vector<std::string> zoneLoadSizingMethodValues();
50 static std::vector<std::string> zoneLatentCoolingDesignSupplyAirHumidityRatioInputMethodValues();
51 static std::vector<std::string> zoneLatentHeatingDesignSupplyAirHumidityRatioInputMethodValues();
52 static std::vector<std::string> validSizingOptionValues();
53 static std::vector<std::string> heatingCoilSizingMethodValues();
54
55 /** @name Getters */
56 //@{
57
58 ThermalZone thermalZone() const;
59
60 std::string zoneCoolingDesignSupplyAirTemperatureInputMethod() const;
61
62 double zoneCoolingDesignSupplyAirTemperature() const;
63
64 double zoneCoolingDesignSupplyAirTemperatureDifference() const;
65
66 std::string zoneHeatingDesignSupplyAirTemperatureInputMethod() const;
67
68 double zoneHeatingDesignSupplyAirTemperature() const;
69
70 double zoneHeatingDesignSupplyAirTemperatureDifference() const;
71
72 double zoneCoolingDesignSupplyAirHumidityRatio() const;
73
74 double zoneHeatingDesignSupplyAirHumidityRatio() const;
75
76 boost::optional<double> zoneHeatingSizingFactor() const;
77
78 boost::optional<double> zoneCoolingSizingFactor() const;
79
80 std::string coolingDesignAirFlowMethod() const;
81
82 bool isCoolingDesignAirFlowMethodDefaulted() const;
83
84 double coolingDesignAirFlowRate() const;
85
86 bool isCoolingDesignAirFlowRateDefaulted() const;
87
88 double coolingMinimumAirFlowperZoneFloorArea() const;
89
90 bool isCoolingMinimumAirFlowperZoneFloorAreaDefaulted() const;
91
92 double coolingMinimumAirFlow() const;
93
94 bool isCoolingMinimumAirFlowDefaulted() const;
95
96 double coolingMinimumAirFlowFraction() const;
97
98 bool isCoolingMinimumAirFlowFractionDefaulted() const;
99
100 std::string heatingDesignAirFlowMethod() const;
101
102 bool isHeatingDesignAirFlowMethodDefaulted() const;
103
104 double heatingDesignAirFlowRate() const;
105
106 bool isHeatingDesignAirFlowRateDefaulted() const;
107
108 double heatingMaximumAirFlowperZoneFloorArea() const;
109
110 bool isHeatingMaximumAirFlowperZoneFloorAreaDefaulted() const;
111
112 double heatingMaximumAirFlow() const;
113
114 bool isHeatingMaximumAirFlowDefaulted() const;
115
116 double heatingMaximumAirFlowFraction() const;
117
118 bool isHeatingMaximumAirFlowFractionDefaulted() const;
119
120 bool accountforDedicatedOutdoorAirSystem() const;
121
122 std::string dedicatedOutdoorAirSystemControlStrategy() const;
123
124 boost::optional<double> dedicatedOutdoorAirLowSetpointTemperatureforDesign() const;
125
126 bool isDedicatedOutdoorAirLowSetpointTemperatureforDesignAutosized() const;
127
128 boost::optional<double> dedicatedOutdoorAirHighSetpointTemperatureforDesign() const;
129
130 bool isDedicatedOutdoorAirHighSetpointTemperatureforDesignAutosized() const;
131
132 std::string zoneLoadSizingMethod() const;
133
134 std::string zoneLatentCoolingDesignSupplyAirHumidityRatioInputMethod() const;
135
136 boost::optional<double> zoneDehumidificationDesignSupplyAirHumidityRatio() const;
137
138 double zoneCoolingDesignSupplyAirHumidityRatioDifference() const;
139
140 std::string zoneLatentHeatingDesignSupplyAirHumidityRatioInputMethod() const;
141
142 boost::optional<double> zoneHumidificationDesignSupplyAirHumidityRatio() const;
143
144 double zoneHumidificationDesignSupplyAirHumidityRatioDifference() const;
145
146 boost::optional<Schedule> zoneHumidistatDehumidificationSetPointSchedule() const;
147
148 boost::optional<Schedule> zoneHumidistatHumidificationSetPointSchedule() const;
149
150 // Fields from DesignSpecification:ZoneAirDistribution
151
152 double designZoneAirDistributionEffectivenessinCoolingMode() const;
153
154 bool isDesignZoneAirDistributionEffectivenessinCoolingModeDefaulted() const;
155
156 double designZoneAirDistributionEffectivenessinHeatingMode() const;
157
158 bool isDesignZoneAirDistributionEffectivenessinHeatingModeDefaulted() const;
159
160 double designZoneSecondaryRecirculationFraction() const;
161
162 bool isDesignZoneSecondaryRecirculationFractionDefaulted() const;
163
164 double designMinimumZoneVentilationEfficiency() const;
165
166 bool isDesignMinimumZoneVentilationEfficiencyDefaulted() const;
167
168 std::string sizingOption() const;
169
170 std::string heatingCoilSizingMethod() const;
171
172 double maximumHeatingCapacityToCoolingLoadSizingRatio() const;
173
174 //@}
175 /** @name Setters */
176 //@{
177
178 bool setZoneCoolingDesignSupplyAirTemperatureInputMethod(const std::string& value);
179
180 bool setZoneCoolingDesignSupplyAirTemperature(double zoneCoolingDesignSupplyAirTemperature);
181
182 bool setZoneCoolingDesignSupplyAirTemperatureDifference(double value);
183
184 bool setZoneHeatingDesignSupplyAirTemperatureInputMethod(const std::string& value);
185
186 bool setZoneHeatingDesignSupplyAirTemperature(double zoneHeatingDesignSupplyAirTemperature);
187
188 bool setZoneHeatingDesignSupplyAirTemperatureDifference(double value);
189
190 bool setZoneCoolingDesignSupplyAirHumidityRatio(double zoneCoolingDesignSupplyAirHumidityRatio);
191
192 bool setZoneHeatingDesignSupplyAirHumidityRatio(double zoneHeatingDesignSupplyAirHumidityRatio);
193
194 bool setZoneHeatingSizingFactor(double zoneHeatingSizingFactor);
195
196 void resetZoneHeatingSizingFactor();
197
198 bool setZoneCoolingSizingFactor(double zoneCoolingSizingFactor);
199
200 void resetZoneCoolingSizingFactor();
201
202 bool setCoolingDesignAirFlowMethod(const std::string& coolingDesignAirFlowMethod);
203
204 void resetCoolingDesignAirFlowMethod();
205
206 bool setCoolingDesignAirFlowRate(double coolingDesignAirFlowRate);
207
208 void resetCoolingDesignAirFlowRate();
209
210 bool setCoolingMinimumAirFlowperZoneFloorArea(double coolingMinimumAirFlowperZoneFloorArea);
211
212 void resetCoolingMinimumAirFlowperZoneFloorArea();
213
214 bool setCoolingMinimumAirFlow(double coolingMinimumAirFlow);
215
216 void resetCoolingMinimumAirFlow();
217
218 bool setCoolingMinimumAirFlowFraction(double coolingMinimumAirFlowFraction);
219
220 void resetCoolingMinimumAirFlowFraction();
221
222 bool setHeatingDesignAirFlowMethod(const std::string& heatingDesignAirFlowMethod);
223
224 void resetHeatingDesignAirFlowMethod();
225
226 bool setHeatingDesignAirFlowRate(double heatingDesignAirFlowRate);
227
228 void resetHeatingDesignAirFlowRate();
229
230 bool setHeatingMaximumAirFlowperZoneFloorArea(double heatingMaximumAirFlowperZoneFloorArea);
231
232 void resetHeatingMaximumAirFlowperZoneFloorArea();
233
234 bool setHeatingMaximumAirFlow(double heatingMaximumAirFlow);
235
236 void resetHeatingMaximumAirFlow();
237
238 bool setHeatingMaximumAirFlowFraction(double heatingMaximumAirFlowFraction);
239
240 void resetHeatingMaximumAirFlowFraction();
241
242 bool setAccountforDedicatedOutdoorAirSystem(bool accountforDedicatedOutdoorAirSystem);
243
244 bool setDedicatedOutdoorAirSystemControlStrategy(const std::string& dedicatedOutdoorAirSystemControlStrategy);
245
246 bool setDedicatedOutdoorAirLowSetpointTemperatureforDesign(double dedicatedOutdoorAirLowSetpointTemperatureforDesign);
247
248 void autosizeDedicatedOutdoorAirLowSetpointTemperatureforDesign();
249
250 bool setDedicatedOutdoorAirHighSetpointTemperatureforDesign(double dedicatedOutdoorAirHighSetpointTemperatureforDesign);
251
252 void autosizeDedicatedOutdoorAirHighSetpointTemperatureforDesign();
253
254 bool setZoneLoadSizingMethod(const std::string& zoneLoadSizingMethod);
255
256 bool setZoneLatentCoolingDesignSupplyAirHumidityRatioInputMethod(const std::string& zoneLatentCoolingDesignSupplyAirHumidityRatioInputMethod);
257
258 bool setZoneDehumidificationDesignSupplyAirHumidityRatio(double zoneDehumidificationDesignSupplyAirHumidityRatio);
259 void resetZoneDehumidificationDesignSupplyAirHumidityRatio();
260
261 bool setZoneCoolingDesignSupplyAirHumidityRatioDifference(double zoneCoolingDesignSupplyAirHumidityRatioDifference);
262
263 bool setZoneLatentHeatingDesignSupplyAirHumidityRatioInputMethod(const std::string& zoneLatentHeatingDesignSupplyAirHumidityRatioInputMethod);
264
265 bool setZoneHumidificationDesignSupplyAirHumidityRatio(double zoneHumidificationDesignSupplyAirHumidityRatio);
266 void resetZoneHumidificationDesignSupplyAirHumidityRatio();
267
268 bool setZoneHumidificationDesignSupplyAirHumidityRatioDifference(double zoneHumidificationDesignSupplyAirHumidityRatioDifference);
269
270 bool setZoneHumidistatDehumidificationSetPointSchedule(Schedule& schedule);
271 void resetZoneHumidistatDehumidificationSetPointSchedule();
272
273 bool setZoneHumidistatHumidificationSetPointSchedule(Schedule& schedule);
274 void resetZoneHumidistatHumidificationSetPointSchedule();
275
276 // Fields from DesignSpecification:ZoneAirDistribution
277
278 bool setDesignZoneAirDistributionEffectivenessinCoolingMode(double designZoneAirDistributionEffectivenessinCoolingMode);
279
280 void resetDesignZoneAirDistributionEffectivenessinCoolingMode();
281
282 bool setDesignZoneAirDistributionEffectivenessinHeatingMode(double designZoneAirDistributionEffectivenessinHeatingMode);
283
284 void resetDesignZoneAirDistributionEffectivenessinHeatingMode();
285
286 bool setDesignZoneSecondaryRecirculationFraction(double designZoneSecondaryRecirculationFraction);
287
288 void resetDesignZoneSecondaryRecirculationFraction();
289
290 bool setDesignMinimumZoneVentilationEfficiency(double designMinimumZoneVentilationEfficiency);
291
292 void resetDesignMinimumZoneVentilationEfficiency();
293
294 bool setSizingOption(const std::string& sizingOption);
295
296 bool setHeatingCoilSizingMethod(const std::string& heatingCoilSizingMethod);
297
298 bool setMaximumHeatingCapacityToCoolingLoadSizingRatio(double maximumHeatingCapacityToCoolingLoadSizingRatio);
299
300 //@}
301 /** @name Other */
302 //@{
303
304 boost::optional<double> autosizedDedicatedOutdoorAirLowSetpointTemperatureforDesign() const;
305
306 boost::optional<double> autosizedDedicatedOutdoorAirHighSetpointTemperatureforDesign() const;
307
308 void autosize();
309
310 void applySizingValues();
311
312 //@}
313 protected:
314 bool setThermalZone(const ThermalZone& thermalZone);
315
316 /// @cond
317 using ImplType = detail::SizingZone_Impl;
318
319 explicit SizingZone(std::shared_ptr<detail::SizingZone_Impl> impl);
320
321 friend class detail::SizingZone_Impl;
322 friend class Model;
323 friend class IdfObject;
324 friend class openstudio::detail::IdfObject_Impl;
325 friend class ThermalZone;
326
327 /// @endcond
328 private:
329 REGISTER_LOGGER("openstudio.model.SizingZone");
330 };
331
332 /** \relates SizingZone*/
333 using OptionalSizingZone = boost::optional<SizingZone>;
334
335 /** \relates SizingZone*/
336 using SizingZoneVector = std::vector<SizingZone>;
337
338 } // namespace model
339 } // namespace openstudio
340
341 #endif // MODEL_SIZINGZONE_HPP
342