src/model/CoilPerformanceDXCooling.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_COILPERFORMANCEDXCOOLING_HPP | ||
| 7 | #define MODEL_COILPERFORMANCEDXCOOLING_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "ParentObject.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Curve; | ||
| 17 | class Node; | ||
| 18 | |||
| 19 | namespace detail { | ||
| 20 | |||
| 21 | class CoilPerformanceDXCooling_Impl; | ||
| 22 | |||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** CoilPerformanceDXCooling is a ModelObject that wraps the OpenStudio IDD object 'OS:CoilPerformance:DX:Cooling'. */ | ||
| 26 | class MODEL_API CoilPerformanceDXCooling : public ParentObject | ||
| 27 | { | ||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | //@{ | ||
| 31 | |||
| 32 | explicit CoilPerformanceDXCooling(const Model& model); | ||
| 33 | |||
| 34 | explicit CoilPerformanceDXCooling(const Model& model, const Curve& coolingCapacityFunctionofTemperature, | ||
| 35 | const Curve& coolingCapacityFunctionofFlowFraction, const Curve& energyInputRatioFunctionofTemperature, | ||
| 36 | const Curve& energyInputRatioFunctionofFlowFraction, const Curve& partLoadFractionCorrelation); | ||
| 37 | |||
| 38 | 308 | virtual ~CoilPerformanceDXCooling() override = default; | |
| 39 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 40 | 36 | CoilPerformanceDXCooling(const CoilPerformanceDXCooling& other) = default; | |
| 41 | 140 | CoilPerformanceDXCooling(CoilPerformanceDXCooling&& other) = default; | |
| 42 | ✗ | CoilPerformanceDXCooling& operator=(const CoilPerformanceDXCooling&) = default; | |
| 43 | ✗ | CoilPerformanceDXCooling& operator=(CoilPerformanceDXCooling&&) = default; | |
| 44 | |||
| 45 | //@} | ||
| 46 | |||
| 47 | static IddObjectType iddObjectType(); | ||
| 48 | |||
| 49 | static std::vector<std::string> condenserTypeValues(); | ||
| 50 | |||
| 51 | /** @name Getters */ | ||
| 52 | //@{ | ||
| 53 | |||
| 54 | boost::optional<double> grossRatedTotalCoolingCapacity() const; | ||
| 55 | |||
| 56 | bool isGrossRatedTotalCoolingCapacityAutosized() const; | ||
| 57 | |||
| 58 | boost::optional<double> grossRatedSensibleHeatRatio() const; | ||
| 59 | |||
| 60 | bool isGrossRatedSensibleHeatRatioAutosized() const; | ||
| 61 | |||
| 62 | double grossRatedCoolingCOP() const; | ||
| 63 | |||
| 64 | boost::optional<double> ratedAirFlowRate() const; | ||
| 65 | |||
| 66 | bool isRatedAirFlowRateAutosized() const; | ||
| 67 | |||
| 68 | double fractionofAirFlowBypassedAroundCoil() const; | ||
| 69 | |||
| 70 | Curve totalCoolingCapacityFunctionofTemperatureCurve() const; | ||
| 71 | |||
| 72 | Curve totalCoolingCapacityFunctionofFlowFractionCurve() const; | ||
| 73 | |||
| 74 | Curve energyInputRatioFunctionofTemperatureCurve() const; | ||
| 75 | |||
| 76 | Curve energyInputRatioFunctionofFlowFractionCurve() const; | ||
| 77 | |||
| 78 | Curve partLoadFractionCorrelationCurve() const; | ||
| 79 | |||
| 80 | double nominalTimeforCondensateRemovaltoBegin() const; | ||
| 81 | |||
| 82 | double ratioofInitialMoistureEvaporationRateandSteadyStateLatentCapacity() const; | ||
| 83 | |||
| 84 | double maximumCyclingRate() const; | ||
| 85 | |||
| 86 | double latentCapacityTimeConstant() const; | ||
| 87 | |||
| 88 | boost::optional<Node> condenserAirInletNode() const; | ||
| 89 | |||
| 90 | std::string condenserType() const; | ||
| 91 | |||
| 92 | double evaporativeCondenserEffectiveness() const; | ||
| 93 | |||
| 94 | boost::optional<double> evaporativeCondenserAirFlowRate() const; | ||
| 95 | |||
| 96 | bool isEvaporativeCondenserAirFlowRateAutosized() const; | ||
| 97 | |||
| 98 | boost::optional<double> evaporativeCondenserPumpRatedPowerConsumption() const; | ||
| 99 | |||
| 100 | bool isEvaporativeCondenserPumpRatedPowerConsumptionAutosized() const; | ||
| 101 | |||
| 102 | boost::optional<Curve> sensibleHeatRatioFunctionofTemperatureCurve() const; | ||
| 103 | |||
| 104 | boost::optional<Curve> sensibleHeatRatioFunctionofFlowFractionCurve() const; | ||
| 105 | |||
| 106 | //@} | ||
| 107 | /** @name Setters */ | ||
| 108 | //@{ | ||
| 109 | |||
| 110 | bool setGrossRatedTotalCoolingCapacity(double grossRatedTotalCoolingCapacity); | ||
| 111 | |||
| 112 | void autosizeGrossRatedTotalCoolingCapacity(); | ||
| 113 | |||
| 114 | bool setGrossRatedSensibleHeatRatio(double grossRatedSensibleHeatRatio); | ||
| 115 | |||
| 116 | void autosizeGrossRatedSensibleHeatRatio(); | ||
| 117 | |||
| 118 | bool setGrossRatedCoolingCOP(double grossRatedCoolingCOP); | ||
| 119 | |||
| 120 | bool setRatedAirFlowRate(double ratedAirFlowRate); | ||
| 121 | |||
| 122 | void autosizeRatedAirFlowRate(); | ||
| 123 | |||
| 124 | bool setFractionofAirFlowBypassedAroundCoil(double fractionofAirFlowBypassedAroundCoil); | ||
| 125 | |||
| 126 | bool setTotalCoolingCapacityFunctionofTemperatureCurve(const Curve& curve); | ||
| 127 | |||
| 128 | bool setTotalCoolingCapacityFunctionofFlowFractionCurve(const Curve& curve); | ||
| 129 | |||
| 130 | bool setEnergyInputRatioFunctionofTemperatureCurve(const Curve& curve); | ||
| 131 | |||
| 132 | bool setEnergyInputRatioFunctionofFlowFractionCurve(const Curve& curve); | ||
| 133 | |||
| 134 | bool setPartLoadFractionCorrelationCurve(const Curve& curve); | ||
| 135 | |||
| 136 | bool setNominalTimeforCondensateRemovaltoBegin(double nominalTimeforCondensateRemovaltoBegin); | ||
| 137 | |||
| 138 | bool | ||
| 139 | setRatioofInitialMoistureEvaporationRateandSteadyStateLatentCapacity(double ratioofInitialMoistureEvaporationRateandSteadyStateLatentCapacity); | ||
| 140 | |||
| 141 | bool setMaximumCyclingRate(double maximumCyclingRate); | ||
| 142 | |||
| 143 | bool setLatentCapacityTimeConstant(double latentCapacityTimeConstant); | ||
| 144 | |||
| 145 | bool setCondenserAirInletNode(const Node& node); | ||
| 146 | |||
| 147 | void resetCondenserAirInletNode(); | ||
| 148 | |||
| 149 | bool setCondenserType(const std::string& condenserType); | ||
| 150 | |||
| 151 | bool setEvaporativeCondenserEffectiveness(double evaporativeCondenserEffectiveness); | ||
| 152 | |||
| 153 | bool setEvaporativeCondenserAirFlowRate(double evaporativeCondenserAirFlowRate); | ||
| 154 | |||
| 155 | void autosizeEvaporativeCondenserAirFlowRate(); | ||
| 156 | |||
| 157 | bool setEvaporativeCondenserPumpRatedPowerConsumption(double evaporativeCondenserPumpRatedPowerConsumption); | ||
| 158 | |||
| 159 | void autosizeEvaporativeCondenserPumpRatedPowerConsumption(); | ||
| 160 | |||
| 161 | bool setSensibleHeatRatioFunctionofTemperatureCurve(const Curve& curve); | ||
| 162 | |||
| 163 | void resetSensibleHeatRatioFunctionofTemperatureCurve(); | ||
| 164 | |||
| 165 | bool setSensibleHeatRatioFunctionofFlowFractionCurve(const Curve& curve); | ||
| 166 | |||
| 167 | void resetSensibleHeatRatioFunctionofFlowFractionCurve(); | ||
| 168 | |||
| 169 | //@} | ||
| 170 | /** @name Other */ | ||
| 171 | //@{ | ||
| 172 | |||
| 173 | boost::optional<double> autosizedGrossRatedTotalCoolingCapacity() const; | ||
| 174 | |||
| 175 | boost::optional<double> autosizedGrossRatedSensibleHeatRatio() const; | ||
| 176 | |||
| 177 | boost::optional<double> autosizedRatedAirFlowRate() const; | ||
| 178 | |||
| 179 | boost::optional<double> autosizedEvaporativeCondenserAirFlowRate() const; | ||
| 180 | |||
| 181 | boost::optional<double> autosizedEvaporativeCondenserPumpRatedPowerConsumption() const; | ||
| 182 | |||
| 183 | void autosize(); | ||
| 184 | |||
| 185 | void applySizingValues(); | ||
| 186 | |||
| 187 | //@} | ||
| 188 | protected: | ||
| 189 | /// @cond | ||
| 190 | using ImplType = detail::CoilPerformanceDXCooling_Impl; | ||
| 191 | |||
| 192 | explicit CoilPerformanceDXCooling(std::shared_ptr<detail::CoilPerformanceDXCooling_Impl> impl); | ||
| 193 | |||
| 194 | friend class detail::CoilPerformanceDXCooling_Impl; | ||
| 195 | friend class Model; | ||
| 196 | friend class IdfObject; | ||
| 197 | friend class openstudio::detail::IdfObject_Impl; | ||
| 198 | /// @endcond | ||
| 199 | private: | ||
| 200 | REGISTER_LOGGER("openstudio.model.CoilPerformanceDXCooling"); | ||
| 201 | }; | ||
| 202 | |||
| 203 | /** \relates CoilPerformanceDXCooling*/ | ||
| 204 | using OptionalCoilPerformanceDXCooling = boost::optional<CoilPerformanceDXCooling>; | ||
| 205 | |||
| 206 | /** \relates CoilPerformanceDXCooling*/ | ||
| 207 | using CoilPerformanceDXCoolingVector = std::vector<CoilPerformanceDXCooling>; | ||
| 208 | |||
| 209 | } // namespace model | ||
| 210 | } // namespace openstudio | ||
| 211 | |||
| 212 | #endif // MODEL_COILPERFORMANCEDXCOOLING_HPP | ||
| 213 |