GCC Code Coverage Report


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

src/model/WaterHeaterHeatPump.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_WATERHEATERHEATPUMP_HPP
7 #define MODEL_WATERHEATERHEATPUMP_HPP
8
9 #include "ModelAPI.hpp"
10 #include "ZoneHVACComponent.hpp"
11
12 namespace openstudio {
13
14 namespace model {
15
16 class Schedule;
17 class HVACComponent;
18
19 namespace detail {
20
21 class WaterHeaterHeatPump_Impl;
22
23 } // namespace detail
24
25 /** WaterHeaterHeatPump is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:WaterHeater:HeatPump'.
26 * As of EnergyPlus version 8.4.0 this object maps to WaterHeaterHeatPumpPumpedCondenser in idf format.
27 */
28 class MODEL_API WaterHeaterHeatPump : public ZoneHVACComponent
29 {
30 public:
31 /** @name Constructors and Destructors */
32 //@{
33
34 explicit WaterHeaterHeatPump(const Model& model);
35
36 explicit WaterHeaterHeatPump(const Model& model, const ModelObject& dxCoil, const HVACComponent& tank, const HVACComponent& fan,
37 Schedule& compressorSetpointTemperatureSchedule, Schedule& inletAirMixerSchedule);
38
39 52 virtual ~WaterHeaterHeatPump() override = default;
40 // Default the copy and move operators because the virtual dtor is explicit
41 ✗ WaterHeaterHeatPump(const WaterHeaterHeatPump& other) = default;
42 15 WaterHeaterHeatPump(WaterHeaterHeatPump&& other) = default;
43 ✗ WaterHeaterHeatPump& operator=(const WaterHeaterHeatPump&) = default;
44 ✗ WaterHeaterHeatPump& operator=(WaterHeaterHeatPump&&) = default;
45
46 //@}
47
48 static IddObjectType iddObjectType();
49
50 static std::vector<std::string> inletAirConfigurationValues();
51
52 static std::vector<std::string> compressorLocationValues();
53
54 static std::vector<std::string> fanPlacementValues();
55
56 static std::vector<std::string> parasiticHeatRejectionLocationValues();
57
58 static std::vector<std::string> tankElementControlLogicValues();
59
60 static std::vector<std::string> controlSensorLocationInStratifiedTankValues();
61
62 /** @name Getters */
63 //@{
64
65 boost::optional<Schedule> availabilitySchedule() const;
66
67 Schedule compressorSetpointTemperatureSchedule() const;
68
69 double deadBandTemperatureDifference() const;
70
71 boost::optional<double> condenserWaterFlowRate() const;
72
73 bool isCondenserWaterFlowRateAutosized() const;
74
75 boost::optional<double> evaporatorAirFlowRate() const;
76
77 bool isEvaporatorAirFlowRateAutosized() const;
78
79 std::string inletAirConfiguration() const;
80
81 boost::optional<Schedule> inletAirTemperatureSchedule() const;
82
83 boost::optional<Schedule> inletAirHumiditySchedule() const;
84
85 HVACComponent tank() const;
86
87 ModelObject dXCoil() const;
88
89 double minimumInletAirTemperatureforCompressorOperation() const;
90
91 double maximumInletAirTemperatureforCompressorOperation() const;
92
93 std::string compressorLocation() const;
94
95 boost::optional<Schedule> compressorAmbientTemperatureSchedule() const;
96
97 HVACComponent fan() const;
98
99 std::string fanPlacement() const;
100
101 double onCycleParasiticElectricLoad() const;
102
103 double offCycleParasiticElectricLoad() const;
104
105 std::string parasiticHeatRejectionLocation() const;
106
107 Schedule inletAirMixerSchedule() const;
108
109 std::string tankElementControlLogic() const;
110
111 std::string controlSensorLocationInStratifiedTank() const;
112
113 //@}
114 /** @name Setters */
115 //@{
116
117 bool setAvailabilitySchedule(Schedule& schedule);
118
119 void resetAvailabilitySchedule();
120
121 bool setCompressorSetpointTemperatureSchedule(Schedule& schedule);
122
123 bool setDeadBandTemperatureDifference(double deadBandTemperatureDifference);
124
125 bool setCondenserWaterFlowRate(double condenserWaterFlowRate);
126
127 void resetCondenserWaterFlowRate();
128
129 void autosizeCondenserWaterFlowRate();
130
131 bool setEvaporatorAirFlowRate(double evaporatorAirFlowRate);
132
133 void resetEvaporatorAirFlowRate();
134
135 void autosizeEvaporatorAirFlowRate();
136
137 bool setInletAirConfiguration(const std::string& inletAirConfiguration);
138
139 bool setInletAirTemperatureSchedule(Schedule& schedule);
140
141 void resetInletAirTemperatureSchedule();
142
143 bool setInletAirHumiditySchedule(Schedule& schedule);
144
145 void resetInletAirHumiditySchedule();
146
147 bool setTank(const HVACComponent& waterHeater);
148
149 bool setDXCoil(const ModelObject& coil);
150
151 bool setMinimumInletAirTemperatureforCompressorOperation(double minimumInletAirTemperatureforCompressorOperation);
152
153 bool setMaximumInletAirTemperatureforCompressorOperation(double maximumInletAirTemperatureforCompressorOperation);
154
155 bool setCompressorLocation(const std::string& compressorLocation);
156
157 bool setCompressorAmbientTemperatureSchedule(Schedule& schedule);
158
159 void resetCompressorAmbientTemperatureSchedule();
160
161 bool setFan(const HVACComponent& fan);
162
163 bool setFanPlacement(const std::string& fanPlacement);
164
165 bool setOnCycleParasiticElectricLoad(double onCycleParasiticElectricLoad);
166
167 bool setOffCycleParasiticElectricLoad(double offCycleParasiticElectricLoad);
168
169 bool setParasiticHeatRejectionLocation(const std::string& parasiticHeatRejectionLocation);
170
171 bool setInletAirMixerSchedule(Schedule& schedule);
172
173 bool setTankElementControlLogic(const std::string& tankElementControlLogic);
174
175 bool setControlSensorLocationInStratifiedTank(const std::string& controlSensorLocationInStratifiedTank);
176
177 //@}
178 /** @name Other */
179 //@{
180
181 boost::optional<double> autosizedCondenserWaterFlowRate() const;
182
183 boost::optional<double> autosizedEvaporatorAirFlowRate() const;
184
185 //@}
186 protected:
187 /// @cond
188 using ImplType = detail::WaterHeaterHeatPump_Impl;
189
190 explicit WaterHeaterHeatPump(std::shared_ptr<detail::WaterHeaterHeatPump_Impl> impl);
191
192 friend class detail::WaterHeaterHeatPump_Impl;
193 friend class Model;
194 friend class IdfObject;
195 friend class openstudio::detail::IdfObject_Impl;
196 /// @endcond
197 private:
198 REGISTER_LOGGER("openstudio.model.WaterHeaterHeatPump");
199 };
200
201 /** \relates WaterHeaterHeatPump*/
202 using OptionalWaterHeaterHeatPump = boost::optional<WaterHeaterHeatPump>;
203
204 /** \relates WaterHeaterHeatPump*/
205 using WaterHeaterHeatPumpVector = std::vector<WaterHeaterHeatPump>;
206
207 } // namespace model
208 } // namespace openstudio
209
210 #endif // MODEL_WATERHEATERHEATPUMP_HPP
211