src/model/AirLoopHVACUnitaryHeatPumpAirToAir.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_AIRLOOPHVACUNITARYHEATPUMPAIRTOAIR_HPP | ||
| 7 | #define MODEL_AIRLOOPHVACUNITARYHEATPUMPAIRTOAIR_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | |||
| 18 | class ThermalZone; | ||
| 19 | |||
| 20 | class HVACComponent; | ||
| 21 | |||
| 22 | namespace detail { | ||
| 23 | |||
| 24 | class AirLoopHVACUnitaryHeatPumpAirToAir_Impl; | ||
| 25 | |||
| 26 | } // namespace detail | ||
| 27 | |||
| 28 | /** AirLoopHVACUnitaryHeatPumpAirToAir is a StraightComponent that wraps the | ||
| 29 | * OpenStudio IDD object 'OS:AirLoopHVAC:UnitaryHeatPump:AirToAir'. */ | ||
| 30 | class MODEL_API AirLoopHVACUnitaryHeatPumpAirToAir : public StraightComponent | ||
| 31 | { | ||
| 32 | public: | ||
| 33 | /** @name Constructors and Destructors */ | ||
| 34 | //@{ | ||
| 35 | |||
| 36 | AirLoopHVACUnitaryHeatPumpAirToAir(const Model& model, Schedule& availabilitySchedule, HVACComponent& supplyFan, HVACComponent& heatingCoil, | ||
| 37 | HVACComponent& coolingCoil, HVACComponent& supplementalHeatingCoil); | ||
| 38 | |||
| 39 | 32 | virtual ~AirLoopHVACUnitaryHeatPumpAirToAir() override = default; | |
| 40 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 41 | ✗ | AirLoopHVACUnitaryHeatPumpAirToAir(const AirLoopHVACUnitaryHeatPumpAirToAir& other) = default; | |
| 42 | 8 | AirLoopHVACUnitaryHeatPumpAirToAir(AirLoopHVACUnitaryHeatPumpAirToAir&& other) = default; | |
| 43 | ✗ | AirLoopHVACUnitaryHeatPumpAirToAir& operator=(const AirLoopHVACUnitaryHeatPumpAirToAir&) = default; | |
| 44 | ✗ | AirLoopHVACUnitaryHeatPumpAirToAir& operator=(AirLoopHVACUnitaryHeatPumpAirToAir&&) = default; | |
| 45 | |||
| 46 | //@} | ||
| 47 | |||
| 48 | static IddObjectType iddObjectType(); | ||
| 49 | |||
| 50 | static std::vector<std::string> validFanPlacementValues(); | ||
| 51 | |||
| 52 | static std::vector<std::string> validDehumidificationControlTypeValues(); | ||
| 53 | |||
| 54 | /** @name Getters */ | ||
| 55 | //@{ | ||
| 56 | |||
| 57 | Schedule availabilitySchedule() const; | ||
| 58 | |||
| 59 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Cooling Supply Air Flow Rate" **/ | ||
| 60 | boost::optional<double> supplyAirFlowRateDuringCoolingOperation() const; | ||
| 61 | |||
| 62 | bool isSupplyAirFlowRateDuringCoolingOperationAutosized() const; | ||
| 63 | |||
| 64 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Heating Supply Air Flow Rate" **/ | ||
| 65 | boost::optional<double> supplyAirFlowRateDuringHeatingOperation() const; | ||
| 66 | |||
| 67 | bool isSupplyAirFlowRateDuringHeatingOperationAutosized() const; | ||
| 68 | |||
| 69 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "No Load Supply Air Flow Rate" **/ | ||
| 70 | boost::optional<double> supplyAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 71 | |||
| 72 | bool isSupplyAirFlowRateWhenNoCoolingorHeatingisNeededAutosized() const; | ||
| 73 | |||
| 74 | boost::optional<ThermalZone> controllingZone() const; | ||
| 75 | |||
| 76 | HVACComponent supplyAirFan() const; | ||
| 77 | |||
| 78 | HVACComponent heatingCoil() const; | ||
| 79 | |||
| 80 | HVACComponent coolingCoil() const; | ||
| 81 | |||
| 82 | HVACComponent supplementalHeatingCoil() const; | ||
| 83 | |||
| 84 | boost::optional<double> maximumSupplyAirTemperaturefromSupplementalHeater() const; | ||
| 85 | |||
| 86 | bool isMaximumSupplyAirTemperaturefromSupplementalHeaterAutosized() const; | ||
| 87 | |||
| 88 | double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation() const; | ||
| 89 | |||
| 90 | bool isMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperationDefaulted() const; | ||
| 91 | |||
| 92 | std::string fanPlacement() const; | ||
| 93 | |||
| 94 | bool isFanPlacementDefaulted() const; | ||
| 95 | |||
| 96 | /** Returns the supply air fan operating mode schedule, if present. In this schedule, values | ||
| 97 | * of zero correspond to AUTO fan operation (fan cycles on and off with coils to meet load). | ||
| 98 | * Other values indicate that the supply fan is to run continuously. */ | ||
| 99 | boost::optional<Schedule> supplyAirFanOperatingModeSchedule() const; | ||
| 100 | |||
| 101 | std::string dehumidificationControlType() const; | ||
| 102 | |||
| 103 | bool isDehumidificationControlTypeDefaulted() const; | ||
| 104 | |||
| 105 | double dXHeatingCoilSizingRatio() const; | ||
| 106 | |||
| 107 | //@} | ||
| 108 | /** @name Setters */ | ||
| 109 | //@{ | ||
| 110 | |||
| 111 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 112 | |||
| 113 | bool setSupplyAirFlowRateDuringCoolingOperation(double supplyAirFlowRateDuringCoolingOperation); | ||
| 114 | |||
| 115 | void autosizeSupplyAirFlowRateDuringCoolingOperation(); | ||
| 116 | |||
| 117 | bool setSupplyAirFlowRateDuringHeatingOperation(double n2); | ||
| 118 | |||
| 119 | void autosizeSupplyAirFlowRateDuringHeatingOperation(); | ||
| 120 | |||
| 121 | bool setSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(double supplyAirFlowRateWhenNoCoolingorHeatingisNeeded); | ||
| 122 | |||
| 123 | void resetSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 124 | |||
| 125 | void autosizeSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 126 | |||
| 127 | bool setControllingZone(ThermalZone& zone); | ||
| 128 | |||
| 129 | void resetControllingZone(); | ||
| 130 | |||
| 131 | bool setSupplyAirFan(HVACComponent& hvacComponent); | ||
| 132 | |||
| 133 | bool setHeatingCoil(HVACComponent& hvacComponent); | ||
| 134 | |||
| 135 | bool setCoolingCoil(HVACComponent& hvacComponent); | ||
| 136 | |||
| 137 | bool setSupplementalHeatingCoil(HVACComponent& hvacComponent); | ||
| 138 | |||
| 139 | bool setMaximumSupplyAirTemperaturefromSupplementalHeater(double maximumSupplyAirTemperaturefromSupplementalHeater); | ||
| 140 | |||
| 141 | void autosizeMaximumSupplyAirTemperaturefromSupplementalHeater(); | ||
| 142 | |||
| 143 | bool setMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation(double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation); | ||
| 144 | |||
| 145 | void resetMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation(); | ||
| 146 | |||
| 147 | bool setFanPlacement(const std::string& fanPlacement); | ||
| 148 | |||
| 149 | void resetFanPlacement(); | ||
| 150 | |||
| 151 | bool setSupplyAirFanOperatingModeSchedule(Schedule& schedule); | ||
| 152 | |||
| 153 | void resetSupplyAirFanOperatingModeSchedule(); | ||
| 154 | |||
| 155 | bool setDehumidificationControlType(const std::string& dehumidificationControlType); | ||
| 156 | |||
| 157 | void resetDehumidificationControlType(); | ||
| 158 | |||
| 159 | bool setDXHeatingCoilSizingRatio(double dXHeatingCoilSizingRatio); | ||
| 160 | |||
| 161 | //@} | ||
| 162 | /** @name Other */ | ||
| 163 | //@{ | ||
| 164 | |||
| 165 | boost::optional<double> autosizedSupplyAirFlowRateDuringCoolingOperation() const; | ||
| 166 | |||
| 167 | boost::optional<double> autosizedSupplyAirFlowRateDuringHeatingOperation() const; | ||
| 168 | |||
| 169 | boost::optional<double> autosizedSupplyAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 170 | |||
| 171 | boost::optional<double> autosizedMaximumSupplyAirTemperaturefromSupplementalHeater() const; | ||
| 172 | |||
| 173 | //@} | ||
| 174 | protected: | ||
| 175 | /// @cond | ||
| 176 | |||
| 177 | using ImplType = detail::AirLoopHVACUnitaryHeatPumpAirToAir_Impl; | ||
| 178 | |||
| 179 | explicit AirLoopHVACUnitaryHeatPumpAirToAir(std::shared_ptr<detail::AirLoopHVACUnitaryHeatPumpAirToAir_Impl> impl); | ||
| 180 | |||
| 181 | friend class detail::AirLoopHVACUnitaryHeatPumpAirToAir_Impl; | ||
| 182 | friend class Model; | ||
| 183 | friend class IdfObject; | ||
| 184 | friend class openstudio::detail::IdfObject_Impl; | ||
| 185 | |||
| 186 | /// @endcond | ||
| 187 | private: | ||
| 188 | − | REGISTER_LOGGER("openstudio.model.AirLoopHVACUnitaryHeatPumpAirToAir"); | |
| 189 | }; | ||
| 190 | |||
| 191 | /** \relates AirLoopHVACUnitaryHeatPumpAirToAir*/ | ||
| 192 | using OptionalAirLoopHVACUnitaryHeatPumpAirToAir = boost::optional<AirLoopHVACUnitaryHeatPumpAirToAir>; | ||
| 193 | |||
| 194 | /** \relates AirLoopHVACUnitaryHeatPumpAirToAir*/ | ||
| 195 | using AirLoopHVACUnitaryHeatPumpAirToAirVector = std::vector<AirLoopHVACUnitaryHeatPumpAirToAir>; | ||
| 196 | |||
| 197 | } // namespace model | ||
| 198 | } // namespace openstudio | ||
| 199 | |||
| 200 | #endif // MODEL_AIRLOOPHVACUNITARYHEATPUMPAIRTOAIR_HPP | ||
| 201 |