src/model/CoolingTowerTwoSpeed.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_COOLINGTOWERTWOSPEED_HPP | ||
| 7 | #define MODEL_COOLINGTOWERTWOSPEED_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | |||
| 18 | namespace detail { | ||
| 19 | |||
| 20 | class CoolingTowerTwoSpeed_Impl; | ||
| 21 | |||
| 22 | } // namespace detail | ||
| 23 | |||
| 24 | /** CoolingTowerTwoSpeed is a StraightComponent that wraps the OpenStudio IDD object 'OS:CoolingTower:TwoSpeed'. */ | ||
| 25 | class MODEL_API CoolingTowerTwoSpeed : public StraightComponent | ||
| 26 | { | ||
| 27 | public: | ||
| 28 | /** @name Constructors and Destructors */ | ||
| 29 | //@{ | ||
| 30 | |||
| 31 | explicit CoolingTowerTwoSpeed(const Model& model); | ||
| 32 | |||
| 33 | 4 | virtual ~CoolingTowerTwoSpeed() override = default; | |
| 34 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 35 | ✗ | CoolingTowerTwoSpeed(const CoolingTowerTwoSpeed& other) = default; | |
| 36 | ✗ | CoolingTowerTwoSpeed(CoolingTowerTwoSpeed&& other) = default; | |
| 37 | ✗ | CoolingTowerTwoSpeed& operator=(const CoolingTowerTwoSpeed&) = default; | |
| 38 | ✗ | CoolingTowerTwoSpeed& operator=(CoolingTowerTwoSpeed&&) = default; | |
| 39 | |||
| 40 | //@} | ||
| 41 | |||
| 42 | static IddObjectType iddObjectType(); | ||
| 43 | |||
| 44 | static std::vector<std::string> performanceInputMethodValues(); | ||
| 45 | |||
| 46 | static std::vector<std::string> evaporationLossModeValues(); | ||
| 47 | |||
| 48 | static std::vector<std::string> blowdownCalculationModeValues(); | ||
| 49 | |||
| 50 | static std::vector<std::string> cellControlValues(); | ||
| 51 | |||
| 52 | /** @name Getters */ | ||
| 53 | //@{ | ||
| 54 | |||
| 55 | boost::optional<double> designWaterFlowRate() const; | ||
| 56 | |||
| 57 | bool isDesignWaterFlowRateAutosized() const; | ||
| 58 | |||
| 59 | boost::optional<double> highFanSpeedAirFlowRate() const; | ||
| 60 | |||
| 61 | bool isHighFanSpeedAirFlowRateAutosized() const; | ||
| 62 | |||
| 63 | boost::optional<double> highFanSpeedFanPower() const; | ||
| 64 | |||
| 65 | bool isHighFanSpeedFanPowerAutosized() const; | ||
| 66 | |||
| 67 | boost::optional<double> highFanSpeedUFactorTimesAreaValue() const; | ||
| 68 | |||
| 69 | bool isHighFanSpeedUFactorTimesAreaValueAutosized() const; | ||
| 70 | |||
| 71 | boost::optional<double> lowFanSpeedAirFlowRate() const; | ||
| 72 | |||
| 73 | bool isLowFanSpeedAirFlowRateAutosized() const; | ||
| 74 | |||
| 75 | double lowFanSpeedAirFlowRateSizingFactor() const; | ||
| 76 | |||
| 77 | bool isLowFanSpeedAirFlowRateSizingFactorDefaulted() const; | ||
| 78 | |||
| 79 | boost::optional<double> lowFanSpeedFanPower() const; | ||
| 80 | |||
| 81 | bool isLowFanSpeedFanPowerAutosized() const; | ||
| 82 | |||
| 83 | double lowFanSpeedFanPowerSizingFactor() const; | ||
| 84 | |||
| 85 | bool isLowFanSpeedFanPowerSizingFactorDefaulted() const; | ||
| 86 | |||
| 87 | boost::optional<double> lowFanSpeedUFactorTimesAreaValue() const; | ||
| 88 | |||
| 89 | bool isLowFanSpeedUFactorTimesAreaValueAutosized() const; | ||
| 90 | |||
| 91 | double lowFanSpeedUFactorTimesAreaSizingFactor() const; | ||
| 92 | |||
| 93 | bool isLowFanSpeedUFactorTimesAreaSizingFactorDefaulted() const; | ||
| 94 | |||
| 95 | boost::optional<double> freeConvectionRegimeAirFlowRate() const; | ||
| 96 | |||
| 97 | bool isFreeConvectionRegimeAirFlowRateDefaulted() const; | ||
| 98 | |||
| 99 | bool isFreeConvectionRegimeAirFlowRateAutosized() const; | ||
| 100 | |||
| 101 | double freeConvectionRegimeAirFlowRateSizingFactor() const; | ||
| 102 | |||
| 103 | bool isFreeConvectionRegimeAirFlowRateSizingFactorDefaulted() const; | ||
| 104 | |||
| 105 | boost::optional<double> freeConvectionRegimeUFactorTimesAreaValue() const; | ||
| 106 | |||
| 107 | bool isFreeConvectionRegimeUFactorTimesAreaValueDefaulted() const; | ||
| 108 | |||
| 109 | bool isFreeConvectionRegimeUFactorTimesAreaValueAutosized() const; | ||
| 110 | |||
| 111 | double freeConvectionUFactorTimesAreaValueSizingFactor() const; | ||
| 112 | |||
| 113 | bool isFreeConvectionUFactorTimesAreaValueSizingFactorDefaulted() const; | ||
| 114 | |||
| 115 | std::string performanceInputMethod() const; | ||
| 116 | |||
| 117 | bool isPerformanceInputMethodDefaulted() const; | ||
| 118 | |||
| 119 | double heatRejectionCapacityandNominalCapacitySizingRatio() const; | ||
| 120 | |||
| 121 | bool isHeatRejectionCapacityandNominalCapacitySizingRatioDefaulted() const; | ||
| 122 | |||
| 123 | boost::optional<double> highSpeedNominalCapacity() const; | ||
| 124 | |||
| 125 | boost::optional<double> lowSpeedNominalCapacity() const; | ||
| 126 | |||
| 127 | bool isLowSpeedNominalCapacityAutosized() const; | ||
| 128 | |||
| 129 | double lowSpeedNominalCapacitySizingFactor() const; | ||
| 130 | |||
| 131 | bool isLowSpeedNominalCapacitySizingFactorDefaulted() const; | ||
| 132 | |||
| 133 | boost::optional<double> freeConvectionNominalCapacity() const; | ||
| 134 | |||
| 135 | bool isFreeConvectionNominalCapacityAutosized() const; | ||
| 136 | |||
| 137 | double freeConvectionNominalCapacitySizingFactor() const; | ||
| 138 | |||
| 139 | bool isFreeConvectionNominalCapacitySizingFactorDefaulted() const; | ||
| 140 | |||
| 141 | double basinHeaterCapacity() const; | ||
| 142 | |||
| 143 | bool isBasinHeaterCapacityDefaulted() const; | ||
| 144 | |||
| 145 | double basinHeaterSetpointTemperature() const; | ||
| 146 | |||
| 147 | bool isBasinHeaterSetpointTemperatureDefaulted() const; | ||
| 148 | |||
| 149 | boost::optional<Schedule> basinHeaterOperatingSchedule() const; | ||
| 150 | |||
| 151 | std::string evaporationLossMode() const; | ||
| 152 | |||
| 153 | bool isEvaporationLossModeDefaulted() const; | ||
| 154 | |||
| 155 | double evaporationLossFactor() const; | ||
| 156 | |||
| 157 | bool isEvaporationLossFactorDefaulted() const; | ||
| 158 | |||
| 159 | double driftLossPercent() const; | ||
| 160 | |||
| 161 | bool isDriftLossPercentDefaulted() const; | ||
| 162 | |||
| 163 | std::string blowdownCalculationMode() const; | ||
| 164 | |||
| 165 | bool isBlowdownCalculationModeDefaulted() const; | ||
| 166 | |||
| 167 | double blowdownConcentrationRatio() const; | ||
| 168 | |||
| 169 | bool isBlowdownConcentrationRatioDefaulted() const; | ||
| 170 | |||
| 171 | boost::optional<Schedule> blowdownMakeupWaterUsageSchedule() const; | ||
| 172 | |||
| 173 | // boost::optional<WaterStorageTank> supplyWaterStorageTank() const; | ||
| 174 | |||
| 175 | int numberofCells() const; | ||
| 176 | |||
| 177 | bool isNumberofCellsDefaulted() const; | ||
| 178 | |||
| 179 | std::string cellControl() const; | ||
| 180 | |||
| 181 | bool isCellControlDefaulted() const; | ||
| 182 | |||
| 183 | double cellMinimumWaterFlowRateFraction() const; | ||
| 184 | |||
| 185 | bool isCellMinimumWaterFlowRateFractionDefaulted() const; | ||
| 186 | |||
| 187 | double cellMaximumWaterFlowRateFraction() const; | ||
| 188 | |||
| 189 | bool isCellMaximumWaterFlowRateFractionDefaulted() const; | ||
| 190 | |||
| 191 | double sizingFactor() const; | ||
| 192 | |||
| 193 | bool isSizingFactorDefaulted() const; | ||
| 194 | |||
| 195 | //@} | ||
| 196 | /** @name Setters */ | ||
| 197 | //@{ | ||
| 198 | |||
| 199 | bool setDesignWaterFlowRate(double designWaterFlowRate); | ||
| 200 | |||
| 201 | void resetDesignWaterFlowRate(); | ||
| 202 | |||
| 203 | void autosizeDesignWaterFlowRate(); | ||
| 204 | |||
| 205 | bool setHighFanSpeedAirFlowRate(double highFanSpeedAirFlowRate); | ||
| 206 | |||
| 207 | void autosizeHighFanSpeedAirFlowRate(); | ||
| 208 | |||
| 209 | bool setHighFanSpeedFanPower(double highFanSpeedFanPower); | ||
| 210 | |||
| 211 | void autosizeHighFanSpeedFanPower(); | ||
| 212 | |||
| 213 | bool setHighFanSpeedUFactorTimesAreaValue(double highFanSpeedUFactorTimesAreaValue); | ||
| 214 | |||
| 215 | void resetHighFanSpeedUFactorTimesAreaValue(); | ||
| 216 | |||
| 217 | void autosizeHighFanSpeedUFactorTimesAreaValue(); | ||
| 218 | |||
| 219 | bool setLowFanSpeedAirFlowRate(double lowFanSpeedAirFlowRate); | ||
| 220 | |||
| 221 | void autosizeLowFanSpeedAirFlowRate(); | ||
| 222 | |||
| 223 | bool setLowFanSpeedAirFlowRateSizingFactor(double lowFanSpeedAirFlowRateSizingFactor); | ||
| 224 | |||
| 225 | void resetLowFanSpeedAirFlowRateSizingFactor(); | ||
| 226 | |||
| 227 | bool setLowFanSpeedFanPower(double lowFanSpeedFanPower); | ||
| 228 | |||
| 229 | void autosizeLowFanSpeedFanPower(); | ||
| 230 | |||
| 231 | bool setLowFanSpeedFanPowerSizingFactor(double lowFanSpeedFanPowerSizingFactor); | ||
| 232 | |||
| 233 | void resetLowFanSpeedFanPowerSizingFactor(); | ||
| 234 | |||
| 235 | bool setLowFanSpeedUFactorTimesAreaValue(double lowFanSpeedUFactorTimesAreaValue); | ||
| 236 | |||
| 237 | void resetLowFanSpeedUFactorTimesAreaValue(); | ||
| 238 | |||
| 239 | void autosizeLowFanSpeedUFactorTimesAreaValue(); | ||
| 240 | |||
| 241 | bool setLowFanSpeedUFactorTimesAreaSizingFactor(double lowFanSpeedUFactorTimesAreaSizingFactor); | ||
| 242 | |||
| 243 | void resetLowFanSpeedUFactorTimesAreaSizingFactor(); | ||
| 244 | |||
| 245 | bool setFreeConvectionRegimeAirFlowRate(double freeConvectionRegimeAirFlowRate); | ||
| 246 | |||
| 247 | void resetFreeConvectionRegimeAirFlowRate(); | ||
| 248 | |||
| 249 | void autosizeFreeConvectionRegimeAirFlowRate(); | ||
| 250 | |||
| 251 | bool setFreeConvectionRegimeAirFlowRateSizingFactor(double freeConvectionRegimeAirFlowRateSizingFactor); | ||
| 252 | |||
| 253 | void resetFreeConvectionRegimeAirFlowRateSizingFactor(); | ||
| 254 | |||
| 255 | bool setFreeConvectionRegimeUFactorTimesAreaValue(double freeConvectionRegimeUFactorTimesAreaValue); | ||
| 256 | |||
| 257 | void resetFreeConvectionRegimeUFactorTimesAreaValue(); | ||
| 258 | |||
| 259 | void autosizeFreeConvectionRegimeUFactorTimesAreaValue(); | ||
| 260 | |||
| 261 | bool setFreeConvectionUFactorTimesAreaValueSizingFactor(double freeConvectionUFactorTimesAreaValueSizingFactor); | ||
| 262 | |||
| 263 | void resetFreeConvectionUFactorTimesAreaValueSizingFactor(); | ||
| 264 | |||
| 265 | bool setPerformanceInputMethod(const std::string& performanceInputMethod); | ||
| 266 | |||
| 267 | void resetPerformanceInputMethod(); | ||
| 268 | |||
| 269 | bool setHeatRejectionCapacityandNominalCapacitySizingRatio(double heatRejectionCapacityandNominalCapacitySizingRatio); | ||
| 270 | |||
| 271 | void resetHeatRejectionCapacityandNominalCapacitySizingRatio(); | ||
| 272 | |||
| 273 | bool setHighSpeedNominalCapacity(double highSpeedNominalCapacity); | ||
| 274 | |||
| 275 | void resetHighSpeedNominalCapacity(); | ||
| 276 | |||
| 277 | bool setLowSpeedNominalCapacity(double lowSpeedNominalCapacity); | ||
| 278 | |||
| 279 | void resetLowSpeedNominalCapacity(); | ||
| 280 | |||
| 281 | void autosizeLowSpeedNominalCapacity(); | ||
| 282 | |||
| 283 | bool setLowSpeedNominalCapacitySizingFactor(double lowSpeedNominalCapacitySizingFactor); | ||
| 284 | |||
| 285 | void resetLowSpeedNominalCapacitySizingFactor(); | ||
| 286 | |||
| 287 | bool setFreeConvectionNominalCapacity(double freeConvectionNominalCapacity); | ||
| 288 | |||
| 289 | void resetFreeConvectionNominalCapacity(); | ||
| 290 | |||
| 291 | void autosizeFreeConvectionNominalCapacity(); | ||
| 292 | |||
| 293 | bool setFreeConvectionNominalCapacitySizingFactor(double freeConvectionNominalCapacitySizingFactor); | ||
| 294 | |||
| 295 | void resetFreeConvectionNominalCapacitySizingFactor(); | ||
| 296 | |||
| 297 | bool setBasinHeaterCapacity(double basinHeaterCapacity); | ||
| 298 | |||
| 299 | void resetBasinHeaterCapacity(); | ||
| 300 | |||
| 301 | bool setBasinHeaterSetpointTemperature(double basinHeaterSetpointTemperature); | ||
| 302 | |||
| 303 | void resetBasinHeaterSetpointTemperature(); | ||
| 304 | |||
| 305 | bool setBasinHeaterOperatingSchedule(Schedule& schedule); | ||
| 306 | |||
| 307 | void resetBasinHeaterOperatingSchedule(); | ||
| 308 | |||
| 309 | bool setEvaporationLossMode(const std::string& evaporationLossMode); | ||
| 310 | |||
| 311 | void resetEvaporationLossMode(); | ||
| 312 | |||
| 313 | bool setEvaporationLossFactor(double evaporationLossFactor); | ||
| 314 | |||
| 315 | void resetEvaporationLossFactor(); | ||
| 316 | |||
| 317 | bool setDriftLossPercent(double driftLossPercent); | ||
| 318 | |||
| 319 | void resetDriftLossPercent(); | ||
| 320 | |||
| 321 | bool setBlowdownCalculationMode(const std::string& blowdownCalculationMode); | ||
| 322 | |||
| 323 | void resetBlowdownCalculationMode(); | ||
| 324 | |||
| 325 | bool setBlowdownConcentrationRatio(double blowdownConcentrationRatio); | ||
| 326 | |||
| 327 | void resetBlowdownConcentrationRatio(); | ||
| 328 | |||
| 329 | bool setBlowdownMakeupWaterUsageSchedule(Schedule& schedule); | ||
| 330 | |||
| 331 | void resetBlowdownMakeupWaterUsageSchedule(); | ||
| 332 | |||
| 333 | // bool setSupplyWaterStorageTank(const WaterStorageTank& waterStorageTank); | ||
| 334 | |||
| 335 | // void resetSupplyWaterStorageTank(); | ||
| 336 | |||
| 337 | bool setNumberofCells(int numberofCells); | ||
| 338 | |||
| 339 | void resetNumberofCells(); | ||
| 340 | |||
| 341 | bool setCellControl(const std::string& cellControl); | ||
| 342 | |||
| 343 | void resetCellControl(); | ||
| 344 | |||
| 345 | bool setCellMinimumWaterFlowRateFraction(double cellMinimumWaterFlowRateFraction); | ||
| 346 | |||
| 347 | void resetCellMinimumWaterFlowRateFraction(); | ||
| 348 | |||
| 349 | bool setCellMaximumWaterFlowRateFraction(double cellMaximumWaterFlowRateFraction); | ||
| 350 | |||
| 351 | void resetCellMaximumWaterFlowRateFraction(); | ||
| 352 | |||
| 353 | bool setSizingFactor(double sizingFactor); | ||
| 354 | |||
| 355 | void resetSizingFactor(); | ||
| 356 | |||
| 357 | double designInletAirDryBulbTemperature() const; | ||
| 358 | bool setDesignInletAirDryBulbTemperature(double designInletAirDryBulbTemperature); | ||
| 359 | |||
| 360 | double designInletAirWetBulbTemperature() const; | ||
| 361 | bool setDesignInletAirWetBulbTemperature(double designInletAirWetBulbTemperature); | ||
| 362 | |||
| 363 | boost::optional<double> designApproachTemperature() const; | ||
| 364 | bool isDesignApproachTemperatureAutosized() const; | ||
| 365 | bool setDesignApproachTemperature(double designApproachTemperature); | ||
| 366 | void autosizeDesignApproachTemperature(); | ||
| 367 | |||
| 368 | boost::optional<double> designRangeTemperature() const; | ||
| 369 | bool isDesignRangeTemperatureAutosized() const; | ||
| 370 | bool setDesignRangeTemperature(double designRangeTemperature); | ||
| 371 | void autosizeDesignRangeTemperature(); | ||
| 372 | |||
| 373 | std::string endUseSubcategory() const; | ||
| 374 | bool setEndUseSubcategory(const std::string& endUseSubcategory); | ||
| 375 | |||
| 376 | //@} | ||
| 377 | /** @name Other */ | ||
| 378 | //@{ | ||
| 379 | |||
| 380 | boost::optional<double> autosizedDesignWaterFlowRate() const; | ||
| 381 | |||
| 382 | boost::optional<double> autosizedHighFanSpeedAirFlowRate() const; | ||
| 383 | |||
| 384 | boost::optional<double> autosizedHighFanSpeedFanPower() const; | ||
| 385 | |||
| 386 | boost::optional<double> autosizedHighFanSpeedUFactorTimesAreaValue() const; | ||
| 387 | |||
| 388 | boost::optional<double> autosizedLowFanSpeedAirFlowRate() const; | ||
| 389 | |||
| 390 | boost::optional<double> autosizedLowFanSpeedFanPower() const; | ||
| 391 | |||
| 392 | boost::optional<double> autosizedLowFanSpeedUFactorTimesAreaValue() const; | ||
| 393 | |||
| 394 | boost::optional<double> autosizedFreeConvectionRegimeAirFlowRate() const; | ||
| 395 | |||
| 396 | boost::optional<double> autosizedFreeConvectionRegimeUFactorTimesAreaValue() const; | ||
| 397 | |||
| 398 | boost::optional<double> autosizedLowSpeedNominalCapacity() const; | ||
| 399 | |||
| 400 | boost::optional<double> autosizedFreeConvectionNominalCapacity() const; | ||
| 401 | |||
| 402 | /* This method mimics what E+ does because this value it isn't reported in the SQL file: | ||
| 403 | * It gets the input from the Sizing:Plant attached to the loop and the entered design inlet air wet-bulb temperature | ||
| 404 | */ | ||
| 405 | boost::optional<double> autosizedDesignApproachTemperature() const; | ||
| 406 | |||
| 407 | /* This method mimics what E+ does because this value it isn't reported in the SQL file: | ||
| 408 | * It gets the input from the Sizing:Plant attached to the loop | ||
| 409 | */ | ||
| 410 | boost::optional<double> autosizedDesignRangeTemperature() const; | ||
| 411 | |||
| 412 | //@} | ||
| 413 | protected: | ||
| 414 | /// @cond | ||
| 415 | using ImplType = detail::CoolingTowerTwoSpeed_Impl; | ||
| 416 | |||
| 417 | explicit CoolingTowerTwoSpeed(std::shared_ptr<detail::CoolingTowerTwoSpeed_Impl> impl); | ||
| 418 | |||
| 419 | friend class detail::CoolingTowerTwoSpeed_Impl; | ||
| 420 | friend class Model; | ||
| 421 | friend class IdfObject; | ||
| 422 | friend class openstudio::detail::IdfObject_Impl; | ||
| 423 | /// @endcond | ||
| 424 | private: | ||
| 425 | REGISTER_LOGGER("openstudio.model.CoolingTowerTwoSpeed"); | ||
| 426 | }; | ||
| 427 | |||
| 428 | /** \relates CoolingTowerTwoSpeed*/ | ||
| 429 | using OptionalCoolingTowerTwoSpeed = boost::optional<CoolingTowerTwoSpeed>; | ||
| 430 | |||
| 431 | /** \relates CoolingTowerTwoSpeed*/ | ||
| 432 | using CoolingTowerTwoSpeedVector = std::vector<CoolingTowerTwoSpeed>; | ||
| 433 | |||
| 434 | } // namespace model | ||
| 435 | } // namespace openstudio | ||
| 436 | |||
| 437 | #endif // MODEL_COOLINGTOWERTWOSPEED_HPP | ||
| 438 |