src/model/ZoneHVACTerminalUnitVariableRefrigerantFlow.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_ZONEHVACTERMINALUNITVARIABLEREFRIGERANTFLOW_HPP | ||
| 7 | #define MODEL_ZONEHVACTERMINALUNITVARIABLEREFRIGERANTFLOW_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ZoneHVACComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class HVACComponent; | ||
| 17 | class Schedule; | ||
| 18 | class CoilHeatingDXVariableRefrigerantFlow; | ||
| 19 | class CoilCoolingDXVariableRefrigerantFlow; | ||
| 20 | class CoilHeatingDXVariableRefrigerantFlowFluidTemperatureControl; | ||
| 21 | class CoilCoolingDXVariableRefrigerantFlowFluidTemperatureControl; | ||
| 22 | class ThermalZone; | ||
| 23 | |||
| 24 | namespace detail { | ||
| 25 | |||
| 26 | class ZoneHVACTerminalUnitVariableRefrigerantFlow_Impl; | ||
| 27 | |||
| 28 | } // namespace detail | ||
| 29 | |||
| 30 | /** ZoneHVACTerminalUnitVariableRefrigerantFlow is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:ZoneHVAC:TerminalUnit:VariableRefrigerantFlow'. */ | ||
| 31 | class MODEL_API ZoneHVACTerminalUnitVariableRefrigerantFlow : public ZoneHVACComponent | ||
| 32 | { | ||
| 33 | |||
| 34 | public: | ||
| 35 | explicit ZoneHVACTerminalUnitVariableRefrigerantFlow(const Model& model, bool isFluidTemperatureControl = false); | ||
| 36 | |||
| 37 | explicit ZoneHVACTerminalUnitVariableRefrigerantFlow(const Model& model, const CoilCoolingDXVariableRefrigerantFlow& coolingCoil, | ||
| 38 | const CoilHeatingDXVariableRefrigerantFlow& heatingCoil, const HVACComponent& fan); | ||
| 39 | |||
| 40 | explicit ZoneHVACTerminalUnitVariableRefrigerantFlow(const Model& model, | ||
| 41 | const CoilCoolingDXVariableRefrigerantFlowFluidTemperatureControl& coolingCoil, | ||
| 42 | const CoilHeatingDXVariableRefrigerantFlowFluidTemperatureControl& heatingCoil, | ||
| 43 | const HVACComponent& fan); | ||
| 44 | |||
| 45 | 710 | virtual ~ZoneHVACTerminalUnitVariableRefrigerantFlow() override = default; | |
| 46 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 47 | 158 | ZoneHVACTerminalUnitVariableRefrigerantFlow(const ZoneHVACTerminalUnitVariableRefrigerantFlow& other) = default; | |
| 48 | 279 | ZoneHVACTerminalUnitVariableRefrigerantFlow(ZoneHVACTerminalUnitVariableRefrigerantFlow&& other) = default; | |
| 49 | ✗ | ZoneHVACTerminalUnitVariableRefrigerantFlow& operator=(const ZoneHVACTerminalUnitVariableRefrigerantFlow&) = default; | |
| 50 | ✗ | ZoneHVACTerminalUnitVariableRefrigerantFlow& operator=(ZoneHVACTerminalUnitVariableRefrigerantFlow&&) = default; | |
| 51 | |||
| 52 | static IddObjectType iddObjectType(); | ||
| 53 | |||
| 54 | static std::vector<std::string> supplyAirFanPlacementValues(); | ||
| 55 | |||
| 56 | Schedule terminalUnitAvailabilityschedule() const; | ||
| 57 | |||
| 58 | bool setTerminalUnitAvailabilityschedule(Schedule& schedule); | ||
| 59 | |||
| 60 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Cooling Supply Air Flow Rate" **/ | ||
| 61 | boost::optional<double> supplyAirFlowRateDuringCoolingOperation() const; | ||
| 62 | |||
| 63 | bool isSupplyAirFlowRateDuringCoolingOperationAutosized() const; | ||
| 64 | |||
| 65 | bool setSupplyAirFlowRateDuringCoolingOperation(double supplyAirFlowRateDuringCoolingOperation); | ||
| 66 | |||
| 67 | void autosizeSupplyAirFlowRateDuringCoolingOperation(); | ||
| 68 | |||
| 69 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "No Cooling Supply Air Flow Rate" **/ | ||
| 70 | boost::optional<double> supplyAirFlowRateWhenNoCoolingisNeeded() const; | ||
| 71 | |||
| 72 | bool isSupplyAirFlowRateWhenNoCoolingisNeededAutosized() const; | ||
| 73 | |||
| 74 | bool setSupplyAirFlowRateWhenNoCoolingisNeeded(double supplyAirFlowRateWhenNoCoolingisNeeded); | ||
| 75 | |||
| 76 | void autosizeSupplyAirFlowRateWhenNoCoolingisNeeded(); | ||
| 77 | |||
| 78 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Heating Supply Air Flow Rate" **/ | ||
| 79 | boost::optional<double> supplyAirFlowRateDuringHeatingOperation() const; | ||
| 80 | |||
| 81 | bool isSupplyAirFlowRateDuringHeatingOperationAutosized() const; | ||
| 82 | |||
| 83 | bool setSupplyAirFlowRateDuringHeatingOperation(double supplyAirFlowRateDuringHeatingOperation); | ||
| 84 | |||
| 85 | void autosizeSupplyAirFlowRateDuringHeatingOperation(); | ||
| 86 | |||
| 87 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "No Heating Supply Air Flow Rate" **/ | ||
| 88 | boost::optional<double> supplyAirFlowRateWhenNoHeatingisNeeded() const; | ||
| 89 | |||
| 90 | bool isSupplyAirFlowRateWhenNoHeatingisNeededAutosized() const; | ||
| 91 | |||
| 92 | bool setSupplyAirFlowRateWhenNoHeatingisNeeded(double supplyAirFlowRateWhenNoHeatingisNeeded); | ||
| 93 | |||
| 94 | void autosizeSupplyAirFlowRateWhenNoHeatingisNeeded(); | ||
| 95 | |||
| 96 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Cooling Outdoor Air Flow Rate" **/ | ||
| 97 | boost::optional<double> outdoorAirFlowRateDuringCoolingOperation() const; | ||
| 98 | |||
| 99 | bool isOutdoorAirFlowRateDuringCoolingOperationAutosized() const; | ||
| 100 | |||
| 101 | bool setOutdoorAirFlowRateDuringCoolingOperation(double outdoorAirFlowRateDuringCoolingOperation); | ||
| 102 | |||
| 103 | void autosizeOutdoorAirFlowRateDuringCoolingOperation(); | ||
| 104 | |||
| 105 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "Heating Outdoor Air Flow Rate" **/ | ||
| 106 | boost::optional<double> outdoorAirFlowRateDuringHeatingOperation() const; | ||
| 107 | |||
| 108 | bool isOutdoorAirFlowRateDuringHeatingOperationAutosized() const; | ||
| 109 | |||
| 110 | bool setOutdoorAirFlowRateDuringHeatingOperation(double outdoorAirFlowRateDuringHeatingOperation); | ||
| 111 | |||
| 112 | void autosizeOutdoorAirFlowRateDuringHeatingOperation(); | ||
| 113 | |||
| 114 | /** In EnergyPlus 8.3.0 and above this property maps to the EnergyPlus field "No Load Outdoor Air Flow Rate" **/ | ||
| 115 | boost::optional<double> outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 116 | |||
| 117 | bool isOutdoorAirFlowRateWhenNoCoolingorHeatingisNeededAutosized() const; | ||
| 118 | |||
| 119 | bool setOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(double outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded); | ||
| 120 | |||
| 121 | void autosizeOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded(); | ||
| 122 | |||
| 123 | Schedule supplyAirFanOperatingModeSchedule() const; | ||
| 124 | |||
| 125 | bool setSupplyAirFanOperatingModeSchedule(Schedule& schedule); | ||
| 126 | |||
| 127 | // Required for zone equipment. Leave blank if terminal unit is used in AirLoopHVAC:OutdoorAirSystem:EquipmentList. | ||
| 128 | // Also leave blank if terminal unit is used on main AirloopHVAC branch and terminal unit has no fan. | ||
| 129 | // TODO: not breaking API (yet), so leaving it as non optional | ||
| 130 | HVACComponent supplyAirFan() const; // TODO: OS_DEPRECATED | ||
| 131 | // bool setSupplyAirFan(const HVACComponent& fan); | ||
| 132 | // void resetSupplyAirFan(); | ||
| 133 | |||
| 134 | boost::optional<HVACComponent> coolingCoil() const; | ||
| 135 | |||
| 136 | // Using a single type of coils is enforced: both must be FluidTemperatureControl or Non-FluidCtrl | ||
| 137 | bool setCoolingCoil(const HVACComponent& coil); | ||
| 138 | |||
| 139 | boost::optional<HVACComponent> heatingCoil() const; | ||
| 140 | |||
| 141 | // Using a single type of coils is enforced: both must be FluidTemperatureControl or Non-FluidCtrl | ||
| 142 | bool setHeatingCoil(const HVACComponent& coil); | ||
| 143 | |||
| 144 | double zoneTerminalUnitOnParasiticElectricEnergyUse() const; | ||
| 145 | |||
| 146 | bool setZoneTerminalUnitOnParasiticElectricEnergyUse(double zoneTerminalUnitOnParasiticElectricEnergyUse); | ||
| 147 | |||
| 148 | double zoneTerminalUnitOffParasiticElectricEnergyUse() const; | ||
| 149 | |||
| 150 | bool setZoneTerminalUnitOffParasiticElectricEnergyUse(double zoneTerminalUnitOffParasiticElectricEnergyUse); | ||
| 151 | |||
| 152 | double ratedTotalHeatingCapacitySizingRatio() const; | ||
| 153 | |||
| 154 | bool setRatedTotalHeatingCapacitySizingRatio(double ratedTotalHeatingCapacitySizingRatio); | ||
| 155 | |||
| 156 | // \field Availability Manager List Name | ||
| 157 | // \field Design Specification ZoneHVAC Sizing Object Name | ||
| 158 | |||
| 159 | // Supplemental Heating Coil Name | ||
| 160 | boost::optional<HVACComponent> supplementalHeatingCoil() const; | ||
| 161 | bool setSupplementalHeatingCoil(const HVACComponent& coil); | ||
| 162 | void resetSupplementalHeatingCoil(); | ||
| 163 | |||
| 164 | // Maximum Supply Air Temperature from Supplemental Heater (autosized) | ||
| 165 | boost::optional<double> maximumSupplyAirTemperaturefromSupplementalHeater() const; | ||
| 166 | bool isMaximumSupplyAirTemperaturefromSupplementalHeaterAutosized() const; | ||
| 167 | bool setMaximumSupplyAirTemperaturefromSupplementalHeater(double maximumSupplyAirTemperaturefromSupplementalHeater); | ||
| 168 | void autosizeMaximumSupplyAirTemperaturefromSupplementalHeater(); | ||
| 169 | |||
| 170 | // Maximum Outdoor Dry-Bulb Temperature for Supplemental Heater Operation (default 21C) | ||
| 171 | double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation() const; | ||
| 172 | bool setMaximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation(double maximumOutdoorDryBulbTemperatureforSupplementalHeaterOperation); | ||
| 173 | |||
| 174 | // Supply Air Fan Placement | ||
| 175 | std::string supplyAirFanPlacement() const; | ||
| 176 | bool setSupplyAirFanPlacement(const std::string& supplyAirFanPlacement); | ||
| 177 | |||
| 178 | // Controlling Zone or Thermostat Location | ||
| 179 | boost::optional<ThermalZone> controllingZoneorThermostatLocation() const; | ||
| 180 | bool setControllingZoneorThermostatLocation(const ThermalZone& thermalZone); | ||
| 181 | void resetControllingZoneorThermostatLocation(); | ||
| 182 | |||
| 183 | boost::optional<double> autosizedSupplyAirFlowRateDuringCoolingOperation() const; | ||
| 184 | |||
| 185 | boost::optional<double> autosizedSupplyAirFlowRateWhenNoCoolingisNeeded() const; | ||
| 186 | |||
| 187 | boost::optional<double> autosizedSupplyAirFlowRateDuringHeatingOperation() const; | ||
| 188 | |||
| 189 | boost::optional<double> autosizedSupplyAirFlowRateWhenNoHeatingisNeeded() const; | ||
| 190 | |||
| 191 | boost::optional<double> autosizedOutdoorAirFlowRateDuringCoolingOperation() const; | ||
| 192 | |||
| 193 | boost::optional<double> autosizedOutdoorAirFlowRateDuringHeatingOperation() const; | ||
| 194 | |||
| 195 | boost::optional<double> autosizedOutdoorAirFlowRateWhenNoCoolingorHeatingisNeeded() const; | ||
| 196 | |||
| 197 | boost::optional<double> autosizedMaximumSupplyAirTemperaturefromSupplementalHeater() const; | ||
| 198 | |||
| 199 | //@} | ||
| 200 | /** @name Other */ | ||
| 201 | //@{ | ||
| 202 | |||
| 203 | // Returns true if the Cooling and Heating Coils are of the FluidTemperatureControl type | ||
| 204 | bool isFluidTemperatureControl() const; | ||
| 205 | |||
| 206 | /** Convenience function to return parent VRF System: | ||
| 207 | * - AirConditionerVariableRefrigerantFlow | ||
| 208 | * - AirConditionerVariableRefrigerantFlowFluidTemperatureControl | ||
| 209 | * - AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR */ | ||
| 210 | boost::optional<HVACComponent> vrfSystem() const; | ||
| 211 | |||
| 212 | protected: | ||
| 213 | /// @cond | ||
| 214 | using ImplType = detail::ZoneHVACTerminalUnitVariableRefrigerantFlow_Impl; | ||
| 215 | |||
| 216 | explicit ZoneHVACTerminalUnitVariableRefrigerantFlow(std::shared_ptr<detail::ZoneHVACTerminalUnitVariableRefrigerantFlow_Impl> impl); | ||
| 217 | |||
| 218 | friend class detail::ZoneHVACTerminalUnitVariableRefrigerantFlow_Impl; | ||
| 219 | friend class Model; | ||
| 220 | friend class IdfObject; | ||
| 221 | friend class openstudio::detail::IdfObject_Impl; | ||
| 222 | |||
| 223 | /// @endcond | ||
| 224 | |||
| 225 | private: | ||
| 226 | − | REGISTER_LOGGER("openstudio.model.ZoneHVACTerminalUnitVariableRefrigerantFlow"); | |
| 227 | }; | ||
| 228 | |||
| 229 | /** \relates ZoneHVACTerminalUnitVariableRefrigerantFlow*/ | ||
| 230 | using OptionalZoneHVACTerminalUnitVariableRefrigerantFlow = boost::optional<ZoneHVACTerminalUnitVariableRefrigerantFlow>; | ||
| 231 | |||
| 232 | /** \relates ZoneHVACTerminalUnitVariableRefrigerantFlow*/ | ||
| 233 | using ZoneHVACTerminalUnitVariableRefrigerantFlowVector = std::vector<ZoneHVACTerminalUnitVariableRefrigerantFlow>; | ||
| 234 | |||
| 235 | } // namespace model | ||
| 236 | } // namespace openstudio | ||
| 237 | |||
| 238 | #endif // MODEL_ZONEHVACTERMINALUNITVARIABLEREFRIGERANTFLOW_HPP | ||
| 239 |