GCC Code Coverage Report


Directory: ./
Coverage: low: ≥ 0% medium: ≥ 75.0% high: ≥ 90.0%
Coverage Exec / Excl / Total
Lines: 100.0% 1 / 1 / 2
Functions: 100.0% 1 / 1 / 2
Branches: -% 0 / 1 / 1

src/model/ZoneHVACWaterToAirHeatPump_Impl.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_ZONEHVACWATERTOAIRHEATPUMP_IMPL_HPP
7 #define MODEL_ZONEHVACWATERTOAIRHEATPUMP_IMPL_HPP
8
9 #include "ModelAPI.hpp"
10 #include "ZoneHVACComponent_Impl.hpp"
11
12 namespace openstudio {
13 namespace model {
14
15 class Schedule;
16
17 class HVACComponent;
18
19 namespace detail {
20
21 /** ZoneHVACWaterToAirHeatPump_Impl is a ZoneHVACComponent_Impl that is the implementation class for ZoneHVACWaterToAirHeatPump.*/
22 class MODEL_API ZoneHVACWaterToAirHeatPump_Impl : public ZoneHVACComponent_Impl
23 {
24
25 public:
26 /** @name Constructors and Destructors */
27 //@{
28
29 ZoneHVACWaterToAirHeatPump_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle);
30
31 ZoneHVACWaterToAirHeatPump_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle);
32
33 ZoneHVACWaterToAirHeatPump_Impl(const ZoneHVACWaterToAirHeatPump_Impl& other, Model_Impl* model, bool keepHandle);
34
35 15 virtual ~ZoneHVACWaterToAirHeatPump_Impl() override = default;
36
37 //@}
38 /** @name Virtual Methods */
39 //@{
40
41 virtual ModelObject clone(Model model) const override;
42
43 virtual std::vector<IdfObject> remove() override;
44
45 virtual const std::vector<std::string>& outputVariableNames() const override;
46
47 virtual IddObjectType iddObjectType() const override;
48
49 virtual std::vector<ScheduleTypeKey> getScheduleTypeKeys(const Schedule& schedule) const override;
50
51 virtual std::vector<ModelObject> children() const override;
52
53 virtual unsigned inletPort() const override;
54
55 virtual unsigned outletPort() const override;
56
57 virtual ComponentType componentType() const override;
58 virtual std::vector<FuelType> coolingFuelTypes() const override;
59 virtual std::vector<FuelType> heatingFuelTypes() const override;
60 virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override;
61
62 //@}
63 /** @name Getters */
64 //@{
65
66 Schedule availabilitySchedule() const;
67
68 boost::optional<double> supplyAirFlowRateDuringCoolingOperation() const;
69
70 bool isSupplyAirFlowRateDuringCoolingOperationAutosized() const;
71
72 boost::optional<double> supplyAirFlowRateDuringHeatingOperation() const;
73
74 bool isSupplyAirFlowRateDuringHeatingOperationAutosized() const;
75
76 boost::optional<double> supplyAirFlowRateWhenNoCoolingorHeatingisNeeded() const;
77
78 bool isSupplyAirFlowRateWhenNoCoolingorHeatingisNeededAutosized() const;
79
80 bool noLoadSupplyAirFlowRateControlSetToLowSpeed() const;
81
82 boost::optional<double> outdoorAirFlowRateDuringCoolingOperation() const;
83
84 bool isOutdoorAirFlowRateDuringCoolingOperationAutosized() const;
85
86 boost::optional<double> outdoorAirFlowRateDuringHeatingOperation() const;
87
88 bool isOutdoorAirFlowRateDuringHeatingOperationAutosized() const;
89
90 boost::optional<double> outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded() const;
91
92 bool isOutdoorAirFlowRateWhenNoCoolingorHeatingisNeededAutosized() const;
93
94 HVACComponent supplyAirFan() const;
95
96 HVACComponent heatingCoil() const;
97
98 HVACComponent coolingCoil() const;
99
100 HVACComponent supplementalHeatingCoil() const;
101
102 boost::optional<double> maximumSupplyAirTemperaturefromSupplementalHeater() const;
103
104 bool isMaximumSupplyAirTemperaturefromSupplementalHeaterAutosized() const;
105
106 double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation() const;
107
108 bool isMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperationDefaulted() const;
109
110 std::string outdoorDryBulbTemperatureSensorNodeName() const;
111
112 std::string fanPlacement() const;
113
114 bool isFanPlacementDefaulted() const;
115
116 std::string heatPumpCoilWaterFlowMode() const;
117 bool isHeatPumpCoilWaterFlowModeDefaulted() const;
118
119 boost::optional<Schedule> supplyAirFanOperatingModeSchedule() const;
120
121 double dXHeatingCoilSizingRatio() const;
122
123 boost::optional<double> autosizedSupplyAirFlowRateDuringCoolingOperation() const;
124
125 boost::optional<double> autosizedSupplyAirFlowRateDuringHeatingOperation() const;
126
127 boost::optional<double> autosizedSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded() const;
128
129 boost::optional<double> autosizedOutdoorAirFlowRateDuringCoolingOperation() const;
130
131 boost::optional<double> autosizedOutdoorAirFlowRateDuringHeatingOperation() const;
132
133 boost::optional<double> autosizedOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded() const;
134
135 boost::optional<double> autosizedMaximumSupplyAirTemperaturefromSupplementalHeater() const;
136
137 virtual void autosize() override;
138
139 virtual void applySizingValues() override;
140
141 //@}
142 /** @name Setters */
143 //@{
144
145 bool setAvailabilitySchedule(Schedule& schedule);
146
147 bool setSupplyAirFlowRateDuringCoolingOperation(boost::optional<double> supplyAirFlowRateDuringCoolingOperation);
148
149 bool setSupplyAirFlowRateDuringCoolingOperation(double supplyAirFlowRateDuringCoolingOperation);
150
151 void resetSupplyAirFlowRateDuringCoolingOperation();
152
153 void autosizeSupplyAirFlowRateDuringCoolingOperation();
154
155 bool setSupplyAirFlowRateDuringHeatingOperation(boost::optional<double> supplyAirFlowRateDuringHeatingOperation);
156
157 bool setSupplyAirFlowRateDuringHeatingOperation(double supplyAirFlowRateDuringHeatingOperation);
158
159 void resetSupplyAirFlowRateDuringHeatingOperation();
160
161 void autosizeSupplyAirFlowRateDuringHeatingOperation();
162
163 bool setSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(boost::optional<double> supplyAirFlowRateWhenNoCoolingorHeatingisNeeded);
164
165 bool setSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(double supplyAirFlowRateWhenNoCoolingorHeatingisNeeded);
166
167 void resetSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded();
168
169 void autosizeSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded();
170
171 bool setNoLoadSupplyAirFlowRateControlSetToLowSpeed(bool noLoadSupplyAirFlowRateControlSetToLowSpeed);
172
173 bool setOutdoorAirFlowRateDuringCoolingOperation(boost::optional<double> outdoorAirFlowRateDuringCoolingOperation);
174
175 bool setOutdoorAirFlowRateDuringCoolingOperation(double outdoorAirFlowRateDuringCoolingOperation);
176
177 void resetOutdoorAirFlowRateDuringCoolingOperation();
178
179 void autosizeOutdoorAirFlowRateDuringCoolingOperation();
180
181 bool setOutdoorAirFlowRateDuringHeatingOperation(boost::optional<double> outdoorAirFlowRateDuringHeatingOperation);
182
183 bool setOutdoorAirFlowRateDuringHeatingOperation(double outdoorAirFlowRateDuringHeatingOperation);
184
185 void resetOutdoorAirFlowRateDuringHeatingOperation();
186
187 void autosizeOutdoorAirFlowRateDuringHeatingOperation();
188
189 bool setOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(boost::optional<double> outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded);
190
191 bool setOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(double outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded);
192
193 void resetOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded();
194
195 void autosizeOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded();
196
197 bool setSupplyAirFan(HVACComponent& fansOnOff);
198
199 bool setHeatingCoil(HVACComponent& heatingCoilsWaterToAirHP);
200
201 bool setCoolingCoil(HVACComponent& coolingCoilsWaterToAirHP);
202
203 bool setSupplementalHeatingCoil(HVACComponent& heatingCoilName);
204
205 bool setMaximumSupplyAirTemperaturefromSupplementalHeater(boost::optional<double> maximumSupplyAirTemperaturefromSupplementalHeater);
206
207 bool setMaximumSupplyAirTemperaturefromSupplementalHeater(double maximumSupplyAirTemperaturefromSupplementalHeater);
208
209 void resetMaximumSupplyAirTemperaturefromSupplementalHeater();
210
211 void autosizeMaximumSupplyAirTemperaturefromSupplementalHeater();
212
213 bool setMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation(
214 boost::optional<double> maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation);
215
216 bool setMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation(double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation);
217
218 void resetMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation();
219
220 // DLM: this appears to not be implemented
221 //bool setOutdoorDryBulbTemperatureSensorNodeName(const std::string& outdoorDryBulbTemperatureSensorNodeName);
222
223 bool setFanPlacement(const std::string& fanPlacement);
224
225 void resetFanPlacement();
226
227 bool setHeatPumpCoilWaterFlowMode(const std::string& heatPumpCoilWaterFlowMode);
228
229 void resetHeatPumpCoilWaterFlowMode();
230
231 bool setSupplyAirFanOperatingModeSchedule(Schedule& schedule);
232
233 void resetSupplyAirFanOperatingModeSchedule();
234
235 bool setDXHeatingCoilSizingRatio(double dXHeatingCoilSizingRatio);
236
237 //@}
238 /** @name Other */
239 //@{
240
241 //@}
242 protected:
243 private:
244 − REGISTER_LOGGER("openstudio.model.ZoneHVACWaterToAirHeatPump");
245
246 // Optional getters for use by methods like children() so can remove() if the constructor fails.
247 // There are other ways for the public versions of these getters to fail--perhaps all required
248 // objects should be returned as boost::optionals
249 boost::optional<Schedule> optionalAvailabilitySchedule() const;
250 boost::optional<HVACComponent> optionalSupplyAirFan() const;
251 boost::optional<HVACComponent> optionalHeatingCoil() const;
252 boost::optional<HVACComponent> optionalCoolingCoil() const;
253 boost::optional<HVACComponent> optionalSupplementalHeatingCoil() const;
254
255 std::vector<std::string> fanPlacementValues() const;
256 std::vector<std::string> heatPumpCoilWaterFlowModeValues() const;
257
258 boost::optional<ModelObject> availabilityScheduleAsModelObject() const;
259 boost::optional<ModelObject> supplyAirFanAsModelObject() const;
260 boost::optional<ModelObject> heatingCoilAsModelObject() const;
261 boost::optional<ModelObject> coolingCoilAsModelObject() const;
262 boost::optional<ModelObject> supplementalHeatingCoilAsModelObject() const;
263 boost::optional<ModelObject> supplyAirFanOperatingModeScheduleAsModelObject() const;
264
265 bool setAvailabilityScheduleAsModelObject(const boost::optional<ModelObject>& modelObject);
266 bool setSupplyAirFanAsModelObject(const boost::optional<ModelObject>& modelObject);
267 bool setHeatingCoilAsModelObject(const boost::optional<ModelObject>& modelObject);
268 bool setCoolingCoilAsModelObject(const boost::optional<ModelObject>& modelObject);
269 bool setSupplementalHeatingCoilAsModelObject(const boost::optional<ModelObject>& modelObject);
270 bool setSupplyAirFanOperatingModeScheduleAsModelObject(const boost::optional<ModelObject>& modelObject);
271 };
272
273 } // namespace detail
274
275 } // namespace model
276 } // namespace openstudio
277
278 #endif // MODEL_ZONEHVACWATERTOAIRHEATPUMP_IMPL_HPP
279