src/model/ChillerElectricEIR.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_CHILLERELECTRICEIR_HPP | ||
| 7 | #define MODEL_CHILLERELECTRICEIR_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "WaterToWaterComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Curve; | ||
| 17 | class Schedule; | ||
| 18 | class Node; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | class ChillerElectricEIR_Impl; | ||
| 23 | |||
| 24 | } // namespace detail | ||
| 25 | |||
| 26 | /** ChillerElectricEIR is a StraightComponent that wraps the OpenStudio IDD object | ||
| 27 | * 'OS:Chiller:Electric:EIR'. */ | ||
| 28 | class MODEL_API ChillerElectricEIR : public WaterToWaterComponent | ||
| 29 | { | ||
| 30 | public: | ||
| 31 | /** | ||
| 32 | * | ||
| 33 | *\param model the Model to put the chiller in | ||
| 34 | *\param CCFofT Cooling Capacity as a Function of Temp | ||
| 35 | *\param EItoCORFofT Electric Input to Cooling Output Ratio as a Function of Temp | ||
| 36 | *\param EItoCORFofPLR Electric Input to Cooling Output Ratio as a Function of Partial Load Ratio | ||
| 37 | */ | ||
| 38 | explicit ChillerElectricEIR(const Model& model, const Curve& CCFofT, const Curve& EItoCORFofT, const Curve& EItoCORFofPLR); | ||
| 39 | |||
| 40 | explicit ChillerElectricEIR(const Model& model); | ||
| 41 | |||
| 42 | 47 | virtual ~ChillerElectricEIR() override = default; | |
| 43 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 44 | 3 | ChillerElectricEIR(const ChillerElectricEIR& other) = default; | |
| 45 | 6 | ChillerElectricEIR(ChillerElectricEIR&& other) = default; | |
| 46 | ✗ | ChillerElectricEIR& operator=(const ChillerElectricEIR&) = default; | |
| 47 | ✗ | ChillerElectricEIR& operator=(ChillerElectricEIR&&) = default; | |
| 48 | |||
| 49 | //@} | ||
| 50 | |||
| 51 | static IddObjectType iddObjectType(); | ||
| 52 | |||
| 53 | static std::vector<std::string> validCondenserTypeValues(); | ||
| 54 | |||
| 55 | static std::vector<std::string> validChillerFlowModeValues(); | ||
| 56 | |||
| 57 | static std::vector<std::string> validCondenserFlowControlValues(); | ||
| 58 | |||
| 59 | /** @name Getters */ | ||
| 60 | //@{ | ||
| 61 | |||
| 62 | boost::optional<double> referenceCapacity() const; | ||
| 63 | |||
| 64 | bool isReferenceCapacityAutosized() const; | ||
| 65 | |||
| 66 | double referenceCOP() const; | ||
| 67 | |||
| 68 | double referenceLeavingChilledWaterTemperature() const; | ||
| 69 | |||
| 70 | bool isReferenceLeavingChilledWaterTemperatureDefaulted() const; | ||
| 71 | |||
| 72 | double referenceEnteringCondenserFluidTemperature() const; | ||
| 73 | |||
| 74 | bool isReferenceEnteringCondenserFluidTemperatureDefaulted() const; | ||
| 75 | |||
| 76 | boost::optional<double> referenceChilledWaterFlowRate() const; | ||
| 77 | |||
| 78 | bool isReferenceChilledWaterFlowRateAutosized() const; | ||
| 79 | |||
| 80 | boost::optional<double> referenceCondenserFluidFlowRate() const; | ||
| 81 | |||
| 82 | bool isReferenceCondenserFluidFlowRateAutosized() const; | ||
| 83 | |||
| 84 | Curve coolingCapacityFunctionOfTemperature() const; | ||
| 85 | |||
| 86 | Curve electricInputToCoolingOutputRatioFunctionOfTemperature() const; | ||
| 87 | |||
| 88 | Curve electricInputToCoolingOutputRatioFunctionOfPLR() const; | ||
| 89 | |||
| 90 | double minimumPartLoadRatio() const; | ||
| 91 | |||
| 92 | bool isMinimumPartLoadRatioDefaulted() const; | ||
| 93 | |||
| 94 | double maximumPartLoadRatio() const; | ||
| 95 | |||
| 96 | bool isMaximumPartLoadRatioDefaulted() const; | ||
| 97 | |||
| 98 | double optimumPartLoadRatio() const; | ||
| 99 | |||
| 100 | bool isOptimumPartLoadRatioDefaulted() const; | ||
| 101 | |||
| 102 | double minimumUnloadingRatio() const; | ||
| 103 | |||
| 104 | bool isMinimumUnloadingRatioDefaulted() const; | ||
| 105 | |||
| 106 | std::string condenserType() const; | ||
| 107 | |||
| 108 | bool isCondenserTypeDefaulted() const; | ||
| 109 | |||
| 110 | double condenserFanPowerRatio() const; | ||
| 111 | |||
| 112 | bool isCondenserFanPowerRatioDefaulted() const; | ||
| 113 | |||
| 114 | double fractionofCompressorElectricConsumptionRejectedbyCondenser() const; | ||
| 115 | |||
| 116 | bool isFractionofCompressorElectricConsumptionRejectedbyCondenserDefaulted() const; | ||
| 117 | |||
| 118 | double leavingChilledWaterLowerTemperatureLimit() const; | ||
| 119 | |||
| 120 | bool isLeavingChilledWaterLowerTemperatureLimitDefaulted() const; | ||
| 121 | |||
| 122 | std::string chillerFlowMode() const; | ||
| 123 | |||
| 124 | bool isChillerFlowModeDefaulted() const; | ||
| 125 | |||
| 126 | boost::optional<double> designHeatRecoveryWaterFlowRate() const; | ||
| 127 | |||
| 128 | bool isDesignHeatRecoveryWaterFlowRateAutosized() const; | ||
| 129 | |||
| 130 | double sizingFactor() const; | ||
| 131 | |||
| 132 | bool isSizingFactorDefaulted() const; | ||
| 133 | |||
| 134 | double basinHeaterCapacity() const; | ||
| 135 | |||
| 136 | bool isBasinHeaterCapacityDefaulted() const; | ||
| 137 | |||
| 138 | double basinHeaterSetpointTemperature() const; | ||
| 139 | |||
| 140 | bool isBasinHeaterSetpointTemperatureDefaulted() const; | ||
| 141 | |||
| 142 | boost::optional<Schedule> basinHeaterSchedule() const; | ||
| 143 | |||
| 144 | double condenserHeatRecoveryRelativeCapacityFraction() const; | ||
| 145 | |||
| 146 | boost::optional<Schedule> heatRecoveryInletHighTemperatureLimitSchedule() const; | ||
| 147 | |||
| 148 | boost::optional<Node> heatRecoveryLeavingTemperatureSetpointNode() const; | ||
| 149 | |||
| 150 | std::string endUseSubcategory() const; | ||
| 151 | |||
| 152 | std::string condenserFlowControl() const; | ||
| 153 | |||
| 154 | boost::optional<Curve> condenserLoopFlowRateFractionFunctionofLoopPartLoadRatioCurve() const; | ||
| 155 | |||
| 156 | boost::optional<Schedule> temperatureDifferenceAcrossCondenserSchedule() const; | ||
| 157 | |||
| 158 | double condenserMinimumFlowFraction() const; | ||
| 159 | |||
| 160 | boost::optional<Curve> thermosiphonCapacityFractionCurve() const; | ||
| 161 | |||
| 162 | double thermosiphonMinimumTemperatureDifference() const; | ||
| 163 | |||
| 164 | //@} | ||
| 165 | /** @name Setters */ | ||
| 166 | //@{ | ||
| 167 | |||
| 168 | bool setReferenceCapacity(boost::optional<double> referenceCapacity); | ||
| 169 | |||
| 170 | bool setReferenceCapacity(double referenceCapacity); | ||
| 171 | |||
| 172 | void autosizeReferenceCapacity(); | ||
| 173 | |||
| 174 | bool setReferenceCOP(double referenceCOP); | ||
| 175 | |||
| 176 | bool setReferenceLeavingChilledWaterTemperature(double referenceLeavingChilledWaterTemperature); | ||
| 177 | |||
| 178 | void resetReferenceLeavingChilledWaterTemperature(); | ||
| 179 | |||
| 180 | bool setReferenceEnteringCondenserFluidTemperature(double referenceEnteringCondenserFluidTemperature); | ||
| 181 | |||
| 182 | void resetReferenceEnteringCondenserFluidTemperature(); | ||
| 183 | |||
| 184 | bool setReferenceChilledWaterFlowRate(boost::optional<double> referenceChilledWaterFlowRate); | ||
| 185 | |||
| 186 | bool setReferenceChilledWaterFlowRate(double referenceChilledWaterFlowRate); | ||
| 187 | |||
| 188 | void resetReferenceChilledWaterFlowRate(); | ||
| 189 | |||
| 190 | void autosizeReferenceChilledWaterFlowRate(); | ||
| 191 | |||
| 192 | bool setReferenceCondenserFluidFlowRate(boost::optional<double> referenceCondenserFluidFlowRate); | ||
| 193 | |||
| 194 | bool setReferenceCondenserFluidFlowRate(double referenceCondenserFluidFlowRate); | ||
| 195 | |||
| 196 | void resetReferenceCondenserFluidFlowRate(); | ||
| 197 | |||
| 198 | void autosizeReferenceCondenserFluidFlowRate(); | ||
| 199 | |||
| 200 | bool setCoolingCapacityFunctionOfTemperature(const Curve&); | ||
| 201 | |||
| 202 | bool setElectricInputToCoolingOutputRatioFunctionOfTemperature(const Curve&); | ||
| 203 | |||
| 204 | bool setElectricInputToCoolingOutputRatioFunctionOfPLR(const Curve&); | ||
| 205 | |||
| 206 | bool setMinimumPartLoadRatio(double minimumPartLoadRatio); | ||
| 207 | |||
| 208 | void resetMinimumPartLoadRatio(); | ||
| 209 | |||
| 210 | bool setMaximumPartLoadRatio(double maximumPartLoadRatio); | ||
| 211 | |||
| 212 | void resetMaximumPartLoadRatio(); | ||
| 213 | |||
| 214 | bool setOptimumPartLoadRatio(double optimumPartLoadRatio); | ||
| 215 | |||
| 216 | void resetOptimumPartLoadRatio(); | ||
| 217 | |||
| 218 | bool setMinimumUnloadingRatio(double minimumUnloadingRatio); | ||
| 219 | |||
| 220 | void resetMinimumUnloadingRatio(); | ||
| 221 | |||
| 222 | bool setCondenserType(const std::string& condenserType); | ||
| 223 | |||
| 224 | void resetCondenserType(); | ||
| 225 | |||
| 226 | bool setCondenserFanPowerRatio(double condenserFanPowerRatio); | ||
| 227 | |||
| 228 | void resetCondenserFanPowerRatio(); | ||
| 229 | |||
| 230 | bool setFractionofCompressorElectricConsumptionRejectedbyCondenser(double fractionofCompressorElectricConsumptionRejectedbyCondenser); | ||
| 231 | |||
| 232 | void resetFractionofCompressorElectricConsumptionRejectedbyCondenser(); | ||
| 233 | |||
| 234 | bool setLeavingChilledWaterLowerTemperatureLimit(double leavingChilledWaterLowerTemperatureLimit); | ||
| 235 | |||
| 236 | void resetLeavingChilledWaterLowerTemperatureLimit(); | ||
| 237 | |||
| 238 | bool setChillerFlowMode(const std::string& chillerFlowMode); | ||
| 239 | |||
| 240 | void resetChillerFlowMode(); | ||
| 241 | |||
| 242 | bool setDesignHeatRecoveryWaterFlowRate(double designHeatRecoveryWaterFlowRate); | ||
| 243 | |||
| 244 | void autosizeDesignHeatRecoveryWaterFlowRate(); | ||
| 245 | |||
| 246 | bool setSizingFactor(double sizingFactor); | ||
| 247 | |||
| 248 | void resetSizingFactor(); | ||
| 249 | |||
| 250 | bool setBasinHeaterCapacity(double basinHeaterCapacity); | ||
| 251 | |||
| 252 | void resetBasinHeaterCapacity(); | ||
| 253 | |||
| 254 | bool setBasinHeaterSetpointTemperature(double basinHeaterSetpointTemperature); | ||
| 255 | |||
| 256 | void resetBasinHeaterSetpointTemperature(); | ||
| 257 | |||
| 258 | bool setBasinHeaterSchedule(Schedule& s); | ||
| 259 | |||
| 260 | void resetBasinHeaterSchedule(); | ||
| 261 | |||
| 262 | bool setCondenserHeatRecoveryRelativeCapacityFraction(double condenserHeatRecoveryRelativeCapacityFraction); | ||
| 263 | |||
| 264 | bool setHeatRecoveryInletHighTemperatureLimitSchedule(Schedule& s); | ||
| 265 | void resetHeatRecoveryInletHighTemperatureLimitSchedule(); | ||
| 266 | |||
| 267 | bool setHeatRecoveryLeavingTemperatureSetpointNode(const Node& node); | ||
| 268 | void resetHeatRecoveryLeavingTemperatureSetpointNode(); | ||
| 269 | |||
| 270 | bool setEndUseSubcategory(const std::string& endUseSubcategory); | ||
| 271 | |||
| 272 | bool setCondenserFlowControl(const std::string& condenserFlowControl); | ||
| 273 | |||
| 274 | bool setCondenserLoopFlowRateFractionFunctionofLoopPartLoadRatioCurve(const Curve& condenserLoopFlowRateFractionFunctionofLoopPartLoadRatioCurve); | ||
| 275 | void resetCondenserLoopFlowRateFractionFunctionofLoopPartLoadRatioCurve(); | ||
| 276 | |||
| 277 | bool setTemperatureDifferenceAcrossCondenserSchedule(Schedule& temperatureDifferenceAcrossCondenserSchedule); | ||
| 278 | void resetTemperatureDifferenceAcrossCondenserSchedule(); | ||
| 279 | |||
| 280 | bool setCondenserMinimumFlowFraction(double condenserMinimumFlowFraction); | ||
| 281 | |||
| 282 | bool setThermosiphonCapacityFractionCurve(const Curve& thermosiphonCapacityFractionCurve); | ||
| 283 | void resetThermosiphonCapacityFractionCurve(); | ||
| 284 | |||
| 285 | bool setThermosiphonMinimumTemperatureDifference(double thermosiphonMinimumTemperatureDifference); | ||
| 286 | |||
| 287 | //@} | ||
| 288 | /** @name Other */ | ||
| 289 | //@{ | ||
| 290 | // | ||
| 291 | boost::optional<double> autosizedReferenceCapacity() const; | ||
| 292 | |||
| 293 | boost::optional<double> autosizedReferenceChilledWaterFlowRate() const; | ||
| 294 | |||
| 295 | boost::optional<double> autosizedReferenceCondenserFluidFlowRate() const; | ||
| 296 | |||
| 297 | boost::optional<double> autosizedDesignHeatRecoveryWaterFlowRate() const; | ||
| 298 | |||
| 299 | /** Convenience Function to return the Chilled Water Loop (chiller on supply) **/ | ||
| 300 | boost::optional<PlantLoop> chilledWaterLoop() const; | ||
| 301 | // Same as supplyInletModelObject, but cast to a Node | ||
| 302 | boost::optional<Node> chilledWaterInletNode() const; | ||
| 303 | boost::optional<Node> chilledWaterOutletNode() const; | ||
| 304 | |||
| 305 | /** Convenience Function to return the Condenser Water Loop (chiller on demand side) **/ | ||
| 306 | boost::optional<PlantLoop> condenserWaterLoop() const; | ||
| 307 | boost::optional<Node> condenserInletNode() const; | ||
| 308 | boost::optional<Node> condenserOutletNode() const; | ||
| 309 | |||
| 310 | /** Convenience Function to return the Heat Recovery Loop (chiller on demand side - tertiary) **/ | ||
| 311 | boost::optional<PlantLoop> heatRecoveryLoop() const; | ||
| 312 | boost::optional<Node> heatRecoveryInletNode() const; | ||
| 313 | boost::optional<Node> heatRecoveryOutletNode() const; | ||
| 314 | |||
| 315 | //@} | ||
| 316 | protected: | ||
| 317 | /// @cond | ||
| 318 | using ImplType = detail::ChillerElectricEIR_Impl; | ||
| 319 | |||
| 320 | friend class Model; | ||
| 321 | friend class openstudio::IdfObject; | ||
| 322 | |||
| 323 | explicit ChillerElectricEIR(std::shared_ptr<detail::ChillerElectricEIR_Impl> impl); | ||
| 324 | |||
| 325 | /// @endcond | ||
| 326 | private: | ||
| 327 | REGISTER_LOGGER("openstudio.model.ChillerElectricEIR"); | ||
| 328 | }; | ||
| 329 | |||
| 330 | /** \relates ChillerElectricEIR*/ | ||
| 331 | using OptionalChillerElectricEIR = boost::optional<ChillerElectricEIR>; | ||
| 332 | |||
| 333 | /** \relates ChillerElectricEIR*/ | ||
| 334 | using ChillerElectricEIRVector = std::vector<ChillerElectricEIR>; | ||
| 335 | |||
| 336 | } // namespace model | ||
| 337 | |||
| 338 | } // namespace openstudio | ||
| 339 | |||
| 340 | #endif // MODEL_CHILLERELECTRICEIR_HPP | ||
| 341 |