src/model/AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed.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_AIRLOOPHVACUNITARYHEATPUMPAIRTOAIRMULTISPEED_HPP | ||
| 7 | #define MODEL_AIRLOOPHVACUNITARYHEATPUMPAIRTOAIRMULTISPEED_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent.hpp" | ||
| 11 | #include "../utilities/core/Deprecated.hpp" | ||
| 12 | |||
| 13 | namespace openstudio { | ||
| 14 | |||
| 15 | namespace model { | ||
| 16 | |||
| 17 | class Schedule; | ||
| 18 | class ThermalZone; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | class AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed_Impl; | ||
| 23 | |||
| 24 | } // namespace detail | ||
| 25 | |||
| 26 | /** AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed is a StraightComponent that wraps the OpenStudio IDD object 'OS:AirLoopHVAC:UnitaryHeatPump:AirToAir:MultiSpeed'. */ | ||
| 27 | class MODEL_API AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed : public StraightComponent | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | //@{ | ||
| 32 | |||
| 33 | explicit AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed(const Model& model, const HVACComponent& fan, const HVACComponent& heatingCoil, | ||
| 34 | const HVACComponent& coolingCoil, const HVACComponent& supplementalHeatingCoil); | ||
| 35 | |||
| 36 | 13 | virtual ~AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed() override = default; | |
| 37 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 38 | ✗ | AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed(const AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed& other) = default; | |
| 39 | ✗ | AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed(AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed&& other) = default; | |
| 40 | ✗ | AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed& operator=(const AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed&) = default; | |
| 41 | ✗ | AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed& operator=(AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed&&) = default; | |
| 42 | |||
| 43 | //@} | ||
| 44 | |||
| 45 | static IddObjectType iddObjectType(); | ||
| 46 | |||
| 47 | static std::vector<std::string> supplyAirFanPlacementValues(); | ||
| 48 | |||
| 49 | /** @name Getters */ | ||
| 50 | //@{ | ||
| 51 | |||
| 52 | boost::optional<Schedule> availabilitySchedule() const; | ||
| 53 | |||
| 54 | boost::optional<ThermalZone> controllingZoneorThermostatLocation() const; | ||
| 55 | |||
| 56 | HVACComponent supplyAirFan() const; | ||
| 57 | |||
| 58 | std::string supplyAirFanPlacement() const; | ||
| 59 | |||
| 60 | Schedule supplyAirFanOperatingModeSchedule() const; | ||
| 61 | |||
| 62 | HVACComponent heatingCoil() const; | ||
| 63 | |||
| 64 | OS_DEPRECATED(3, 11, 0) double minimumOutdoorDryBulbTemperatureforCompressorOperation() const; | ||
| 65 | |||
| 66 | double dXHeatingCoilSizingRatio() const; | ||
| 67 | |||
| 68 | HVACComponent coolingCoil() const; | ||
| 69 | |||
| 70 | HVACComponent supplementalHeatingCoil() const; | ||
| 71 | |||
| 72 | boost::optional<double> maximumSupplyAirTemperaturefromSupplementalHeater() const; | ||
| 73 | |||
| 74 | bool isMaximumSupplyAirTemperaturefromSupplementalHeaterAutosized() const; | ||
| 75 | |||
| 76 | double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation() const; | ||
| 77 | |||
| 78 | double auxiliaryOnCycleElectricPower() const; | ||
| 79 | |||
| 80 | double auxiliaryOffCycleElectricPower() const; | ||
| 81 | |||
| 82 | double designHeatRecoveryWaterFlowRate() const; | ||
| 83 | |||
| 84 | double maximumTemperatureforHeatRecovery() const; | ||
| 85 | |||
| 86 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "No Load Supply Air Flow Rate" **/ | ||
| 87 | boost::optional<double> supplyAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 88 | |||
| 89 | bool isSupplyAirFlowRateWhenNoCoolingorHeatingisNeededAutosized() const; | ||
| 90 | |||
| 91 | int numberofSpeedsforHeating() const; | ||
| 92 | |||
| 93 | int numberofSpeedsforCooling() const; | ||
| 94 | |||
| 95 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Heating Speed 1 Supply Air Flow Rate" **/ | ||
| 96 | boost::optional<double> speed1SupplyAirFlowRateDuringHeatingOperation() const; | ||
| 97 | |||
| 98 | bool isSpeed1SupplyAirFlowRateDuringHeatingOperationAutosized() const; | ||
| 99 | |||
| 100 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Heating Speed 2 Supply Air Flow Rate" **/ | ||
| 101 | boost::optional<double> speed2SupplyAirFlowRateDuringHeatingOperation() const; | ||
| 102 | |||
| 103 | bool isSpeed2SupplyAirFlowRateDuringHeatingOperationAutosized() const; | ||
| 104 | |||
| 105 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Heating Speed 3 Supply Air Flow Rate" **/ | ||
| 106 | boost::optional<double> speed3SupplyAirFlowRateDuringHeatingOperation() const; | ||
| 107 | |||
| 108 | bool isSpeed3SupplyAirFlowRateDuringHeatingOperationAutosized() const; | ||
| 109 | |||
| 110 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Heating Speed 4 Supply Air Flow Rate" **/ | ||
| 111 | boost::optional<double> speed4SupplyAirFlowRateDuringHeatingOperation() const; | ||
| 112 | |||
| 113 | bool isSpeed4SupplyAirFlowRateDuringHeatingOperationAutosized() const; | ||
| 114 | |||
| 115 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Cooling Speed 1 Supply Air Flow Rate" **/ | ||
| 116 | boost::optional<double> speed1SupplyAirFlowRateDuringCoolingOperation() const; | ||
| 117 | |||
| 118 | bool isSpeed1SupplyAirFlowRateDuringCoolingOperationAutosized() const; | ||
| 119 | |||
| 120 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Cooling Speed 2 Supply Air Flow Rate" **/ | ||
| 121 | boost::optional<double> speed2SupplyAirFlowRateDuringCoolingOperation() const; | ||
| 122 | |||
| 123 | bool isSpeed2SupplyAirFlowRateDuringCoolingOperationAutosized() const; | ||
| 124 | |||
| 125 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Cooling Speed 3 Supply Air Flow Rate" **/ | ||
| 126 | boost::optional<double> speed3SupplyAirFlowRateDuringCoolingOperation() const; | ||
| 127 | |||
| 128 | bool isSpeed3SupplyAirFlowRateDuringCoolingOperationAutosized() const; | ||
| 129 | |||
| 130 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Cooling Speed 4 Supply Air Flow Rate" **/ | ||
| 131 | boost::optional<double> speed4SupplyAirFlowRateDuringCoolingOperation() const; | ||
| 132 | |||
| 133 | bool isSpeed4SupplyAirFlowRateDuringCoolingOperationAutosized() const; | ||
| 134 | |||
| 135 | //@} | ||
| 136 | /** @name Setters */ | ||
| 137 | //@{ | ||
| 138 | |||
| 139 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 140 | |||
| 141 | void resetAvailabilitySchedule(); | ||
| 142 | |||
| 143 | bool setControllingZoneorThermostatLocation(const ThermalZone& thermalZone); | ||
| 144 | |||
| 145 | void resetControllingZoneorThermostatLocation(); | ||
| 146 | |||
| 147 | bool setSupplyAirFan(const HVACComponent& fan); | ||
| 148 | |||
| 149 | bool setSupplyAirFanPlacement(const std::string& supplyAirFanPlacement); | ||
| 150 | |||
| 151 | bool setSupplyAirFanOperatingModeSchedule(Schedule& schedule); | ||
| 152 | |||
| 153 | bool setHeatingCoil(const HVACComponent& coil); | ||
| 154 | |||
| 155 | OS_DEPRECATED(3, 11, 0) | ||
| 156 | bool setMinimumOutdoorDryBulbTemperatureforCompressorOperation(double minimumOutdoorDryBulbTemperatureforCompressorOperation); | ||
| 157 | |||
| 158 | bool setDXHeatingCoilSizingRatio(double dXHeatingCoilSizingRatio); | ||
| 159 | |||
| 160 | bool setCoolingCoil(const HVACComponent& coil); | ||
| 161 | |||
| 162 | bool setSupplementalHeatingCoil(const HVACComponent& coil); | ||
| 163 | |||
| 164 | bool setMaximumSupplyAirTemperaturefromSupplementalHeater(double maximumSupplyAirTemperaturefromSupplementalHeater); | ||
| 165 | |||
| 166 | void autosizeMaximumSupplyAirTemperaturefromSupplementalHeater(); | ||
| 167 | |||
| 168 | bool setMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation(double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation); | ||
| 169 | |||
| 170 | bool setAuxiliaryOnCycleElectricPower(double auxiliaryOnCycleElectricPower); | ||
| 171 | |||
| 172 | bool setAuxiliaryOffCycleElectricPower(double auxiliaryOffCycleElectricPower); | ||
| 173 | |||
| 174 | bool setDesignHeatRecoveryWaterFlowRate(double designHeatRecoveryWaterFlowRate); | ||
| 175 | |||
| 176 | bool setMaximumTemperatureforHeatRecovery(double maximumTemperatureforHeatRecovery); | ||
| 177 | |||
| 178 | bool setSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(double supplyAirFlowRateWhenNoCoolingorHeatingisNeeded); | ||
| 179 | |||
| 180 | void autosizeSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 181 | |||
| 182 | bool setNumberofSpeedsforHeating(int numberofSpeedsforHeating); | ||
| 183 | |||
| 184 | bool setNumberofSpeedsforCooling(int numberofSpeedsforCooling); | ||
| 185 | |||
| 186 | bool setSpeed1SupplyAirFlowRateDuringHeatingOperation(double speed1SupplyAirFlowRateDuringHeatingOperation); | ||
| 187 | |||
| 188 | void autosizeSpeed1SupplyAirFlowRateDuringHeatingOperation(); | ||
| 189 | |||
| 190 | bool setSpeed2SupplyAirFlowRateDuringHeatingOperation(double speed2SupplyAirFlowRateDuringHeatingOperation); | ||
| 191 | |||
| 192 | void autosizeSpeed2SupplyAirFlowRateDuringHeatingOperation(); | ||
| 193 | |||
| 194 | bool setSpeed3SupplyAirFlowRateDuringHeatingOperation(double speed3SupplyAirFlowRateDuringHeatingOperation); | ||
| 195 | |||
| 196 | void autosizeSpeed3SupplyAirFlowRateDuringHeatingOperation(); | ||
| 197 | |||
| 198 | bool setSpeed4SupplyAirFlowRateDuringHeatingOperation(double speed4SupplyAirFlowRateDuringHeatingOperation); | ||
| 199 | |||
| 200 | void autosizeSpeed4SupplyAirFlowRateDuringHeatingOperation(); | ||
| 201 | |||
| 202 | bool setSpeed1SupplyAirFlowRateDuringCoolingOperation(double speed1SupplyAirFlowRateDuringCoolingOperation); | ||
| 203 | |||
| 204 | void autosizeSpeed1SupplyAirFlowRateDuringCoolingOperation(); | ||
| 205 | |||
| 206 | bool setSpeed2SupplyAirFlowRateDuringCoolingOperation(double speed2SupplyAirFlowRateDuringCoolingOperation); | ||
| 207 | |||
| 208 | void autosizeSpeed2SupplyAirFlowRateDuringCoolingOperation(); | ||
| 209 | |||
| 210 | bool setSpeed3SupplyAirFlowRateDuringCoolingOperation(double speed3SupplyAirFlowRateDuringCoolingOperation); | ||
| 211 | |||
| 212 | void autosizeSpeed3SupplyAirFlowRateDuringCoolingOperation(); | ||
| 213 | |||
| 214 | bool setSpeed4SupplyAirFlowRateDuringCoolingOperation(double speed4SupplyAirFlowRateDuringCoolingOperation); | ||
| 215 | |||
| 216 | void autosizeSpeed4SupplyAirFlowRateDuringCoolingOperation(); | ||
| 217 | |||
| 218 | //@} | ||
| 219 | /** @name Other */ | ||
| 220 | //@{ | ||
| 221 | |||
| 222 | boost::optional<double> autosizedMaximumSupplyAirTemperaturefromSupplementalHeater() const; | ||
| 223 | |||
| 224 | boost::optional<double> autosizedSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 225 | |||
| 226 | boost::optional<double> autosizedSpeed1SupplyAirFlowRateDuringHeatingOperation() const; | ||
| 227 | |||
| 228 | boost::optional<double> autosizedSpeed2SupplyAirFlowRateDuringHeatingOperation() const; | ||
| 229 | |||
| 230 | boost::optional<double> autosizedSpeed3SupplyAirFlowRateDuringHeatingOperation() const; | ||
| 231 | |||
| 232 | boost::optional<double> autosizedSpeed4SupplyAirFlowRateDuringHeatingOperation() const; | ||
| 233 | |||
| 234 | boost::optional<double> autosizedSpeed1SupplyAirFlowRateDuringCoolingOperation() const; | ||
| 235 | |||
| 236 | boost::optional<double> autosizedSpeed2SupplyAirFlowRateDuringCoolingOperation() const; | ||
| 237 | |||
| 238 | boost::optional<double> autosizedSpeed3SupplyAirFlowRateDuringCoolingOperation() const; | ||
| 239 | |||
| 240 | boost::optional<double> autosizedSpeed4SupplyAirFlowRateDuringCoolingOperation() const; | ||
| 241 | |||
| 242 | //@} | ||
| 243 | protected: | ||
| 244 | /// @cond | ||
| 245 | using ImplType = detail::AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed_Impl; | ||
| 246 | |||
| 247 | explicit AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed(std::shared_ptr<detail::AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed_Impl> impl); | ||
| 248 | |||
| 249 | friend class detail::AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed_Impl; | ||
| 250 | friend class Model; | ||
| 251 | friend class IdfObject; | ||
| 252 | friend class openstudio::detail::IdfObject_Impl; | ||
| 253 | /// @endcond | ||
| 254 | private: | ||
| 255 | − | REGISTER_LOGGER("openstudio.model.AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed"); | |
| 256 | }; | ||
| 257 | |||
| 258 | /** \relates AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed*/ | ||
| 259 | using OptionalAirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed = boost::optional<AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed>; | ||
| 260 | |||
| 261 | /** \relates AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed*/ | ||
| 262 | using AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeedVector = std::vector<AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed>; | ||
| 263 | |||
| 264 | } // namespace model | ||
| 265 | } // namespace openstudio | ||
| 266 | |||
| 267 | #endif // MODEL_AIRLOOPHVACUNITARYHEATPUMPAIRTOAIRMULTISPEED_HPP | ||
| 268 |