src/model/AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR.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_AIRCONDITIONERVARIABLEREFRIGERANTFLOWFLUIDTEMPERATURECONTROLHR_HPP | ||
| 7 | #define MODEL_AIRCONDITIONERVARIABLEREFRIGERANTFLOWFLUIDTEMPERATURECONTROLHR_HPP | ||
| 8 | |||
| 9 | #include <vector> | ||
| 10 | #include <model/ModelAPI.hpp> | ||
| 11 | #include "HVACComponent.hpp" | ||
| 12 | |||
| 13 | namespace openstudio { | ||
| 14 | |||
| 15 | namespace model { | ||
| 16 | |||
| 17 | class Schedule; | ||
| 18 | class Curve; | ||
| 19 | class ThermalZone; | ||
| 20 | class ZoneHVACTerminalUnitVariableRefrigerantFlow; | ||
| 21 | class LoadingIndex; | ||
| 22 | |||
| 23 | namespace detail { | ||
| 24 | |||
| 25 | class AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR_Impl; | ||
| 26 | |||
| 27 | } // namespace detail | ||
| 28 | |||
| 29 | /** AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR is a HVACComponent that wraps the OpenStudio IDD object 'OS:AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR'. */ | ||
| 30 | class MODEL_API AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR : public HVACComponent | ||
| 31 | { | ||
| 32 | public: | ||
| 33 | /** @name Constructors and Destructors */ | ||
| 34 | //@{ | ||
| 35 | |||
| 36 | explicit AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR(const Model& model); | ||
| 37 | |||
| 38 | 71 | virtual ~AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR() override = default; | |
| 39 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 40 | ✗ | AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR(const AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR& other) = | |
| 41 | default; | ||
| 42 | 27 | AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR(AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR&& other) = default; | |
| 43 | AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR& | ||
| 44 | ✗ | operator=(const AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR&) = default; | |
| 45 | AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR& | ||
| 46 | ✗ | operator=(AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR&&) = default; | |
| 47 | |||
| 48 | //@} | ||
| 49 | |||
| 50 | static IddObjectType iddObjectType(); | ||
| 51 | |||
| 52 | static std::vector<std::string> refrigerantTypeValues(); | ||
| 53 | static std::vector<std::string> validRefrigerantTypeValues(); | ||
| 54 | |||
| 55 | static std::vector<std::string> refrigerantTemperatureControlAlgorithmforIndoorUnitValues(); | ||
| 56 | static std::vector<std::string> validRefrigerantTemperatureControlAlgorithmforIndoorUnitValues(); | ||
| 57 | |||
| 58 | static std::vector<std::string> defrostStrategyValues(); | ||
| 59 | static std::vector<std::string> validDefrostStrategyValues(); | ||
| 60 | |||
| 61 | static std::vector<std::string> defrostControlValues(); | ||
| 62 | static std::vector<std::string> validDefrostControlValues(); | ||
| 63 | |||
| 64 | /** @name Getters */ | ||
| 65 | //@{ | ||
| 66 | |||
| 67 | Schedule availabilitySchedule() const; | ||
| 68 | |||
| 69 | std::string refrigerantType() const; | ||
| 70 | |||
| 71 | boost::optional<double> ratedEvaporativeCapacity() const; | ||
| 72 | |||
| 73 | bool isRatedEvaporativeCapacityAutosized() const; | ||
| 74 | |||
| 75 | double ratedCompressorPowerPerUnitofRatedEvaporativeCapacity() const; | ||
| 76 | |||
| 77 | double minimumOutdoorAirTemperatureinCoolingOnlyMode() const; | ||
| 78 | |||
| 79 | double maximumOutdoorAirTemperatureinCoolingOnlyMode() const; | ||
| 80 | |||
| 81 | double minimumOutdoorAirTemperatureinHeatingOnlyMode() const; | ||
| 82 | |||
| 83 | double maximumOutdoorAirTemperatureinHeatingOnlyMode() const; | ||
| 84 | |||
| 85 | double minimumOutdoorTemperatureinHeatRecoveryMode() const; | ||
| 86 | |||
| 87 | double maximumOutdoorTemperatureinHeatRecoveryMode() const; | ||
| 88 | |||
| 89 | std::string refrigerantTemperatureControlAlgorithmforIndoorUnit() const; | ||
| 90 | |||
| 91 | double referenceEvaporatingTemperatureforIndoorUnit() const; | ||
| 92 | |||
| 93 | double referenceCondensingTemperatureforIndoorUnit() const; | ||
| 94 | |||
| 95 | double variableEvaporatingTemperatureMinimumforIndoorUnit() const; | ||
| 96 | |||
| 97 | double variableEvaporatingTemperatureMaximumforIndoorUnit() const; | ||
| 98 | |||
| 99 | double variableCondensingTemperatureMinimumforIndoorUnit() const; | ||
| 100 | |||
| 101 | double variableCondensingTemperatureMaximumforIndoorUnit() const; | ||
| 102 | |||
| 103 | double outdoorUnitEvaporatorReferenceSuperheating() const; | ||
| 104 | |||
| 105 | double outdoorUnitCondenserReferenceSubcooling() const; | ||
| 106 | |||
| 107 | double outdoorUnitEvaporatorRatedBypassFactor() const; | ||
| 108 | |||
| 109 | double outdoorUnitCondenserRatedBypassFactor() const; | ||
| 110 | |||
| 111 | double differencebetweenOutdoorUnitEvaporatingTemperatureandOutdoorAirTemperatureinHeatRecoveryMode() const; | ||
| 112 | |||
| 113 | double outdoorUnitHeatExchangerCapacityRatio() const; | ||
| 114 | |||
| 115 | double outdoorUnitFanPowerPerUnitofRatedEvaporativeCapacity() const; | ||
| 116 | |||
| 117 | double outdoorUnitFanFlowRatePerUnitofRatedEvaporativeCapacity() const; | ||
| 118 | |||
| 119 | Curve outdoorUnitEvaporatingTemperatureFunctionofSuperheatingCurve() const; | ||
| 120 | |||
| 121 | Curve outdoorUnitCondensingTemperatureFunctionofSubcoolingCurve() const; | ||
| 122 | |||
| 123 | double diameterofMainPipeforSuctionGas() const; | ||
| 124 | |||
| 125 | double diameterofMainPipeforDischargeGas() const; | ||
| 126 | |||
| 127 | double lengthofMainPipeConnectingOutdoorUnittotheFirstBranchJoint() const; | ||
| 128 | |||
| 129 | double equivalentLengthofMainPipeConnectingOutdoorUnittotheFirstBranchJoint() const; | ||
| 130 | |||
| 131 | double heightDifferenceBetweenOutdoorUnitandIndoorUnits() const; | ||
| 132 | |||
| 133 | double mainPipeInsulationThickness() const; | ||
| 134 | |||
| 135 | double mainPipeInsulationThermalConductivity() const; | ||
| 136 | |||
| 137 | double crankcaseHeaterPowerperCompressor() const; | ||
| 138 | |||
| 139 | int numberofCompressors() const; | ||
| 140 | |||
| 141 | double ratioofCompressorSizetoTotalCompressorCapacity() const; | ||
| 142 | |||
| 143 | double maximumOutdoorDryBulbTemperatureforCrankcaseHeater() const; | ||
| 144 | |||
| 145 | std::string defrostStrategy() const; | ||
| 146 | |||
| 147 | std::string defrostControl() const; | ||
| 148 | |||
| 149 | boost::optional<Curve> defrostEnergyInputRatioModifierFunctionofTemperatureCurve() const; | ||
| 150 | |||
| 151 | double defrostTimePeriodFraction() const; | ||
| 152 | |||
| 153 | boost::optional<double> resistiveDefrostHeaterCapacity() const; | ||
| 154 | |||
| 155 | bool isResistiveDefrostHeaterCapacityAutosized() const; | ||
| 156 | |||
| 157 | double maximumOutdoorDrybulbTemperatureforDefrostOperation() const; | ||
| 158 | |||
| 159 | double initialHeatRecoveryCoolingCapacityFraction() const; | ||
| 160 | |||
| 161 | double heatRecoveryCoolingCapacityTimeConstant() const; | ||
| 162 | |||
| 163 | double initialHeatRecoveryCoolingEnergyFraction() const; | ||
| 164 | |||
| 165 | double heatRecoveryCoolingEnergyTimeConstant() const; | ||
| 166 | |||
| 167 | double initialHeatRecoveryHeatingCapacityFraction() const; | ||
| 168 | |||
| 169 | double heatRecoveryHeatingCapacityTimeConstant() const; | ||
| 170 | |||
| 171 | double initialHeatRecoveryHeatingEnergyFraction() const; | ||
| 172 | |||
| 173 | double heatRecoveryHeatingEnergyTimeConstant() const; | ||
| 174 | |||
| 175 | double compressorMaximumDeltaPressure() const; | ||
| 176 | |||
| 177 | double compressorInverterEfficiency() const; | ||
| 178 | |||
| 179 | double compressorEvaporativeCapacityCorrectionFactor() const; | ||
| 180 | |||
| 181 | //@} | ||
| 182 | /** @name Setters */ | ||
| 183 | //@{ | ||
| 184 | |||
| 185 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 186 | |||
| 187 | bool setRefrigerantType(const std::string& refrigerantType); | ||
| 188 | |||
| 189 | bool setRatedEvaporativeCapacity(double ratedEvaporativeCapacity); | ||
| 190 | |||
| 191 | void autosizeRatedEvaporativeCapacity(); | ||
| 192 | |||
| 193 | bool setRatedCompressorPowerPerUnitofRatedEvaporativeCapacity(double ratedCompressorPowerPerUnitofRatedEvaporativeCapacity); | ||
| 194 | |||
| 195 | bool setMinimumOutdoorAirTemperatureinCoolingOnlyMode(double minimumOutdoorAirTemperatureinCoolingOnlyMode); | ||
| 196 | |||
| 197 | bool setMaximumOutdoorAirTemperatureinCoolingOnlyMode(double maximumOutdoorAirTemperatureinCoolingOnlyMode); | ||
| 198 | |||
| 199 | bool setMinimumOutdoorAirTemperatureinHeatingOnlyMode(double minimumOutdoorAirTemperatureinHeatingOnlyMode); | ||
| 200 | |||
| 201 | bool setMaximumOutdoorAirTemperatureinHeatingOnlyMode(double maximumOutdoorAirTemperatureinHeatingOnlyMode); | ||
| 202 | |||
| 203 | bool setMinimumOutdoorTemperatureinHeatRecoveryMode(double minimumOutdoorTemperatureinHeatRecoveryMode); | ||
| 204 | |||
| 205 | bool setMaximumOutdoorTemperatureinHeatRecoveryMode(double maximumOutdoorTemperatureinHeatRecoveryMode); | ||
| 206 | |||
| 207 | bool setRefrigerantTemperatureControlAlgorithmforIndoorUnit(const std::string& refrigerantTemperatureControlAlgorithmforIndoorUnit); | ||
| 208 | |||
| 209 | bool setReferenceEvaporatingTemperatureforIndoorUnit(double referenceEvaporatingTemperatureforIndoorUnit); | ||
| 210 | |||
| 211 | bool setReferenceCondensingTemperatureforIndoorUnit(double referenceCondensingTemperatureforIndoorUnit); | ||
| 212 | |||
| 213 | bool setVariableEvaporatingTemperatureMinimumforIndoorUnit(double variableEvaporatingTemperatureMinimumforIndoorUnit); | ||
| 214 | |||
| 215 | bool setVariableEvaporatingTemperatureMaximumforIndoorUnit(double variableEvaporatingTemperatureMaximumforIndoorUnit); | ||
| 216 | |||
| 217 | bool setVariableCondensingTemperatureMinimumforIndoorUnit(double variableCondensingTemperatureMinimumforIndoorUnit); | ||
| 218 | |||
| 219 | bool setVariableCondensingTemperatureMaximumforIndoorUnit(double variableCondensingTemperatureMaximumforIndoorUnit); | ||
| 220 | |||
| 221 | bool setOutdoorUnitEvaporatorReferenceSuperheating(double outdoorUnitEvaporatorReferenceSuperheating); | ||
| 222 | |||
| 223 | bool setOutdoorUnitCondenserReferenceSubcooling(double outdoorUnitCondenserReferenceSubcooling); | ||
| 224 | |||
| 225 | bool setOutdoorUnitEvaporatorRatedBypassFactor(double outdoorUnitEvaporatorRatedBypassFactor); | ||
| 226 | |||
| 227 | bool setOutdoorUnitCondenserRatedBypassFactor(double outdoorUnitCondenserRatedBypassFactor); | ||
| 228 | |||
| 229 | bool setDifferencebetweenOutdoorUnitEvaporatingTemperatureandOutdoorAirTemperatureinHeatRecoveryMode( | ||
| 230 | double differencebetweenOutdoorUnitEvaporatingTemperatureandOutdoorAirTemperatureinHeatRecoveryMode); | ||
| 231 | |||
| 232 | bool setOutdoorUnitHeatExchangerCapacityRatio(double outdoorUnitHeatExchangerCapacityRatio); | ||
| 233 | |||
| 234 | bool setOutdoorUnitFanPowerPerUnitofRatedEvaporativeCapacity(double outdoorUnitFanPowerPerUnitofRatedEvaporativeCapacity); | ||
| 235 | |||
| 236 | bool setOutdoorUnitFanFlowRatePerUnitofRatedEvaporativeCapacity(double outdoorUnitFanFlowRatePerUnitofRatedEvaporativeCapacity); | ||
| 237 | |||
| 238 | bool setOutdoorUnitEvaporatingTemperatureFunctionofSuperheatingCurve(const Curve& curve); | ||
| 239 | |||
| 240 | bool setOutdoorUnitCondensingTemperatureFunctionofSubcoolingCurve(const Curve& curve); | ||
| 241 | |||
| 242 | bool setDiameterofMainPipeforSuctionGas(double diameterofMainPipeforSuctionGas); | ||
| 243 | |||
| 244 | bool setDiameterofMainPipeforDischargeGas(double diameterofMainPipeforDischargeGas); | ||
| 245 | |||
| 246 | bool setLengthofMainPipeConnectingOutdoorUnittotheFirstBranchJoint(double lengthofMainPipeConnectingOutdoorUnittotheFirstBranchJoint); | ||
| 247 | |||
| 248 | bool setEquivalentLengthofMainPipeConnectingOutdoorUnittotheFirstBranchJoint( | ||
| 249 | double equivalentLengthofMainPipeConnectingOutdoorUnittotheFirstBranchJoint); | ||
| 250 | |||
| 251 | bool setHeightDifferenceBetweenOutdoorUnitandIndoorUnits(double heightDifferenceBetweenOutdoorUnitandIndoorUnits); | ||
| 252 | |||
| 253 | bool setMainPipeInsulationThickness(double mainPipeInsulationThickness); | ||
| 254 | |||
| 255 | bool setMainPipeInsulationThermalConductivity(double mainPipeInsulationThermalConductivity); | ||
| 256 | |||
| 257 | bool setCrankcaseHeaterPowerperCompressor(double crankcaseHeaterPowerperCompressor); | ||
| 258 | |||
| 259 | bool setNumberofCompressors(int numberofCompressors); | ||
| 260 | |||
| 261 | bool setRatioofCompressorSizetoTotalCompressorCapacity(double ratioofCompressorSizetoTotalCompressorCapacity); | ||
| 262 | |||
| 263 | bool setMaximumOutdoorDryBulbTemperatureforCrankcaseHeater(double maximumOutdoorDryBulbTemperatureforCrankcaseHeater); | ||
| 264 | |||
| 265 | bool setDefrostStrategy(const std::string& defrostStrategy); | ||
| 266 | |||
| 267 | bool setDefrostControl(const std::string& defrostControl); | ||
| 268 | |||
| 269 | bool setDefrostEnergyInputRatioModifierFunctionofTemperatureCurve(const Curve& curve); | ||
| 270 | |||
| 271 | void resetDefrostEnergyInputRatioModifierFunctionofTemperatureCurve(); | ||
| 272 | |||
| 273 | bool setDefrostTimePeriodFraction(double defrostTimePeriodFraction); | ||
| 274 | |||
| 275 | bool setResistiveDefrostHeaterCapacity(double resistiveDefrostHeaterCapacity); | ||
| 276 | |||
| 277 | void autosizeResistiveDefrostHeaterCapacity(); | ||
| 278 | |||
| 279 | bool setMaximumOutdoorDrybulbTemperatureforDefrostOperation(double maximumOutdoorDrybulbTemperatureforDefrostOperation); | ||
| 280 | |||
| 281 | bool setInitialHeatRecoveryCoolingCapacityFraction(double initialHeatRecoveryCoolingCapacityFraction); | ||
| 282 | |||
| 283 | bool setHeatRecoveryCoolingCapacityTimeConstant(double heatRecoveryCoolingCapacityTimeConstant); | ||
| 284 | |||
| 285 | bool setInitialHeatRecoveryCoolingEnergyFraction(double initialHeatRecoveryCoolingEnergyFraction); | ||
| 286 | |||
| 287 | bool setHeatRecoveryCoolingEnergyTimeConstant(double heatRecoveryCoolingEnergyTimeConstant); | ||
| 288 | |||
| 289 | bool setInitialHeatRecoveryHeatingCapacityFraction(double initialHeatRecoveryHeatingCapacityFraction); | ||
| 290 | |||
| 291 | bool setHeatRecoveryHeatingCapacityTimeConstant(double heatRecoveryHeatingCapacityTimeConstant); | ||
| 292 | |||
| 293 | bool setInitialHeatRecoveryHeatingEnergyFraction(double initialHeatRecoveryHeatingEnergyFraction); | ||
| 294 | |||
| 295 | bool setHeatRecoveryHeatingEnergyTimeConstant(double heatRecoveryHeatingEnergyTimeConstant); | ||
| 296 | |||
| 297 | bool setCompressorMaximumDeltaPressure(double compressorMaximumDeltaPressure); | ||
| 298 | |||
| 299 | bool setCompressorInverterEfficiency(double compressorInverterEfficiency); | ||
| 300 | |||
| 301 | bool setCompressorEvaporativeCapacityCorrectionFactor(double compressorEvaporativeCapacityCorrectionFactor); | ||
| 302 | |||
| 303 | //@} | ||
| 304 | /** @name Other */ | ||
| 305 | //@{ | ||
| 306 | |||
| 307 | bool addTerminal(ZoneHVACTerminalUnitVariableRefrigerantFlow& vrf); | ||
| 308 | |||
| 309 | void removeTerminal(ZoneHVACTerminalUnitVariableRefrigerantFlow& vrf); | ||
| 310 | |||
| 311 | void removeAllTerminals(); | ||
| 312 | |||
| 313 | std::vector<ZoneHVACTerminalUnitVariableRefrigerantFlow> terminals() const; | ||
| 314 | |||
| 315 | bool addLoadingIndex(LoadingIndex& loadingIndex); | ||
| 316 | |||
| 317 | void removeLoadingIndex(LoadingIndex& loadingIndex); | ||
| 318 | |||
| 319 | void removeAllLoadingIndexes(); | ||
| 320 | |||
| 321 | std::vector<LoadingIndex> loadingIndexes() const; | ||
| 322 | |||
| 323 | boost::optional<double> autosizedRatedEvaporativeCapacity(); | ||
| 324 | |||
| 325 | boost::optional<double> autosizedResistiveDefrostHeaterCapacity(); | ||
| 326 | |||
| 327 | boost::optional<double> autosizedGrossRatedTotalCoolingCapacity() const; | ||
| 328 | |||
| 329 | boost::optional<double> autosizedGrossRatedHeatingCapacity() const; | ||
| 330 | |||
| 331 | //@} | ||
| 332 | protected: | ||
| 333 | /// @cond | ||
| 334 | using ImplType = detail::AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR_Impl; | ||
| 335 | |||
| 336 | explicit AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR( | ||
| 337 | std::shared_ptr<detail::AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR_Impl> impl); | ||
| 338 | |||
| 339 | friend class detail::AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR_Impl; | ||
| 340 | friend class Model; | ||
| 341 | friend class IdfObject; | ||
| 342 | friend class openstudio::detail::IdfObject_Impl; | ||
| 343 | /// @endcond | ||
| 344 | private: | ||
| 345 | REGISTER_LOGGER("openstudio.model.AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR"); | ||
| 346 | }; | ||
| 347 | |||
| 348 | /** \relates AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR*/ | ||
| 349 | using OptionalAirConditionerVariableRefrigerantFlowFluidTemperatureControlHR = | ||
| 350 | boost::optional<AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR>; | ||
| 351 | |||
| 352 | /** \relates AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR*/ | ||
| 353 | using AirConditionerVariableRefrigerantFlowFluidTemperatureControlHRVector = | ||
| 354 | std::vector<AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR>; | ||
| 355 | |||
| 356 | } // namespace model | ||
| 357 | } // namespace openstudio | ||
| 358 | |||
| 359 | #endif // MODEL_AIRCONDITIONERVARIABLEREFRIGERANTFLOWFLUIDTEMPERATURECONTROLHR_HPP | ||
| 360 |