src/model/ZoneHVACPackagedTerminalHeatPump.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_ZONEHVACPACKAGEDTERMINALHEATPUMP_HPP | ||
| 7 | #define MODEL_ZONEHVACPACKAGEDTERMINALHEATPUMP_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 ZoneHVACPackagedTerminalHeatPump_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** ZoneHVACPackagedTerminalHeatPump is a ZoneHVACComponent that wraps the | ||
| 26 | * OpenStudio IDD object 'OS:ZoneHVAC:PackagedTerminalHeatPump'. */ | ||
| 27 | class MODEL_API ZoneHVACPackagedTerminalHeatPump : public ZoneHVACComponent | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | //@{ | ||
| 32 | |||
| 33 | ZoneHVACPackagedTerminalHeatPump(const Model& model, Schedule& availabilitySchedule, HVACComponent& supplyAirFan, HVACComponent& heatingCoil, | ||
| 34 | HVACComponent& coolingCoil, HVACComponent& supplementalHeatingCoil); | ||
| 35 | |||
| 36 | 39 | virtual ~ZoneHVACPackagedTerminalHeatPump() override = default; | |
| 37 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 38 | ✗ | ZoneHVACPackagedTerminalHeatPump(const ZoneHVACPackagedTerminalHeatPump& other) = default; | |
| 39 | 7 | ZoneHVACPackagedTerminalHeatPump(ZoneHVACPackagedTerminalHeatPump&& other) = default; | |
| 40 | ✗ | ZoneHVACPackagedTerminalHeatPump& operator=(const ZoneHVACPackagedTerminalHeatPump&) = default; | |
| 41 | ✗ | ZoneHVACPackagedTerminalHeatPump& operator=(ZoneHVACPackagedTerminalHeatPump&&) = default; | |
| 42 | |||
| 43 | //@} | ||
| 44 | |||
| 45 | static IddObjectType iddObjectType(); | ||
| 46 | |||
| 47 | static std::vector<std::string> outdoorAirMixerObjectTypeValues(); | ||
| 48 | |||
| 49 | /** \deprecated */ | ||
| 50 | static std::vector<std::string> validOutdoorAirMixerObjectTypeValues(); | ||
| 51 | |||
| 52 | static std::vector<std::string> fanPlacementValues(); | ||
| 53 | |||
| 54 | /** \deprecated */ | ||
| 55 | static std::vector<std::string> validFanPlacementValues(); | ||
| 56 | |||
| 57 | /** @name Getters */ | ||
| 58 | //@{ | ||
| 59 | |||
| 60 | Schedule availabilitySchedule() const; | ||
| 61 | |||
| 62 | std::string outdoorAirMixerObjectType() const; | ||
| 63 | |||
| 64 | std::string outdoorAirMixerName() const; | ||
| 65 | |||
| 66 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Cooling Supply Air Flow Rate" **/ | ||
| 67 | boost::optional<double> supplyAirFlowRateDuringCoolingOperation() const; | ||
| 68 | |||
| 69 | bool isSupplyAirFlowRateDuringCoolingOperationAutosized() const; | ||
| 70 | |||
| 71 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Heating Supply Air Flow Rate" **/ | ||
| 72 | boost::optional<double> supplyAirFlowRateDuringHeatingOperation() const; | ||
| 73 | |||
| 74 | bool isSupplyAirFlowRateDuringHeatingOperationAutosized() const; | ||
| 75 | |||
| 76 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "No Load Supply Air Flow Rate" **/ | ||
| 77 | boost::optional<double> supplyAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 78 | |||
| 79 | bool isSupplyAirFlowRateWhenNoCoolingorHeatingisNeededAutosized() const; | ||
| 80 | |||
| 81 | bool noLoadSupplyAirFlowRateControlSetToLowSpeed() const; | ||
| 82 | |||
| 83 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Cooling Outdoor Air Flow Rate" **/ | ||
| 84 | boost::optional<double> outdoorAirFlowRateDuringCoolingOperation() const; | ||
| 85 | |||
| 86 | bool isOutdoorAirFlowRateDuringCoolingOperationAutosized() const; | ||
| 87 | |||
| 88 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Heating Outdoor Air Flow Rate" **/ | ||
| 89 | boost::optional<double> outdoorAirFlowRateDuringHeatingOperation() const; | ||
| 90 | |||
| 91 | bool isOutdoorAirFlowRateDuringHeatingOperationAutosized() const; | ||
| 92 | |||
| 93 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "No Load Outdoor Air Flow Rate" **/ | ||
| 94 | boost::optional<double> outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 95 | |||
| 96 | bool isOutdoorAirFlowRateWhenNoCoolingorHeatingisNeededAutosized() const; | ||
| 97 | |||
| 98 | HVACComponent supplyAirFan() const; | ||
| 99 | |||
| 100 | HVACComponent heatingCoil() const; | ||
| 101 | |||
| 102 | double heatingConvergenceTolerance() const; | ||
| 103 | |||
| 104 | bool isHeatingConvergenceToleranceDefaulted() const; | ||
| 105 | |||
| 106 | /** Not used as of EnergyPlus 8.8.0 and above **/ | ||
| 107 | double minimumOutdoorDryBulbTemperatureforCompressorOperation() const; | ||
| 108 | |||
| 109 | bool isMinimumOutdoorDryBulbTemperatureforCompressorOperationDefaulted() const; | ||
| 110 | |||
| 111 | HVACComponent coolingCoil() const; | ||
| 112 | |||
| 113 | double coolingConvergenceTolerance() const; | ||
| 114 | |||
| 115 | bool isCoolingConvergenceToleranceDefaulted() const; | ||
| 116 | |||
| 117 | HVACComponent supplementalHeatingCoil() const; | ||
| 118 | |||
| 119 | boost::optional<double> maximumSupplyAirTemperaturefromSupplementalHeater() const; | ||
| 120 | |||
| 121 | bool isMaximumSupplyAirTemperaturefromSupplementalHeaterAutosized() const; | ||
| 122 | |||
| 123 | double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation() const; | ||
| 124 | |||
| 125 | bool isMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperationDefaulted() const; | ||
| 126 | |||
| 127 | std::string fanPlacement() const; | ||
| 128 | |||
| 129 | bool isFanPlacementDefaulted() const; | ||
| 130 | |||
| 131 | Schedule supplyAirFanOperatingModeSchedule() const; | ||
| 132 | |||
| 133 | double dXHeatingCoilSizingRatio() const; | ||
| 134 | |||
| 135 | //@} | ||
| 136 | /** @name Setters */ | ||
| 137 | //@{ | ||
| 138 | |||
| 139 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 140 | |||
| 141 | bool setOutdoorAirMixerObjectType(const std::string& outdoorAirMixerObjectType); | ||
| 142 | |||
| 143 | bool setOutdoorAirMixerName(const std::string& outdoorAirMixerName); | ||
| 144 | |||
| 145 | bool setSupplyAirFlowRateDuringCoolingOperation(double supplyAirFlowRateDuringCoolingOperation); | ||
| 146 | |||
| 147 | void autosizeSupplyAirFlowRateDuringCoolingOperation(); | ||
| 148 | |||
| 149 | bool setSupplyAirFlowRateDuringHeatingOperation(double supplyAirFlowRateDuringHeatingOperation); | ||
| 150 | |||
| 151 | void autosizeSupplyAirFlowRateDuringHeatingOperation(); | ||
| 152 | |||
| 153 | bool setSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(double supplyAirFlowRateWhenNoCoolingorHeatingisNeeded); | ||
| 154 | |||
| 155 | void resetSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 156 | |||
| 157 | void autosizeSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 158 | |||
| 159 | bool setNoLoadSupplyAirFlowRateControlSetToLowSpeed(bool noLoadSupplyAirFlowRateControlSetToLowSpeed); | ||
| 160 | |||
| 161 | bool setOutdoorAirFlowRateDuringCoolingOperation(double outdoorAirFlowRateDuringCoolingOperation); | ||
| 162 | |||
| 163 | void autosizeOutdoorAirFlowRateDuringCoolingOperation(); | ||
| 164 | |||
| 165 | bool setOutdoorAirFlowRateDuringHeatingOperation(double outdoorAirFlowRateDuringHeatingOperation); | ||
| 166 | |||
| 167 | void autosizeOutdoorAirFlowRateDuringHeatingOperation(); | ||
| 168 | |||
| 169 | bool setOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(double outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded); | ||
| 170 | |||
| 171 | void resetOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 172 | |||
| 173 | void autosizeOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 174 | |||
| 175 | bool setSupplyAirFan(HVACComponent& hvacComponent); | ||
| 176 | |||
| 177 | bool setHeatingCoil(HVACComponent& hvacComponent); | ||
| 178 | |||
| 179 | bool setHeatingConvergenceTolerance(double heatingConvergenceTolerance); | ||
| 180 | |||
| 181 | void resetHeatingConvergenceTolerance(); | ||
| 182 | |||
| 183 | /** Not used as of EnergyPlus 8.8.0 and above **/ | ||
| 184 | bool setMinimumOutdoorDryBulbTemperatureforCompressorOperation(double minimumOutdoorDryBulbTemperatureforCompressorOperation); | ||
| 185 | |||
| 186 | void resetMinimumOutdoorDryBulbTemperatureforCompressorOperation(); | ||
| 187 | |||
| 188 | bool setCoolingCoil(HVACComponent& hvacComponent); | ||
| 189 | |||
| 190 | bool setCoolingConvergenceTolerance(double coolingConvergenceTolerance); | ||
| 191 | |||
| 192 | void resetCoolingConvergenceTolerance(); | ||
| 193 | |||
| 194 | bool setSupplementalHeatingCoil(HVACComponent& hvacComponent); | ||
| 195 | |||
| 196 | bool setMaximumSupplyAirTemperaturefromSupplementalHeater(double maximumSupplyAirTemperaturefromSupplementalHeater); | ||
| 197 | |||
| 198 | void autosizeMaximumSupplyAirTemperaturefromSupplementalHeater(); | ||
| 199 | |||
| 200 | bool setMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation(double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation); | ||
| 201 | |||
| 202 | void resetMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation(); | ||
| 203 | |||
| 204 | bool setFanPlacement(const std::string& fanPlacement); | ||
| 205 | |||
| 206 | void resetFanPlacement(); | ||
| 207 | |||
| 208 | /** Sets the supply air fan operating mode schedule. Values of zero indicate that the fan | ||
| 209 | * cycles on and off with the active (heating or cooling) coil. Other values operate the | ||
| 210 | * fan continuously. */ | ||
| 211 | bool setSupplyAirFanOperatingModeSchedule(Schedule& schedule); | ||
| 212 | |||
| 213 | bool setDXHeatingCoilSizingRatio(double dXHeatingCoilSizingRatio); | ||
| 214 | |||
| 215 | //@} | ||
| 216 | /** @name Other */ | ||
| 217 | //@{ | ||
| 218 | |||
| 219 | boost::optional<double> autosizedSupplyAirFlowRateDuringCoolingOperation() const; | ||
| 220 | |||
| 221 | boost::optional<double> autosizedSupplyAirFlowRateDuringHeatingOperation() const; | ||
| 222 | |||
| 223 | boost::optional<double> autosizedSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 224 | |||
| 225 | boost::optional<double> autosizedOutdoorAirFlowRateDuringCoolingOperation() const; | ||
| 226 | |||
| 227 | boost::optional<double> autosizedOutdoorAirFlowRateDuringHeatingOperation() const; | ||
| 228 | |||
| 229 | boost::optional<double> autosizedOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 230 | |||
| 231 | boost::optional<double> autosizedMaximumSupplyAirTemperaturefromSupplementalHeater() const; | ||
| 232 | |||
| 233 | //@} | ||
| 234 | protected: | ||
| 235 | /// @cond | ||
| 236 | using ImplType = detail::ZoneHVACPackagedTerminalHeatPump_Impl; | ||
| 237 | |||
| 238 | explicit ZoneHVACPackagedTerminalHeatPump(std::shared_ptr<detail::ZoneHVACPackagedTerminalHeatPump_Impl> impl); | ||
| 239 | |||
| 240 | friend class detail::ZoneHVACPackagedTerminalHeatPump_Impl; | ||
| 241 | friend class Model; | ||
| 242 | friend class IdfObject; | ||
| 243 | friend class openstudio::detail::IdfObject_Impl; | ||
| 244 | |||
| 245 | /// @endcond | ||
| 246 | private: | ||
| 247 | − | REGISTER_LOGGER("openstudio.model.ZoneHVACPackagedTerminalHeatPump"); | |
| 248 | }; | ||
| 249 | |||
| 250 | /** \relates ZoneHVACPackagedTerminalHeatPump*/ | ||
| 251 | using OptionalZoneHVACPackagedTerminalHeatPump = boost::optional<ZoneHVACPackagedTerminalHeatPump>; | ||
| 252 | |||
| 253 | /** \relates ZoneHVACPackagedTerminalHeatPump*/ | ||
| 254 | using ZoneHVACPackagedTerminalHeatPumpVector = std::vector<ZoneHVACPackagedTerminalHeatPump>; | ||
| 255 | |||
| 256 | } // namespace model | ||
| 257 | } // namespace openstudio | ||
| 258 | |||
| 259 | #endif // MODEL_ZONEHVACPACKAGEDTERMINALHEATPUMP_HPP | ||
| 260 |