src/model/CoilCoolingDXMultiSpeedStageData.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_COILCOOLINGDXMULTISPEEDSTAGEDATA_HPP | ||
| 7 | #define MODEL_COILCOOLINGDXMULTISPEEDSTAGEDATA_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ParentObject.hpp" | ||
| 11 | #include "../model/CoilCoolingDXMultiSpeed.hpp" | ||
| 12 | #include "../utilities/core/Deprecated.hpp" | ||
| 13 | |||
| 14 | namespace openstudio { | ||
| 15 | |||
| 16 | namespace model { | ||
| 17 | |||
| 18 | class Curve; | ||
| 19 | |||
| 20 | namespace detail { | ||
| 21 | |||
| 22 | class CoilCoolingDXMultiSpeedStageData_Impl; | ||
| 23 | |||
| 24 | } // namespace detail | ||
| 25 | |||
| 26 | /** CoilCoolingDXMultiSpeedStageData is a ParentObject that wraps the OpenStudio IDD object 'OS:Coil:Cooling:DX:MultiSpeed:StageData'. */ | ||
| 27 | class MODEL_API CoilCoolingDXMultiSpeedStageData : public ParentObject | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | //@{ | ||
| 32 | |||
| 33 | explicit CoilCoolingDXMultiSpeedStageData(const Model& model, Curve& coolingCapacityFunctionofTemperature, | ||
| 34 | Curve& coolingCapacityFuncionofFlowFraction, Curve& energyInputRatioFunctionofTemperature, | ||
| 35 | Curve& energyInputRatioFunctionofFlowFraction, Curve& partLoadFractionCorrelation, | ||
| 36 | Curve& wasteHeatFunctionofTemperature); | ||
| 37 | |||
| 38 | /** Create CoilCoolingDXMultiSpeedStageData with default curves **/ | ||
| 39 | explicit CoilCoolingDXMultiSpeedStageData(const Model& model); | ||
| 40 | |||
| 41 | 573 | virtual ~CoilCoolingDXMultiSpeedStageData() override = default; | |
| 42 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 43 | 155 | CoilCoolingDXMultiSpeedStageData(const CoilCoolingDXMultiSpeedStageData& other) = default; | |
| 44 | 236 | CoilCoolingDXMultiSpeedStageData(CoilCoolingDXMultiSpeedStageData&& other) = default; | |
| 45 | ✗ | CoilCoolingDXMultiSpeedStageData& operator=(const CoilCoolingDXMultiSpeedStageData&) = default; | |
| 46 | 4 | CoilCoolingDXMultiSpeedStageData& operator=(CoilCoolingDXMultiSpeedStageData&&) = default; | |
| 47 | |||
| 48 | //@} | ||
| 49 | |||
| 50 | static IddObjectType iddObjectType(); | ||
| 51 | |||
| 52 | /** @name Getters */ | ||
| 53 | //@{ | ||
| 54 | |||
| 55 | boost::optional<double> grossRatedTotalCoolingCapacity() const; | ||
| 56 | |||
| 57 | bool isGrossRatedTotalCoolingCapacityAutosized() const; | ||
| 58 | |||
| 59 | boost::optional<double> grossRatedSensibleHeatRatio() const; | ||
| 60 | |||
| 61 | bool isGrossRatedSensibleHeatRatioAutosized() const; | ||
| 62 | |||
| 63 | double grossRatedCoolingCOP() const; | ||
| 64 | |||
| 65 | boost::optional<double> ratedAirFlowRate() const; | ||
| 66 | |||
| 67 | bool isRatedAirFlowRateAutosized() const; | ||
| 68 | |||
| 69 | OS_DEPRECATED(3, 5, 0) double ratedEvaporatorFanPowerPerVolumeFlowRate() const; | ||
| 70 | |||
| 71 | double ratedEvaporatorFanPowerPerVolumeFlowRate2017() const; | ||
| 72 | |||
| 73 | double ratedEvaporatorFanPowerPerVolumeFlowRate2023() const; | ||
| 74 | |||
| 75 | Curve totalCoolingCapacityFunctionofTemperatureCurve() const; | ||
| 76 | |||
| 77 | Curve totalCoolingCapacityFunctionofFlowFractionCurve() const; | ||
| 78 | |||
| 79 | Curve energyInputRatioFunctionofTemperatureCurve() const; | ||
| 80 | |||
| 81 | Curve energyInputRatioFunctionofFlowFractionCurve() const; | ||
| 82 | |||
| 83 | Curve partLoadFractionCorrelationCurve() const; | ||
| 84 | |||
| 85 | double nominalTimeforCondensateRemovaltoBegin() const; | ||
| 86 | |||
| 87 | double ratioofInitialMoistureEvaporationRateandSteadyStateLatentCapacity() const; | ||
| 88 | |||
| 89 | double maximumCyclingRate() const; | ||
| 90 | |||
| 91 | double latentCapacityTimeConstant() const; | ||
| 92 | |||
| 93 | double ratedWasteHeatFractionofPowerInput() const; | ||
| 94 | |||
| 95 | Curve wasteHeatFunctionofTemperatureCurve() const; | ||
| 96 | |||
| 97 | double evaporativeCondenserEffectiveness() const; | ||
| 98 | |||
| 99 | boost::optional<double> evaporativeCondenserAirFlowRate() const; | ||
| 100 | |||
| 101 | bool isEvaporativeCondenserAirFlowRateAutosized() const; | ||
| 102 | |||
| 103 | boost::optional<double> ratedEvaporativeCondenserPumpPowerConsumption() const; | ||
| 104 | |||
| 105 | bool isRatedEvaporativeCondenserPumpPowerConsumptionAutosized() const; | ||
| 106 | |||
| 107 | //@} | ||
| 108 | /** @name Setters */ | ||
| 109 | //@{ | ||
| 110 | |||
| 111 | bool setGrossRatedTotalCoolingCapacity(double grossRatedTotalCoolingCapacity); | ||
| 112 | |||
| 113 | void autosizeGrossRatedTotalCoolingCapacity(); | ||
| 114 | |||
| 115 | bool setGrossRatedSensibleHeatRatio(double grossRatedSensibleHeatRatio); | ||
| 116 | |||
| 117 | void autosizeGrossRatedSensibleHeatRatio(); | ||
| 118 | |||
| 119 | bool setGrossRatedCoolingCOP(double grossRatedCoolingCOP); | ||
| 120 | |||
| 121 | bool setRatedAirFlowRate(double ratedAirFlowRate); | ||
| 122 | |||
| 123 | void autosizeRatedAirFlowRate(); | ||
| 124 | |||
| 125 | OS_DEPRECATED(3, 5, 0) bool setRatedEvaporatorFanPowerPerVolumeFlowRate(double ratedEvaporatorFanPowerPerVolumeFlowRate); | ||
| 126 | |||
| 127 | bool setRatedEvaporatorFanPowerPerVolumeFlowRate2017(double ratedEvaporatorFanPowerPerVolumeFlowRate2017); | ||
| 128 | |||
| 129 | bool setRatedEvaporatorFanPowerPerVolumeFlowRate2023(double ratedEvaporatorFanPowerPerVolumeFlowRate2023); | ||
| 130 | |||
| 131 | bool setTotalCoolingCapacityFunctionofTemperatureCurve(const Curve& curve); | ||
| 132 | |||
| 133 | bool setTotalCoolingCapacityFunctionofFlowFractionCurve(const Curve& curve); | ||
| 134 | |||
| 135 | bool setEnergyInputRatioFunctionofTemperatureCurve(const Curve& curve); | ||
| 136 | |||
| 137 | bool setEnergyInputRatioFunctionofFlowFractionCurve(const Curve& curve); | ||
| 138 | |||
| 139 | bool setPartLoadFractionCorrelationCurve(const Curve& curve); | ||
| 140 | |||
| 141 | bool setNominalTimeforCondensateRemovaltoBegin(double nominalTimeforCondensateRemovaltoBegin); | ||
| 142 | |||
| 143 | bool | ||
| 144 | setRatioofInitialMoistureEvaporationRateandSteadyStateLatentCapacity(double ratioofInitialMoistureEvaporationRateandSteadyStateLatentCapacity); | ||
| 145 | |||
| 146 | bool setMaximumCyclingRate(double maximumCyclingRate); | ||
| 147 | |||
| 148 | bool setLatentCapacityTimeConstant(double latentCapacityTimeConstant); | ||
| 149 | |||
| 150 | bool setRatedWasteHeatFractionofPowerInput(double ratedWasteHeatFractionofPowerInput); | ||
| 151 | |||
| 152 | bool setWasteHeatFunctionofTemperatureCurve(const Curve& curve); | ||
| 153 | |||
| 154 | bool setEvaporativeCondenserEffectiveness(double evaporativeCondenserEffectiveness); | ||
| 155 | |||
| 156 | bool setEvaporativeCondenserAirFlowRate(double evaporativeCondenserAirFlowRate); | ||
| 157 | |||
| 158 | void autosizeEvaporativeCondenserAirFlowRate(); | ||
| 159 | |||
| 160 | bool setRatedEvaporativeCondenserPumpPowerConsumption(double ratedEvaporativeCondenserPumpPowerConsumption); | ||
| 161 | |||
| 162 | void autosizeRatedEvaporativeCondenserPumpPowerConsumption(); | ||
| 163 | |||
| 164 | //@} | ||
| 165 | /** @name Other */ | ||
| 166 | //@{ | ||
| 167 | |||
| 168 | // Returns the CoilCoolingDXMultiSpeed that references it if any | ||
| 169 | boost::optional<CoilCoolingDXMultiSpeed> parentCoil() const; | ||
| 170 | |||
| 171 | boost::optional<double> autosizedGrossRatedTotalCoolingCapacity() const; | ||
| 172 | |||
| 173 | boost::optional<double> autosizedGrossRatedSensibleHeatRatio() const; | ||
| 174 | |||
| 175 | boost::optional<double> autosizedRatedAirFlowRate() const; | ||
| 176 | |||
| 177 | boost::optional<double> autosizedEvaporativeCondenserAirFlowRate() const; | ||
| 178 | |||
| 179 | boost::optional<double> autosizedRatedEvaporativeCondenserPumpPowerConsumption() const; | ||
| 180 | |||
| 181 | void autosize(); | ||
| 182 | |||
| 183 | void applySizingValues(); | ||
| 184 | |||
| 185 | //@} | ||
| 186 | protected: | ||
| 187 | /// @cond | ||
| 188 | using ImplType = detail::CoilCoolingDXMultiSpeedStageData_Impl; | ||
| 189 | |||
| 190 | explicit CoilCoolingDXMultiSpeedStageData(std::shared_ptr<detail::CoilCoolingDXMultiSpeedStageData_Impl> impl); | ||
| 191 | |||
| 192 | friend class detail::CoilCoolingDXMultiSpeedStageData_Impl; | ||
| 193 | friend class Model; | ||
| 194 | friend class IdfObject; | ||
| 195 | friend class openstudio::detail::IdfObject_Impl; | ||
| 196 | /// @endcond | ||
| 197 | private: | ||
| 198 | − | REGISTER_LOGGER("openstudio.model.CoilCoolingDXMultiSpeedStageData"); | |
| 199 | |||
| 200 | // Used to determine the index of this performance data in the | ||
| 201 | // list of stages in the parent object. | ||
| 202 | boost::optional<std::tuple<int, CoilCoolingDXMultiSpeed>> stageIndexAndParentCoil() const; | ||
| 203 | }; | ||
| 204 | |||
| 205 | /** \relates CoilCoolingDXMultiSpeedStageData*/ | ||
| 206 | using OptionalCoilCoolingDXMultiSpeedStageData = boost::optional<CoilCoolingDXMultiSpeedStageData>; | ||
| 207 | |||
| 208 | /** \relates CoilCoolingDXMultiSpeedStageData*/ | ||
| 209 | using CoilCoolingDXMultiSpeedStageDataVector = std::vector<CoilCoolingDXMultiSpeedStageData>; | ||
| 210 | |||
| 211 | } // namespace model | ||
| 212 | } // namespace openstudio | ||
| 213 | |||
| 214 | #endif // MODEL_COILCOOLINGDXMULTISPEEDSTAGEDATA_HPP | ||
| 215 |