src/model/RefrigerationAirChiller.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_REFRIGERATIONAIRCHILLER_HPP | ||
| 7 | #define MODEL_REFRIGERATIONAIRCHILLER_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ZoneHVACComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class RefrigerationSystem; | ||
| 17 | class RefrigerationSecondarySystem; | ||
| 18 | class RefrigerationCompressorRack; | ||
| 19 | class Schedule; | ||
| 20 | // class CurveLinear; | ||
| 21 | |||
| 22 | namespace detail { | ||
| 23 | |||
| 24 | class RefrigerationAirChiller_Impl; | ||
| 25 | |||
| 26 | } // namespace detail | ||
| 27 | |||
| 28 | /** RefrigerationAirChiller is a ZoneHVACComponent that wraps the OpenStudio IDD object 'OS:ZoneHVAC:Refrigeration:AirChiller'. | ||
| 29 | * | ||
| 30 | * This component is a ZoneHVACComponent, and you can call RefrigerationAirChiller::addToThermalZone(ThermalZone&) and the ForwardTranslator will | ||
| 31 | * produce a ZoneHVAC:RefrigerationAirChillerSet for you: a ZoneHVACRefrigrerationAirChillerSet class is not needed in the model SDK. */ | ||
| 32 | class MODEL_API RefrigerationAirChiller : public ZoneHVACComponent | ||
| 33 | { | ||
| 34 | public: | ||
| 35 | /** @name Constructors and Destructors */ | ||
| 36 | //@{ | ||
| 37 | |||
| 38 | explicit RefrigerationAirChiller(const Model& model, Schedule& defrostSchedule); | ||
| 39 | |||
| 40 | 161 | virtual ~RefrigerationAirChiller() override = default; | |
| 41 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 42 | 22 | RefrigerationAirChiller(const RefrigerationAirChiller& other) = default; | |
| 43 | 43 | RefrigerationAirChiller(RefrigerationAirChiller&& other) = default; | |
| 44 | ✗ | RefrigerationAirChiller& operator=(const RefrigerationAirChiller&) = default; | |
| 45 | ✗ | RefrigerationAirChiller& operator=(RefrigerationAirChiller&&) = default; | |
| 46 | |||
| 47 | //@} | ||
| 48 | |||
| 49 | static IddObjectType iddObjectType(); | ||
| 50 | |||
| 51 | static std::vector<std::string> capacityRatingTypeValues(); | ||
| 52 | |||
| 53 | // static std::vector<std::string> capacityCorrectionCurveTypeValues(); | ||
| 54 | |||
| 55 | static std::vector<std::string> fanSpeedControlTypeValues(); | ||
| 56 | |||
| 57 | static std::vector<std::string> defrostTypeValues(); | ||
| 58 | |||
| 59 | static std::vector<std::string> defrostControlTypeValues(); | ||
| 60 | |||
| 61 | static std::vector<std::string> verticalLocationValues(); | ||
| 62 | |||
| 63 | /** @name Getters */ | ||
| 64 | //@{ | ||
| 65 | |||
| 66 | boost::optional<Schedule> availabilitySchedule() const; | ||
| 67 | |||
| 68 | std::string capacityRatingType() const; | ||
| 69 | |||
| 70 | boost::optional<double> ratedUnitLoadFactor() const; | ||
| 71 | |||
| 72 | boost::optional<double> ratedCapacity() const; | ||
| 73 | |||
| 74 | double ratedRelativeHumidity() const; | ||
| 75 | |||
| 76 | bool isRatedRelativeHumidityDefaulted() const; | ||
| 77 | |||
| 78 | double ratedCoolingSourceTemperature() const; | ||
| 79 | |||
| 80 | double ratedTemperatureDifferenceDT1() const; | ||
| 81 | |||
| 82 | boost::optional<double> maximumTemperatureDifferenceBetweenInletAirandEvaporatingTemperature() const; | ||
| 83 | |||
| 84 | double coilMaterialCorrectionFactor() const; | ||
| 85 | |||
| 86 | bool isCoilMaterialCorrectionFactorDefaulted() const; | ||
| 87 | |||
| 88 | double refrigerantCorrectionFactor() const; | ||
| 89 | |||
| 90 | bool isRefrigerantCorrectionFactorDefaulted() const; | ||
| 91 | |||
| 92 | // std::string capacityCorrectionCurveType() const; | ||
| 93 | |||
| 94 | // bool isCapacityCorrectionCurveTypeDefaulted() const; | ||
| 95 | |||
| 96 | // boost::optional<CurveLinear> capacityCorrectionCurve() const; | ||
| 97 | |||
| 98 | double sHR60CorrectionFactor() const; | ||
| 99 | |||
| 100 | bool isSHR60CorrectionFactorDefaulted() const; | ||
| 101 | |||
| 102 | double ratedTotalHeatingPower() const; | ||
| 103 | |||
| 104 | boost::optional<Schedule> heatingPowerSchedule() const; | ||
| 105 | |||
| 106 | std::string fanSpeedControlType() const; | ||
| 107 | |||
| 108 | bool isFanSpeedControlTypeDefaulted() const; | ||
| 109 | |||
| 110 | double ratedFanPower() const; | ||
| 111 | |||
| 112 | bool isRatedFanPowerDefaulted() const; | ||
| 113 | |||
| 114 | double ratedAirFlow() const; | ||
| 115 | |||
| 116 | double minimumFanAirFlowRatio() const; | ||
| 117 | |||
| 118 | bool isMinimumFanAirFlowRatioDefaulted() const; | ||
| 119 | |||
| 120 | std::string defrostType() const; | ||
| 121 | |||
| 122 | bool isDefrostTypeDefaulted() const; | ||
| 123 | |||
| 124 | std::string defrostControlType() const; | ||
| 125 | |||
| 126 | bool isDefrostControlTypeDefaulted() const; | ||
| 127 | |||
| 128 | Schedule defrostSchedule() const; | ||
| 129 | |||
| 130 | boost::optional<Schedule> defrostDripDownSchedule() const; | ||
| 131 | |||
| 132 | boost::optional<double> defrostPower() const; | ||
| 133 | |||
| 134 | boost::optional<double> temperatureTerminationDefrostFractiontoIce() const; | ||
| 135 | |||
| 136 | std::string verticalLocation() const; | ||
| 137 | |||
| 138 | bool isVerticalLocationDefaulted() const; | ||
| 139 | |||
| 140 | double averageRefrigerantChargeInventory() const; | ||
| 141 | |||
| 142 | bool isAverageRefrigerantChargeInventoryDefaulted() const; | ||
| 143 | |||
| 144 | // Returns the parent RefrigerationSystem if any | ||
| 145 | boost::optional<RefrigerationSystem> system() const; | ||
| 146 | |||
| 147 | // Returns the parent RefrigerationSecondarySystem if any | ||
| 148 | boost::optional<RefrigerationSecondarySystem> secondarySystem() const; | ||
| 149 | |||
| 150 | // Returns the parent RefrigerationCompresorRack if any | ||
| 151 | boost::optional<RefrigerationCompressorRack> compressorRack() const; | ||
| 152 | |||
| 153 | //@} | ||
| 154 | /** @name Setters */ | ||
| 155 | //@{ | ||
| 156 | |||
| 157 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 158 | |||
| 159 | void resetAvailabilitySchedule(); | ||
| 160 | |||
| 161 | bool setCapacityRatingType(const std::string& capacityRatingType); | ||
| 162 | |||
| 163 | bool setRatedUnitLoadFactor(double ratedUnitLoadFactor); | ||
| 164 | |||
| 165 | void resetRatedUnitLoadFactor(); | ||
| 166 | |||
| 167 | bool setRatedCapacity(double ratedCapacity); | ||
| 168 | |||
| 169 | void resetRatedCapacity(); | ||
| 170 | |||
| 171 | bool setRatedRelativeHumidity(double ratedRelativeHumidity); | ||
| 172 | |||
| 173 | void resetRatedRelativeHumidity(); | ||
| 174 | |||
| 175 | bool setRatedCoolingSourceTemperature(double ratedCoolingSourceTemperature); | ||
| 176 | |||
| 177 | bool setRatedTemperatureDifferenceDT1(double ratedTemperatureDifferenceDT1); | ||
| 178 | |||
| 179 | bool setMaximumTemperatureDifferenceBetweenInletAirandEvaporatingTemperature( | ||
| 180 | double maximumTemperatureDifferenceBetweenInletAirandEvaporatingTemperature); | ||
| 181 | |||
| 182 | void resetMaximumTemperatureDifferenceBetweenInletAirandEvaporatingTemperature(); | ||
| 183 | |||
| 184 | bool setCoilMaterialCorrectionFactor(double coilMaterialCorrectionFactor); | ||
| 185 | |||
| 186 | void resetCoilMaterialCorrectionFactor(); | ||
| 187 | |||
| 188 | bool setRefrigerantCorrectionFactor(double refrigerantCorrectionFactor); | ||
| 189 | |||
| 190 | void resetRefrigerantCorrectionFactor(); | ||
| 191 | |||
| 192 | // bool setCapacityCorrectionCurveType(const std::string& capacityCorrectionCurveType); | ||
| 193 | |||
| 194 | // void resetCapacityCorrectionCurveType(); | ||
| 195 | |||
| 196 | // bool setCapacityCorrectionCurve(const CurveLinear& curveLinear); | ||
| 197 | |||
| 198 | // void resetCapacityCorrectionCurve(); | ||
| 199 | |||
| 200 | bool setSHR60CorrectionFactor(double sHR60CorrectionFactor); | ||
| 201 | |||
| 202 | void resetSHR60CorrectionFactor(); | ||
| 203 | |||
| 204 | bool setRatedTotalHeatingPower(double ratedTotalHeatingPower); | ||
| 205 | |||
| 206 | bool setHeatingPowerSchedule(Schedule& schedule); | ||
| 207 | |||
| 208 | void resetHeatingPowerSchedule(); | ||
| 209 | |||
| 210 | bool setFanSpeedControlType(const std::string& fanSpeedControlType); | ||
| 211 | |||
| 212 | void resetFanSpeedControlType(); | ||
| 213 | |||
| 214 | bool setRatedFanPower(double ratedFanPower); | ||
| 215 | |||
| 216 | void resetRatedFanPower(); | ||
| 217 | |||
| 218 | bool setRatedAirFlow(double ratedAirFlow); | ||
| 219 | |||
| 220 | bool setMinimumFanAirFlowRatio(double minimumFanAirFlowRatio); | ||
| 221 | |||
| 222 | void resetMinimumFanAirFlowRatio(); | ||
| 223 | |||
| 224 | bool setDefrostType(const std::string& defrostType); | ||
| 225 | |||
| 226 | void resetDefrostType(); | ||
| 227 | |||
| 228 | bool setDefrostControlType(const std::string& defrostControlType); | ||
| 229 | |||
| 230 | void resetDefrostControlType(); | ||
| 231 | |||
| 232 | bool setDefrostSchedule(Schedule& schedule); | ||
| 233 | |||
| 234 | bool setDefrostDripDownSchedule(Schedule& schedule); | ||
| 235 | |||
| 236 | void resetDefrostDripDownSchedule(); | ||
| 237 | |||
| 238 | bool setDefrostPower(double defrostPower); | ||
| 239 | |||
| 240 | void resetDefrostPower(); | ||
| 241 | |||
| 242 | bool setTemperatureTerminationDefrostFractiontoIce(double temperatureTerminationDefrostFractiontoIce); | ||
| 243 | |||
| 244 | void resetTemperatureTerminationDefrostFractiontoIce(); | ||
| 245 | |||
| 246 | // bool setVerticalLocation(const std::string& verticalLocation); | ||
| 247 | |||
| 248 | // void resetVerticalLocation(); | ||
| 249 | |||
| 250 | bool setAverageRefrigerantChargeInventory(double averageRefrigerantChargeInventory); | ||
| 251 | |||
| 252 | void resetAverageRefrigerantChargeInventory(); | ||
| 253 | |||
| 254 | bool addToSystem(RefrigerationSystem& system); | ||
| 255 | |||
| 256 | bool addToSecondarySystem(RefrigerationSecondarySystem& secondarySystem); | ||
| 257 | |||
| 258 | bool addToCompressorRack(RefrigerationCompressorRack& compressorRack); | ||
| 259 | |||
| 260 | // Remove from parent system if any | ||
| 261 | void removeFromSystem(); | ||
| 262 | |||
| 263 | // Remove from parent secondary system if any | ||
| 264 | void removeFromSecondarySystem(); | ||
| 265 | |||
| 266 | // Remove from parent compressor rack if any | ||
| 267 | void removeFromCompressorRack(); | ||
| 268 | |||
| 269 | //@} | ||
| 270 | /** @name Other */ | ||
| 271 | //@{ | ||
| 272 | |||
| 273 | //@} | ||
| 274 | protected: | ||
| 275 | /// @cond | ||
| 276 | using ImplType = detail::RefrigerationAirChiller_Impl; | ||
| 277 | |||
| 278 | explicit RefrigerationAirChiller(std::shared_ptr<detail::RefrigerationAirChiller_Impl> impl); | ||
| 279 | |||
| 280 | friend class detail::RefrigerationAirChiller_Impl; | ||
| 281 | friend class Model; | ||
| 282 | friend class IdfObject; | ||
| 283 | friend class openstudio::detail::IdfObject_Impl; | ||
| 284 | /// @endcond | ||
| 285 | private: | ||
| 286 | REGISTER_LOGGER("openstudio.model.RefrigerationAirChiller"); | ||
| 287 | }; | ||
| 288 | |||
| 289 | /** \relates RefrigerationAirChiller*/ | ||
| 290 | using OptionalRefrigerationAirChiller = boost::optional<RefrigerationAirChiller>; | ||
| 291 | |||
| 292 | /** \relates RefrigerationAirChiller*/ | ||
| 293 | using RefrigerationAirChillerVector = std::vector<RefrigerationAirChiller>; | ||
| 294 | |||
| 295 | } // namespace model | ||
| 296 | } // namespace openstudio | ||
| 297 | |||
| 298 | #endif // MODEL_REFRIGERATIONAIRCHILLER_HPP | ||
| 299 |