src/model/CoolingTowerVariableSpeed.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_COOLINGTOWERVARIABLESPEED_HPP | ||
| 7 | #define MODEL_COOLINGTOWERVARIABLESPEED_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Schedule; | ||
| 17 | class CurveCubic; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | class CoolingTowerVariableSpeed_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** CoolingTowerVariableSpeed is a StraightComponent that wraps the OpenStudio IDD object 'OS:CoolingTower:VariableSpeed'. */ | ||
| 26 | class MODEL_API CoolingTowerVariableSpeed : public StraightComponent | ||
| 27 | { | ||
| 28 | public: | ||
| 29 | explicit CoolingTowerVariableSpeed(const Model& model); | ||
| 30 | |||
| 31 | 4 | virtual ~CoolingTowerVariableSpeed() override = default; | |
| 32 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 33 | ✗ | CoolingTowerVariableSpeed(const CoolingTowerVariableSpeed& other) = default; | |
| 34 | ✗ | CoolingTowerVariableSpeed(CoolingTowerVariableSpeed&& other) = default; | |
| 35 | ✗ | CoolingTowerVariableSpeed& operator=(const CoolingTowerVariableSpeed&) = default; | |
| 36 | ✗ | CoolingTowerVariableSpeed& operator=(CoolingTowerVariableSpeed&&) = default; | |
| 37 | |||
| 38 | static IddObjectType iddObjectType(); | ||
| 39 | |||
| 40 | static std::vector<std::string> modelTypeValues(); | ||
| 41 | |||
| 42 | static std::vector<std::string> evaporationLossModeValues(); | ||
| 43 | |||
| 44 | static std::vector<std::string> blowdownCalculationModeValues(); | ||
| 45 | |||
| 46 | static std::vector<std::string> cellControlValues(); | ||
| 47 | |||
| 48 | boost::optional<std::string> modelType() const; | ||
| 49 | |||
| 50 | bool setModelType(const std::string& modelType); | ||
| 51 | |||
| 52 | void resetModelType(); | ||
| 53 | |||
| 54 | /** Returns CoolingTowerPerformanceYorkCalc, CoolingTowerPerformanceCoolTools, or boost::none | ||
| 55 | */ | ||
| 56 | boost::optional<ModelObject> modelCoefficient() const; | ||
| 57 | |||
| 58 | /** Accepts CoolingTowerPerformanceYorkCalc or CoolingTowerPerformanceCoolTools | ||
| 59 | */ | ||
| 60 | bool setModelCoefficient(const ModelObject& variableSpeedTowerCoefficient); | ||
| 61 | |||
| 62 | void resetModelCoefficient(); | ||
| 63 | |||
| 64 | boost::optional<double> designInletAirWetBulbTemperature() const; | ||
| 65 | |||
| 66 | bool setDesignInletAirWetBulbTemperature(double designInletAirWetBulbTemperature); | ||
| 67 | |||
| 68 | void resetDesignInletAirWetBulbTemperature(); | ||
| 69 | |||
| 70 | boost::optional<double> designApproachTemperature() const; | ||
| 71 | |||
| 72 | bool setDesignApproachTemperature(double designApproachTemperature); | ||
| 73 | |||
| 74 | void resetDesignApproachTemperature(); | ||
| 75 | |||
| 76 | boost::optional<double> designRangeTemperature() const; | ||
| 77 | |||
| 78 | bool setDesignRangeTemperature(double designRangeTemperature); | ||
| 79 | |||
| 80 | void resetDesignRangeTemperature(); | ||
| 81 | |||
| 82 | boost::optional<double> designWaterFlowRate() const; | ||
| 83 | |||
| 84 | bool isDesignWaterFlowRateAutosized() const; | ||
| 85 | |||
| 86 | bool setDesignWaterFlowRate(double designWaterFlowRate); | ||
| 87 | |||
| 88 | void autosizeDesignWaterFlowRate(); | ||
| 89 | |||
| 90 | boost::optional<double> designAirFlowRate() const; | ||
| 91 | |||
| 92 | bool isDesignAirFlowRateAutosized() const; | ||
| 93 | |||
| 94 | bool setDesignAirFlowRate(double designAirFlowRate); | ||
| 95 | |||
| 96 | void autosizeDesignAirFlowRate(); | ||
| 97 | |||
| 98 | boost::optional<double> designFanPower() const; | ||
| 99 | |||
| 100 | bool isDesignFanPowerAutosized() const; | ||
| 101 | |||
| 102 | bool setDesignFanPower(double designFanPower); | ||
| 103 | |||
| 104 | void autosizeDesignFanPower(); | ||
| 105 | |||
| 106 | boost::optional<CurveCubic> fanPowerRatioFunctionofAirFlowRateRatioCurve() const; | ||
| 107 | |||
| 108 | bool setFanPowerRatioFunctionofAirFlowRateRatioCurve(const CurveCubic& curve); | ||
| 109 | |||
| 110 | void resetFanPowerRatioFunctionofAirFlowRateRatioCurve(); | ||
| 111 | |||
| 112 | boost::optional<double> minimumAirFlowRateRatio() const; | ||
| 113 | |||
| 114 | bool setMinimumAirFlowRateRatio(double minimumAirFlowRateRatio); | ||
| 115 | |||
| 116 | void resetMinimumAirFlowRateRatio(); | ||
| 117 | |||
| 118 | boost::optional<double> fractionofTowerCapacityinFreeConvectionRegime() const; | ||
| 119 | |||
| 120 | bool setFractionofTowerCapacityinFreeConvectionRegime(double fractionofTowerCapacityinFreeConvectionRegime); | ||
| 121 | |||
| 122 | void resetFractionofTowerCapacityinFreeConvectionRegime(); | ||
| 123 | |||
| 124 | boost::optional<double> basinHeaterCapacity() const; | ||
| 125 | |||
| 126 | bool setBasinHeaterCapacity(double basinHeaterCapacity); | ||
| 127 | |||
| 128 | void resetBasinHeaterCapacity(); | ||
| 129 | |||
| 130 | boost::optional<double> basinHeaterSetpointTemperature() const; | ||
| 131 | |||
| 132 | bool setBasinHeaterSetpointTemperature(double basinHeaterSetpointTemperature); | ||
| 133 | |||
| 134 | void resetBasinHeaterSetpointTemperature(); | ||
| 135 | |||
| 136 | boost::optional<Schedule> basinHeaterOperatingSchedule() const; | ||
| 137 | |||
| 138 | bool setBasinHeaterOperatingSchedule(Schedule& schedule); | ||
| 139 | |||
| 140 | void resetBasinHeaterOperatingSchedule(); | ||
| 141 | |||
| 142 | std::string evaporationLossMode() const; | ||
| 143 | |||
| 144 | bool isEvaporationLossModeDefaulted() const; | ||
| 145 | |||
| 146 | bool setEvaporationLossMode(const std::string& evaporationLossMode); | ||
| 147 | |||
| 148 | void resetEvaporationLossMode(); | ||
| 149 | |||
| 150 | double evaporationLossFactor() const; | ||
| 151 | |||
| 152 | bool isEvaporationLossFactorDefaulted() const; | ||
| 153 | |||
| 154 | bool setEvaporationLossFactor(double evaporationLossFactor); | ||
| 155 | |||
| 156 | void resetEvaporationLossFactor(); | ||
| 157 | |||
| 158 | boost::optional<double> driftLossPercent() const; | ||
| 159 | |||
| 160 | bool setDriftLossPercent(double driftLossPercent); | ||
| 161 | |||
| 162 | void resetDriftLossPercent(); | ||
| 163 | |||
| 164 | std::string blowdownCalculationMode() const; | ||
| 165 | |||
| 166 | bool isBlowdownCalculationModeDefaulted() const; | ||
| 167 | |||
| 168 | bool setBlowdownCalculationMode(const std::string& blowdownCalculationMode); | ||
| 169 | |||
| 170 | void resetBlowdownCalculationMode(); | ||
| 171 | |||
| 172 | boost::optional<double> blowdownConcentrationRatio() const; | ||
| 173 | |||
| 174 | bool setBlowdownConcentrationRatio(double blowdownConcentrationRatio); | ||
| 175 | |||
| 176 | void resetBlowdownConcentrationRatio(); | ||
| 177 | |||
| 178 | boost::optional<Schedule> blowdownMakeupWaterUsageSchedule() const; | ||
| 179 | |||
| 180 | bool setBlowdownMakeupWaterUsageSchedule(Schedule& schedule); | ||
| 181 | |||
| 182 | void resetBlowdownMakeupWaterUsageSchedule(); | ||
| 183 | |||
| 184 | boost::optional<int> numberofCells() const; | ||
| 185 | |||
| 186 | bool setNumberofCells(int numberofCells); | ||
| 187 | |||
| 188 | void resetNumberofCells(); | ||
| 189 | |||
| 190 | std::string cellControl() const; | ||
| 191 | |||
| 192 | bool isCellControlDefaulted() const; | ||
| 193 | |||
| 194 | bool setCellControl(const std::string& cellControl); | ||
| 195 | |||
| 196 | void resetCellControl(); | ||
| 197 | |||
| 198 | boost::optional<double> cellMinimumWaterFlowRateFraction() const; | ||
| 199 | |||
| 200 | bool setCellMinimumWaterFlowRateFraction(double cellMinimumWaterFlowRateFraction); | ||
| 201 | |||
| 202 | void resetCellMinimumWaterFlowRateFraction(); | ||
| 203 | |||
| 204 | boost::optional<double> cellMaximumWaterFlowRateFraction() const; | ||
| 205 | |||
| 206 | bool setCellMaximumWaterFlowRateFraction(double cellMaximumWaterFlowRateFraction); | ||
| 207 | |||
| 208 | void resetCellMaximumWaterFlowRateFraction(); | ||
| 209 | |||
| 210 | boost::optional<double> sizingFactor() const; | ||
| 211 | |||
| 212 | bool setSizingFactor(double sizingFactor); | ||
| 213 | |||
| 214 | void resetSizingFactor(); | ||
| 215 | |||
| 216 | boost::optional<double> autosizedDesignWaterFlowRate() const; | ||
| 217 | |||
| 218 | boost::optional<double> autosizedDesignAirFlowRate() const; | ||
| 219 | |||
| 220 | boost::optional<double> autosizedDesignFanPower() const; | ||
| 221 | |||
| 222 | std::string endUseSubcategory() const; | ||
| 223 | |||
| 224 | bool setEndUseSubcategory(const std::string& endUseSubcategory); | ||
| 225 | |||
| 226 | protected: | ||
| 227 | /// @cond | ||
| 228 | using ImplType = detail::CoolingTowerVariableSpeed_Impl; | ||
| 229 | |||
| 230 | explicit CoolingTowerVariableSpeed(std::shared_ptr<detail::CoolingTowerVariableSpeed_Impl> impl); | ||
| 231 | |||
| 232 | friend class detail::CoolingTowerVariableSpeed_Impl; | ||
| 233 | friend class Model; | ||
| 234 | friend class IdfObject; | ||
| 235 | friend class openstudio::detail::IdfObject_Impl; | ||
| 236 | /// @endcond | ||
| 237 | |||
| 238 | private: | ||
| 239 | REGISTER_LOGGER("openstudio.model.CoolingTowerVariableSpeed"); | ||
| 240 | }; | ||
| 241 | |||
| 242 | /** \relates CoolingTowerVariableSpeed*/ | ||
| 243 | using OptionalCoolingTowerVariableSpeed = boost::optional<CoolingTowerVariableSpeed>; | ||
| 244 | |||
| 245 | /** \relates CoolingTowerVariableSpeed*/ | ||
| 246 | using CoolingTowerVariableSpeedVector = std::vector<CoolingTowerVariableSpeed>; | ||
| 247 | |||
| 248 | } // namespace model | ||
| 249 | } // namespace openstudio | ||
| 250 | |||
| 251 | #endif // MODEL_COOLINGTOWERVARIABLESPEED_HPP | ||
| 252 |