src/model/ChillerHeaterPerformanceElectricEIR.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_CHILLERHEATERPERFORMANCEELECTRICEIR_HPP | ||
| 7 | #define MODEL_CHILLERHEATERPERFORMANCEELECTRICEIR_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ParentObject.hpp" | ||
| 11 | |||
| 12 | #include "../utilities/core/Deprecated.hpp" | ||
| 13 | |||
| 14 | namespace openstudio { | ||
| 15 | |||
| 16 | namespace model { | ||
| 17 | |||
| 18 | class Curve; | ||
| 19 | class CentralHeatPumpSystem; | ||
| 20 | class CentralHeatPumpSystemModule; | ||
| 21 | |||
| 22 | namespace detail { | ||
| 23 | |||
| 24 | class ChillerHeaterPerformanceElectricEIR_Impl; | ||
| 25 | |||
| 26 | } // namespace detail | ||
| 27 | |||
| 28 | /** ChillerHeaterPerformanceElectricEIR is a ParentObject that wraps the OpenStudio IDD object 'OS:ChillerHeaterPerformance:Electric:EIR'. */ | ||
| 29 | class MODEL_API ChillerHeaterPerformanceElectricEIR : public ParentObject | ||
| 30 | { | ||
| 31 | public: | ||
| 32 | /** @name Constructors and Destructors */ | ||
| 33 | //@{ | ||
| 34 | |||
| 35 | explicit ChillerHeaterPerformanceElectricEIR(const Model& model); | ||
| 36 | |||
| 37 | explicit ChillerHeaterPerformanceElectricEIR(const Model& model, const Curve& chillerHeaterClgCapFT, const Curve& chillerHeaterClgEIRFT, | ||
| 38 | const Curve& chillerHeaterClgEIRFPLR, const Curve& chillerHeaterHtgCapFT, | ||
| 39 | const Curve& chillerHeaterHtgEIRFT, const Curve& chillerHeaterHtgEIRFPLR); | ||
| 40 | |||
| 41 | 152 | virtual ~ChillerHeaterPerformanceElectricEIR() override = default; | |
| 42 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 43 | 26 | ChillerHeaterPerformanceElectricEIR(const ChillerHeaterPerformanceElectricEIR& other) = default; | |
| 44 | 63 | ChillerHeaterPerformanceElectricEIR(ChillerHeaterPerformanceElectricEIR&& other) = default; | |
| 45 | ✗ | ChillerHeaterPerformanceElectricEIR& operator=(const ChillerHeaterPerformanceElectricEIR&) = default; | |
| 46 | ✗ | ChillerHeaterPerformanceElectricEIR& operator=(ChillerHeaterPerformanceElectricEIR&&) = default; | |
| 47 | |||
| 48 | //@} | ||
| 49 | |||
| 50 | static IddObjectType iddObjectType(); | ||
| 51 | |||
| 52 | static std::vector<std::string> chilledWaterFlowModeTypeValues(); | ||
| 53 | |||
| 54 | OS_DEPRECATED(3, 12, 0) static std::vector<std::string> condenserTypeValues(); | ||
| 55 | |||
| 56 | static std::vector<std::string> coolingModeTemperatureCurveCondenserWaterIndependentVariableValues(); | ||
| 57 | |||
| 58 | static std::vector<std::string> heatingModeTemperatureCurveCondenserWaterIndependentVariableValues(); | ||
| 59 | |||
| 60 | /** @name Getters */ | ||
| 61 | //@{ | ||
| 62 | |||
| 63 | boost::optional<double> referenceCoolingModeEvaporatorCapacity() const; | ||
| 64 | |||
| 65 | bool isReferenceCoolingModeEvaporatorCapacityAutosized() const; | ||
| 66 | |||
| 67 | double referenceCoolingModeCOP() const; | ||
| 68 | |||
| 69 | double referenceCoolingModeLeavingChilledWaterTemperature() const; | ||
| 70 | |||
| 71 | double referenceCoolingModeEnteringCondenserFluidTemperature() const; | ||
| 72 | |||
| 73 | double referenceCoolingModeLeavingCondenserWaterTemperature() const; | ||
| 74 | |||
| 75 | double referenceHeatingModeCoolingCapacityRatio() const; | ||
| 76 | |||
| 77 | double referenceHeatingModeCoolingPowerInputRatio() const; | ||
| 78 | |||
| 79 | double referenceHeatingModeLeavingChilledWaterTemperature() const; | ||
| 80 | |||
| 81 | double referenceHeatingModeLeavingCondenserWaterTemperature() const; | ||
| 82 | |||
| 83 | double referenceHeatingModeEnteringCondenserFluidTemperature() const; | ||
| 84 | |||
| 85 | double heatingModeEnteringChilledWaterTemperatureLowLimit() const; | ||
| 86 | |||
| 87 | std::string chilledWaterFlowModeType() const; | ||
| 88 | |||
| 89 | boost::optional<double> designChilledWaterFlowRate() const; | ||
| 90 | |||
| 91 | bool isDesignChilledWaterFlowRateAutosized() const; | ||
| 92 | |||
| 93 | boost::optional<double> designCondenserWaterFlowRate() const; | ||
| 94 | |||
| 95 | bool isDesignCondenserWaterFlowRateAutosized() const; | ||
| 96 | |||
| 97 | double designHotWaterFlowRate() const; | ||
| 98 | |||
| 99 | double compressorMotorEfficiency() const; | ||
| 100 | |||
| 101 | OS_DEPRECATED(3, 12, 0) std::string condenserType() const; | ||
| 102 | |||
| 103 | std::string coolingModeTemperatureCurveCondenserWaterIndependentVariable() const; | ||
| 104 | |||
| 105 | Curve coolingModeCoolingCapacityFunctionOfTemperatureCurve() const; | ||
| 106 | |||
| 107 | Curve coolingModeElectricInputToCoolingOutputRatioFunctionOfTemperatureCurve() const; | ||
| 108 | |||
| 109 | Curve coolingModeElectricInputToCoolingOutputRatioFunctionOfPartLoadRatioCurve() const; | ||
| 110 | |||
| 111 | double coolingModeCoolingCapacityOptimumPartLoadRatio() const; | ||
| 112 | |||
| 113 | std::string heatingModeTemperatureCurveCondenserWaterIndependentVariable() const; | ||
| 114 | |||
| 115 | Curve heatingModeCoolingCapacityFunctionOfTemperatureCurve() const; | ||
| 116 | |||
| 117 | Curve heatingModeElectricInputToCoolingOutputRatioFunctionOfTemperatureCurve() const; | ||
| 118 | |||
| 119 | Curve heatingModeElectricInputToCoolingOutputRatioFunctionOfPartLoadRatioCurve() const; | ||
| 120 | |||
| 121 | double heatingModeCoolingCapacityOptimumPartLoadRatio() const; | ||
| 122 | |||
| 123 | double sizingFactor() const; | ||
| 124 | |||
| 125 | //@} | ||
| 126 | /** @name Setters */ | ||
| 127 | //@{ | ||
| 128 | |||
| 129 | bool setReferenceCoolingModeEvaporatorCapacity(double referenceCoolingModeEvaporatorCapacity); | ||
| 130 | |||
| 131 | void autosizeReferenceCoolingModeEvaporatorCapacity(); | ||
| 132 | |||
| 133 | bool setReferenceCoolingModeCOP(double referenceCoolingModeCOP); | ||
| 134 | |||
| 135 | bool setReferenceCoolingModeLeavingChilledWaterTemperature(double referenceCoolingModeLeavingChilledWaterTemperature); | ||
| 136 | |||
| 137 | bool setReferenceCoolingModeEnteringCondenserFluidTemperature(double referenceCoolingModeEnteringCondenserFluidTemperature); | ||
| 138 | |||
| 139 | bool setReferenceCoolingModeLeavingCondenserWaterTemperature(double referenceCoolingModeLeavingCondenserWaterTemperature); | ||
| 140 | |||
| 141 | bool setReferenceHeatingModeCoolingCapacityRatio(double referenceHeatingModeCoolingCapacityRatio); | ||
| 142 | |||
| 143 | bool setReferenceHeatingModeCoolingPowerInputRatio(double referenceHeatingModeCoolingPowerInputRatio); | ||
| 144 | |||
| 145 | bool setReferenceHeatingModeLeavingChilledWaterTemperature(double referenceHeatingModeLeavingChilledWaterTemperature); | ||
| 146 | |||
| 147 | bool setReferenceHeatingModeLeavingCondenserWaterTemperature(double referenceHeatingModeLeavingCondenserWaterTemperature); | ||
| 148 | |||
| 149 | bool setReferenceHeatingModeEnteringCondenserFluidTemperature(double referenceHeatingModeEnteringCondenserFluidTemperature); | ||
| 150 | |||
| 151 | bool setHeatingModeEnteringChilledWaterTemperatureLowLimit(double heatingModeEnteringChilledWaterTemperatureLowLimit); | ||
| 152 | |||
| 153 | bool setChilledWaterFlowModeType(const std::string& chilledWaterFlowModeType); | ||
| 154 | |||
| 155 | bool setDesignChilledWaterFlowRate(double designChilledWaterFlowRate); | ||
| 156 | |||
| 157 | void resetDesignChilledWaterFlowRate(); | ||
| 158 | |||
| 159 | void autosizeDesignChilledWaterFlowRate(); | ||
| 160 | |||
| 161 | bool setDesignCondenserWaterFlowRate(double designCondenserWaterFlowRate); | ||
| 162 | |||
| 163 | void resetDesignCondenserWaterFlowRate(); | ||
| 164 | |||
| 165 | void autosizeDesignCondenserWaterFlowRate(); | ||
| 166 | |||
| 167 | bool setDesignHotWaterFlowRate(double designHotWaterFlowRate); | ||
| 168 | |||
| 169 | bool setCompressorMotorEfficiency(double compressorMotorEfficiency); | ||
| 170 | |||
| 171 | OS_DEPRECATED(3, 12, 0) bool setCondenserType(const std::string& condenserType); | ||
| 172 | |||
| 173 | bool setCoolingModeTemperatureCurveCondenserWaterIndependentVariable( | ||
| 174 | const std::string& coolingModeTemperatureCurveCondenserWaterIndependentVariable); | ||
| 175 | |||
| 176 | bool setCoolingModeCoolingCapacityFunctionOfTemperatureCurve(const Curve& curve); | ||
| 177 | |||
| 178 | bool setCoolingModeElectricInputToCoolingOutputRatioFunctionOfTemperatureCurve(const Curve& curve); | ||
| 179 | |||
| 180 | bool setCoolingModeElectricInputToCoolingOutputRatioFunctionOfPartLoadRatioCurve(const Curve& curve); | ||
| 181 | |||
| 182 | bool setCoolingModeCoolingCapacityOptimumPartLoadRatio(double coolingModeCoolingCapacityOptimumPartLoadRatio); | ||
| 183 | |||
| 184 | bool setHeatingModeTemperatureCurveCondenserWaterIndependentVariable( | ||
| 185 | const std::string& heatingModeTemperatureCurveCondenserWaterIndependentVariable); | ||
| 186 | |||
| 187 | bool setHeatingModeCoolingCapacityFunctionOfTemperatureCurve(const Curve& curve); | ||
| 188 | |||
| 189 | bool setHeatingModeElectricInputToCoolingOutputRatioFunctionOfTemperatureCurve(const Curve& curve); | ||
| 190 | |||
| 191 | bool setHeatingModeElectricInputToCoolingOutputRatioFunctionOfPartLoadRatioCurve(const Curve& curve); | ||
| 192 | |||
| 193 | bool setHeatingModeCoolingCapacityOptimumPartLoadRatio(double heatingModeCoolingCapacityOptimumPartLoadRatio); | ||
| 194 | |||
| 195 | bool setSizingFactor(double sizingFactor); | ||
| 196 | |||
| 197 | //@} | ||
| 198 | /** @name Other */ | ||
| 199 | //@{ | ||
| 200 | |||
| 201 | boost::optional<double> autosizedReferenceCoolingModeEvaporatorCapacity() const; | ||
| 202 | |||
| 203 | boost::optional<double> autosizedDesignChilledWaterFlowRate() const; | ||
| 204 | |||
| 205 | boost::optional<double> autosizedDesignCondenserWaterFlowRate() const; | ||
| 206 | |||
| 207 | void autosize(); | ||
| 208 | |||
| 209 | void applySizingValues(); | ||
| 210 | |||
| 211 | // Reverse lookups | ||
| 212 | // Convenience functions to return parent CentralHeatPumpSystem and CentralHeatPumpSystemModule | ||
| 213 | // I've decided that multiple CentralHeatPumpSystemModules can reference the same ChillerHeaterPerformanceElectricEIR | ||
| 214 | |||
| 215 | /* Returns an Array of CentralHeatPumpSystemModule that reference this object as chillerHeaterModulesPerformanceComponent */ | ||
| 216 | std::vector<CentralHeatPumpSystemModule> centralHeatPumpSystemModules() const; | ||
| 217 | |||
| 218 | /* Returns an Array of CentralHeatPumpSystem that have a CentralHeatPumpSystemModume that reference this object | ||
| 219 | * as chillerHeaterModulesPerformanceComponent */ | ||
| 220 | std::vector<CentralHeatPumpSystem> centralHeatPumpSystems() const; | ||
| 221 | |||
| 222 | //@} | ||
| 223 | protected: | ||
| 224 | /// @cond | ||
| 225 | using ImplType = detail::ChillerHeaterPerformanceElectricEIR_Impl; | ||
| 226 | |||
| 227 | explicit ChillerHeaterPerformanceElectricEIR(std::shared_ptr<detail::ChillerHeaterPerformanceElectricEIR_Impl> impl); | ||
| 228 | |||
| 229 | friend class detail::ChillerHeaterPerformanceElectricEIR_Impl; | ||
| 230 | friend class Model; | ||
| 231 | friend class IdfObject; | ||
| 232 | friend class openstudio::detail::IdfObject_Impl; | ||
| 233 | /// @endcond | ||
| 234 | private: | ||
| 235 | − | REGISTER_LOGGER("openstudio.model.ChillerHeaterPerformanceElectricEIR"); | |
| 236 | }; | ||
| 237 | |||
| 238 | /** \relates ChillerHeaterPerformanceElectricEIR*/ | ||
| 239 | using OptionalChillerHeaterPerformanceElectricEIR = boost::optional<ChillerHeaterPerformanceElectricEIR>; | ||
| 240 | |||
| 241 | /** \relates ChillerHeaterPerformanceElectricEIR*/ | ||
| 242 | using ChillerHeaterPerformanceElectricEIRVector = std::vector<ChillerHeaterPerformanceElectricEIR>; | ||
| 243 | |||
| 244 | } // namespace model | ||
| 245 | } // namespace openstudio | ||
| 246 | |||
| 247 | #endif // MODEL_CHILLERHEATERPERFORMANCEELECTRICEIR_HPP | ||
| 248 |