src/model/ZoneHVACWaterToAirHeatPump.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_HPP | ||
| 7 | #define MODEL_ZONEHVACWATERTOAIRHEATPUMP_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ZoneHVACComponent.hpp" | ||
| 11 | |||
| 12 | #include "../utilities/core/Deprecated.hpp" | ||
| 13 | |||
| 14 | namespace openstudio { | ||
| 15 | |||
| 16 | namespace model { | ||
| 17 | |||
| 18 | class Schedule; | ||
| 19 | class HVACComponent; | ||
| 20 | |||
| 21 | namespace detail { | ||
| 22 | |||
| 23 | class ZoneHVACWaterToAirHeatPump_Impl; | ||
| 24 | |||
| 25 | } // namespace detail | ||
| 26 | |||
| 27 | /** ZoneHVACWaterToAirHeatPump is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:ZoneHVAC:WaterToAirHeatPump'. */ | ||
| 28 | class MODEL_API ZoneHVACWaterToAirHeatPump : public ZoneHVACComponent | ||
| 29 | { | ||
| 30 | |||
| 31 | public: | ||
| 32 | /** @name Constructors and Destructors */ | ||
| 33 | //@{ | ||
| 34 | |||
| 35 | ZoneHVACWaterToAirHeatPump(const Model& model, Schedule& availabilitySchedule, HVACComponent& supplyAirFan, HVACComponent& heatingCoil, | ||
| 36 | HVACComponent& coolingCoil, HVACComponent& supplementalHeatingCoil); | ||
| 37 | |||
| 38 | 15 | virtual ~ZoneHVACWaterToAirHeatPump() override = default; | |
| 39 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 40 | ✗ | ZoneHVACWaterToAirHeatPump(const ZoneHVACWaterToAirHeatPump& other) = default; | |
| 41 | 3 | ZoneHVACWaterToAirHeatPump(ZoneHVACWaterToAirHeatPump&& other) = default; | |
| 42 | ✗ | ZoneHVACWaterToAirHeatPump& operator=(const ZoneHVACWaterToAirHeatPump&) = default; | |
| 43 | ✗ | ZoneHVACWaterToAirHeatPump& operator=(ZoneHVACWaterToAirHeatPump&&) = default; | |
| 44 | |||
| 45 | //@} | ||
| 46 | |||
| 47 | static IddObjectType iddObjectType(); | ||
| 48 | |||
| 49 | static std::vector<std::string> fanPlacementValues(); | ||
| 50 | |||
| 51 | static std::vector<std::string> heatPumpCoilWaterFlowModeValues(); | ||
| 52 | |||
| 53 | /** @name Getters */ | ||
| 54 | //@{ | ||
| 55 | |||
| 56 | Schedule availabilitySchedule() const; | ||
| 57 | |||
| 58 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Cooling Supply Air Flow Rate" **/ | ||
| 59 | boost::optional<double> supplyAirFlowRateDuringCoolingOperation() const; | ||
| 60 | |||
| 61 | bool isSupplyAirFlowRateDuringCoolingOperationAutosized() const; | ||
| 62 | |||
| 63 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Heating Supply Air Flow Rate" **/ | ||
| 64 | boost::optional<double> supplyAirFlowRateDuringHeatingOperation() const; | ||
| 65 | |||
| 66 | bool isSupplyAirFlowRateDuringHeatingOperationAutosized() const; | ||
| 67 | |||
| 68 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "No Load Supply Air Flow Rate" **/ | ||
| 69 | boost::optional<double> supplyAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 70 | |||
| 71 | bool isSupplyAirFlowRateWhenNoCoolingorHeatingisNeededAutosized() const; | ||
| 72 | |||
| 73 | bool noLoadSupplyAirFlowRateControlSetToLowSpeed() const; | ||
| 74 | |||
| 75 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Cooling Outdoor Air Flow Rate" **/ | ||
| 76 | boost::optional<double> outdoorAirFlowRateDuringCoolingOperation() const; | ||
| 77 | |||
| 78 | bool isOutdoorAirFlowRateDuringCoolingOperationAutosized() const; | ||
| 79 | |||
| 80 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Heating Outdoor Air Flow Rate" **/ | ||
| 81 | boost::optional<double> outdoorAirFlowRateDuringHeatingOperation() const; | ||
| 82 | |||
| 83 | bool isOutdoorAirFlowRateDuringHeatingOperationAutosized() const; | ||
| 84 | |||
| 85 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "No Load Outdoor Air Flow Rate" **/ | ||
| 86 | boost::optional<double> outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 87 | |||
| 88 | bool isOutdoorAirFlowRateWhenNoCoolingorHeatingisNeededAutosized() const; | ||
| 89 | |||
| 90 | HVACComponent supplyAirFan() const; | ||
| 91 | |||
| 92 | HVACComponent heatingCoil() const; | ||
| 93 | |||
| 94 | HVACComponent coolingCoil() const; | ||
| 95 | |||
| 96 | OS_DEPRECATED(3, 7, 0) double maximumCyclingRate() const; | ||
| 97 | |||
| 98 | OS_DEPRECATED(3, 7, 0) bool isMaximumCyclingRateDefaulted() const; | ||
| 99 | |||
| 100 | OS_DEPRECATED(3, 7, 0) double heatPumpTimeConstant() const; | ||
| 101 | |||
| 102 | OS_DEPRECATED(3, 7, 0) bool isHeatPumpTimeConstantDefaulted() const; | ||
| 103 | |||
| 104 | OS_DEPRECATED(3, 7, 0) double fractionofOnCyclePowerUse() const; | ||
| 105 | |||
| 106 | OS_DEPRECATED(3, 7, 0) bool isFractionofOnCyclePowerUseDefaulted() const; | ||
| 107 | |||
| 108 | OS_DEPRECATED(3, 7, 0) double heatPumpFanDelayTime() const; | ||
| 109 | |||
| 110 | OS_DEPRECATED(3, 7, 0) bool isHeatPumpFanDelayTimeDefaulted() const; | ||
| 111 | |||
| 112 | HVACComponent supplementalHeatingCoil() const; | ||
| 113 | |||
| 114 | boost::optional<double> maximumSupplyAirTemperaturefromSupplementalHeater() const; | ||
| 115 | |||
| 116 | bool isMaximumSupplyAirTemperaturefromSupplementalHeaterAutosized() const; | ||
| 117 | |||
| 118 | double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation() const; | ||
| 119 | |||
| 120 | bool isMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperationDefaulted() const; | ||
| 121 | |||
| 122 | std::string fanPlacement() const; | ||
| 123 | |||
| 124 | bool isFanPlacementDefaulted() const; | ||
| 125 | |||
| 126 | std::string heatPumpCoilWaterFlowMode() const; | ||
| 127 | |||
| 128 | bool isHeatPumpCoilWaterFlowModeDefaulted() const; | ||
| 129 | |||
| 130 | boost::optional<Schedule> supplyAirFanOperatingModeSchedule() const; | ||
| 131 | |||
| 132 | // TODO: field 'Availability Manager List Name' isn't implemented | ||
| 133 | |||
| 134 | // TODO: field 'Design Specification ZoneHVAC Sizing' isn't implemented since the object isn't wrapped in SDK | ||
| 135 | |||
| 136 | double dXHeatingCoilSizingRatio() const; | ||
| 137 | |||
| 138 | //@} | ||
| 139 | /** @name Setters */ | ||
| 140 | //@{ | ||
| 141 | |||
| 142 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 143 | |||
| 144 | bool setSupplyAirFlowRateDuringCoolingOperation(boost::optional<double> supplyAirFlowRateDuringCoolingOperation); | ||
| 145 | |||
| 146 | bool setSupplyAirFlowRateDuringCoolingOperation(double supplyAirFlowRateDuringCoolingOperation); | ||
| 147 | |||
| 148 | void resetSupplyAirFlowRateDuringCoolingOperation(); | ||
| 149 | |||
| 150 | void autosizeSupplyAirFlowRateDuringCoolingOperation(); | ||
| 151 | |||
| 152 | bool setSupplyAirFlowRateDuringHeatingOperation(boost::optional<double> supplyAirFlowRateDuringHeatingOperation); | ||
| 153 | |||
| 154 | bool setSupplyAirFlowRateDuringHeatingOperation(double supplyAirFlowRateDuringHeatingOperation); | ||
| 155 | |||
| 156 | void resetSupplyAirFlowRateDuringHeatingOperation(); | ||
| 157 | |||
| 158 | void autosizeSupplyAirFlowRateDuringHeatingOperation(); | ||
| 159 | |||
| 160 | bool setSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(boost::optional<double> supplyAirFlowRateWhenNoCoolingorHeatingisNeeded); | ||
| 161 | |||
| 162 | bool setSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(double supplyAirFlowRateWhenNoCoolingorHeatingisNeeded); | ||
| 163 | |||
| 164 | void resetSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 165 | |||
| 166 | void autosizeSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 167 | |||
| 168 | bool setNoLoadSupplyAirFlowRateControlSetToLowSpeed(bool noLoadSupplyAirFlowRateControlSetToLowSpeed); | ||
| 169 | |||
| 170 | bool setOutdoorAirFlowRateDuringCoolingOperation(boost::optional<double> outdoorAirFlowRateDuringCoolingOperation); | ||
| 171 | |||
| 172 | bool setOutdoorAirFlowRateDuringCoolingOperation(double outdoorAirFlowRateDuringCoolingOperation); | ||
| 173 | |||
| 174 | void resetOutdoorAirFlowRateDuringCoolingOperation(); | ||
| 175 | |||
| 176 | void autosizeOutdoorAirFlowRateDuringCoolingOperation(); | ||
| 177 | |||
| 178 | bool setOutdoorAirFlowRateDuringHeatingOperation(boost::optional<double> outdoorAirFlowRateDuringHeatingOperation); | ||
| 179 | |||
| 180 | bool setOutdoorAirFlowRateDuringHeatingOperation(double outdoorAirFlowRateDuringHeatingOperation); | ||
| 181 | |||
| 182 | void resetOutdoorAirFlowRateDuringHeatingOperation(); | ||
| 183 | |||
| 184 | void autosizeOutdoorAirFlowRateDuringHeatingOperation(); | ||
| 185 | |||
| 186 | bool setOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(boost::optional<double> outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded); | ||
| 187 | |||
| 188 | bool setOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(double outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded); | ||
| 189 | |||
| 190 | void resetOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 191 | |||
| 192 | void autosizeOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 193 | |||
| 194 | bool setSupplyAirFan(HVACComponent& fansOnOff); | ||
| 195 | |||
| 196 | bool setHeatingCoil(HVACComponent& heatingCoils); | ||
| 197 | |||
| 198 | bool setCoolingCoil(HVACComponent& coolingCoils); | ||
| 199 | |||
| 200 | OS_DEPRECATED(3, 7, 0) bool setMaximumCyclingRate(boost::optional<double> maximumCyclingRate); | ||
| 201 | |||
| 202 | OS_DEPRECATED(3, 7, 0) bool setMaximumCyclingRate(double maximumCyclingRate); | ||
| 203 | |||
| 204 | OS_DEPRECATED(3, 7, 0) void resetMaximumCyclingRate(); | ||
| 205 | |||
| 206 | OS_DEPRECATED(3, 7, 0) bool setHeatPumpTimeConstant(boost::optional<double> heatPumpTimeConstant); | ||
| 207 | |||
| 208 | OS_DEPRECATED(3, 7, 0) bool setHeatPumpTimeConstant(double heatPumpTimeConstant); | ||
| 209 | |||
| 210 | OS_DEPRECATED(3, 7, 0) void resetHeatPumpTimeConstant(); | ||
| 211 | |||
| 212 | OS_DEPRECATED(3, 7, 0) bool setFractionofOnCyclePowerUse(boost::optional<double> fractionofOnCyclePowerUse); | ||
| 213 | |||
| 214 | OS_DEPRECATED(3, 7, 0) bool setFractionofOnCyclePowerUse(double fractionofOnCyclePowerUse); | ||
| 215 | |||
| 216 | OS_DEPRECATED(3, 7, 0) void resetFractionofOnCyclePowerUse(); | ||
| 217 | |||
| 218 | OS_DEPRECATED(3, 7, 0) bool setHeatPumpFanDelayTime(boost::optional<double> heatPumpFanDelayTime); | ||
| 219 | |||
| 220 | OS_DEPRECATED(3, 7, 0) bool setHeatPumpFanDelayTime(double heatPumpFanDelayTime); | ||
| 221 | |||
| 222 | OS_DEPRECATED(3, 7, 0) void resetHeatPumpFanDelayTime(); | ||
| 223 | |||
| 224 | bool setSupplementalHeatingCoil(HVACComponent& heatingCoilName); | ||
| 225 | |||
| 226 | bool setMaximumSupplyAirTemperaturefromSupplementalHeater(boost::optional<double> maximumSupplyAirTemperaturefromSupplementalHeater); | ||
| 227 | |||
| 228 | bool setMaximumSupplyAirTemperaturefromSupplementalHeater(double maximumSupplyAirTemperaturefromSupplementalHeater); | ||
| 229 | |||
| 230 | void resetMaximumSupplyAirTemperaturefromSupplementalHeater(); | ||
| 231 | |||
| 232 | void autosizeMaximumSupplyAirTemperaturefromSupplementalHeater(); | ||
| 233 | |||
| 234 | bool setMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation( | ||
| 235 | boost::optional<double> maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation); | ||
| 236 | |||
| 237 | bool setMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation(double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation); | ||
| 238 | |||
| 239 | void resetMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation(); | ||
| 240 | |||
| 241 | // DLM: this appears to not be implemented | ||
| 242 | //bool setOutdoorDryBulbTemperatureSensorNodeName(const std::string& outdoorDryBulbTemperatureSensorNodeName); | ||
| 243 | |||
| 244 | bool setFanPlacement(const std::string& fanPlacement); | ||
| 245 | |||
| 246 | void resetFanPlacement(); | ||
| 247 | |||
| 248 | bool setHeatPumpCoilWaterFlowMode(const std::string& heatPumpCoilWaterFlowMode); | ||
| 249 | |||
| 250 | void resetHeatPumpCoilWaterFlowMode(); | ||
| 251 | |||
| 252 | bool setSupplyAirFanOperatingModeSchedule(Schedule& schedule); | ||
| 253 | |||
| 254 | void resetSupplyAirFanOperatingModeSchedule(); | ||
| 255 | |||
| 256 | bool setDXHeatingCoilSizingRatio(double dXHeatingCoilSizingRatio); | ||
| 257 | |||
| 258 | //@} | ||
| 259 | /** @name Other */ | ||
| 260 | //@{ | ||
| 261 | |||
| 262 | boost::optional<double> autosizedSupplyAirFlowRateDuringCoolingOperation() const; | ||
| 263 | |||
| 264 | boost::optional<double> autosizedSupplyAirFlowRateDuringHeatingOperation() const; | ||
| 265 | |||
| 266 | boost::optional<double> autosizedSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 267 | |||
| 268 | boost::optional<double> autosizedOutdoorAirFlowRateDuringCoolingOperation() const; | ||
| 269 | |||
| 270 | boost::optional<double> autosizedOutdoorAirFlowRateDuringHeatingOperation() const; | ||
| 271 | |||
| 272 | boost::optional<double> autosizedOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 273 | |||
| 274 | boost::optional<double> autosizedMaximumSupplyAirTemperaturefromSupplementalHeater() const; | ||
| 275 | |||
| 276 | //@} | ||
| 277 | protected: | ||
| 278 | /// @cond | ||
| 279 | using ImplType = detail::ZoneHVACWaterToAirHeatPump_Impl; | ||
| 280 | |||
| 281 | explicit ZoneHVACWaterToAirHeatPump(std::shared_ptr<detail::ZoneHVACWaterToAirHeatPump_Impl> impl); | ||
| 282 | |||
| 283 | friend class detail::ZoneHVACWaterToAirHeatPump_Impl; | ||
| 284 | friend class Model; | ||
| 285 | friend class IdfObject; | ||
| 286 | friend class openstudio::detail::IdfObject_Impl; | ||
| 287 | /// @endcond | ||
| 288 | private: | ||
| 289 | − | REGISTER_LOGGER("openstudio.model.ZoneHVACWaterToAirHeatPump"); | |
| 290 | }; | ||
| 291 | |||
| 292 | /** \relates ZoneHVACWaterToAirHeatPump*/ | ||
| 293 | using OptionalZoneHVACWaterToAirHeatPump = boost::optional<ZoneHVACWaterToAirHeatPump>; | ||
| 294 | |||
| 295 | /** \relates ZoneHVACWaterToAirHeatPump*/ | ||
| 296 | using ZoneHVACWaterToAirHeatPumpVector = std::vector<ZoneHVACWaterToAirHeatPump>; | ||
| 297 | |||
| 298 | } // namespace model | ||
| 299 | } // namespace openstudio | ||
| 300 | |||
| 301 | #endif // MODEL_ZONEHVACWATERTOAIRHEATPUMP_HPP | ||
| 302 |