src/model/CoilCoolingWaterToAirHeatPumpEquationFit.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_COILCOOLINGWATERTOAIRHEATPUMPEQUATIONFIT_HPP | ||
| 7 | #define MODEL_COILCOOLINGWATERTOAIRHEATPUMPEQUATIONFIT_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "WaterToAirComponent.hpp" | ||
| 11 | |||
| 12 | #include "../utilities/core/Deprecated.hpp" | ||
| 13 | |||
| 14 | namespace openstudio { | ||
| 15 | |||
| 16 | namespace model { | ||
| 17 | |||
| 18 | class Curve; | ||
| 19 | class AirflowNetworkEquivalentDuct; | ||
| 20 | |||
| 21 | namespace detail { | ||
| 22 | class CoilCoolingWaterToAirHeatPumpEquationFit_Impl; | ||
| 23 | } // namespace detail | ||
| 24 | |||
| 25 | /** CoilCoolingWaterToAirHeatPumpEquationFit is a WaterToAirComponent that wraps the OpenStudio IDD object 'OS:Coil:Cooling:WaterToAirHeatPump:EquationFit'. */ | ||
| 26 | class MODEL_API CoilCoolingWaterToAirHeatPumpEquationFit : public WaterToAirComponent | ||
| 27 | { | ||
| 28 | public: | ||
| 29 | /** @name Constructors and Destructors */ | ||
| 30 | |||
| 31 | /** Constructs a new CoilCoolingWaterToAirHeatPumpEquationFit with required curve objects */ | ||
| 32 | CoilCoolingWaterToAirHeatPumpEquationFit(const Model& model, const Curve& totalCoolingCapacityCurve, const Curve& sensibleCoolingCapacityCurve, | ||
| 33 | const Curve& coolingPowerConsumptionCurve); | ||
| 34 | |||
| 35 | /** Constructs a new CoilCoolingWaterToAirHeatPumpEquationFit object and places it inside the model. The coil is fully initialized with all companion objects. */ | ||
| 36 | CoilCoolingWaterToAirHeatPumpEquationFit(const Model& model); | ||
| 37 | |||
| 38 | 36 | virtual ~CoilCoolingWaterToAirHeatPumpEquationFit() override = default; | |
| 39 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 40 | ✗ | CoilCoolingWaterToAirHeatPumpEquationFit(const CoilCoolingWaterToAirHeatPumpEquationFit& other) = default; | |
| 41 | 4 | CoilCoolingWaterToAirHeatPumpEquationFit(CoilCoolingWaterToAirHeatPumpEquationFit&& other) = default; | |
| 42 | ✗ | CoilCoolingWaterToAirHeatPumpEquationFit& operator=(const CoilCoolingWaterToAirHeatPumpEquationFit&) = default; | |
| 43 | ✗ | CoilCoolingWaterToAirHeatPumpEquationFit& operator=(CoilCoolingWaterToAirHeatPumpEquationFit&&) = default; | |
| 44 | |||
| 45 | static IddObjectType iddObjectType(); | ||
| 46 | |||
| 47 | /** @name Getters */ | ||
| 48 | |||
| 49 | Schedule availabilitySchedule() const; | ||
| 50 | |||
| 51 | boost::optional<double> ratedAirFlowRate() const; | ||
| 52 | |||
| 53 | bool isRatedAirFlowRateDefaulted() const; | ||
| 54 | |||
| 55 | bool isRatedAirFlowRateAutosized() const; | ||
| 56 | |||
| 57 | boost::optional<double> ratedWaterFlowRate() const; | ||
| 58 | |||
| 59 | bool isRatedWaterFlowRateDefaulted() const; | ||
| 60 | |||
| 61 | bool isRatedWaterFlowRateAutosized() const; | ||
| 62 | |||
| 63 | boost::optional<double> ratedTotalCoolingCapacity() const; | ||
| 64 | |||
| 65 | bool isRatedTotalCoolingCapacityDefaulted() const; | ||
| 66 | |||
| 67 | bool isRatedTotalCoolingCapacityAutosized() const; | ||
| 68 | |||
| 69 | boost::optional<double> ratedSensibleCoolingCapacity() const; | ||
| 70 | |||
| 71 | bool isRatedSensibleCoolingCapacityDefaulted() const; | ||
| 72 | |||
| 73 | bool isRatedSensibleCoolingCapacityAutosized() const; | ||
| 74 | |||
| 75 | double ratedCoolingCoefficientofPerformance() const; | ||
| 76 | |||
| 77 | bool isRatedCoolingCoefficientofPerformanceDefaulted() const; | ||
| 78 | |||
| 79 | double ratedEnteringWaterTemperature() const; | ||
| 80 | |||
| 81 | double ratedEnteringAirDryBulbTemperature() const; | ||
| 82 | |||
| 83 | double ratedEnteringAirWetBulbTemperature() const; | ||
| 84 | |||
| 85 | Curve totalCoolingCapacityCurve() const; | ||
| 86 | |||
| 87 | OS_DEPRECATED(3, 2, 0) double totalCoolingCapacityCoefficient1() const; | ||
| 88 | OS_DEPRECATED(3, 2, 0) double totalCoolingCapacityCoefficient2() const; | ||
| 89 | OS_DEPRECATED(3, 2, 0) double totalCoolingCapacityCoefficient3() const; | ||
| 90 | OS_DEPRECATED(3, 2, 0) double totalCoolingCapacityCoefficient4() const; | ||
| 91 | OS_DEPRECATED(3, 2, 0) double totalCoolingCapacityCoefficient5() const; | ||
| 92 | |||
| 93 | Curve sensibleCoolingCapacityCurve() const; | ||
| 94 | |||
| 95 | OS_DEPRECATED(3, 2, 0) double sensibleCoolingCapacityCoefficient1() const; | ||
| 96 | OS_DEPRECATED(3, 2, 0) double sensibleCoolingCapacityCoefficient2() const; | ||
| 97 | OS_DEPRECATED(3, 2, 0) double sensibleCoolingCapacityCoefficient3() const; | ||
| 98 | OS_DEPRECATED(3, 2, 0) double sensibleCoolingCapacityCoefficient4() const; | ||
| 99 | OS_DEPRECATED(3, 2, 0) double sensibleCoolingCapacityCoefficient5() const; | ||
| 100 | OS_DEPRECATED(3, 2, 0) double sensibleCoolingCapacityCoefficient6() const; | ||
| 101 | |||
| 102 | Curve coolingPowerConsumptionCurve() const; | ||
| 103 | |||
| 104 | OS_DEPRECATED(3, 2, 0) double coolingPowerConsumptionCoefficient1() const; | ||
| 105 | OS_DEPRECATED(3, 2, 0) double coolingPowerConsumptionCoefficient2() const; | ||
| 106 | OS_DEPRECATED(3, 2, 0) double coolingPowerConsumptionCoefficient3() const; | ||
| 107 | OS_DEPRECATED(3, 2, 0) double coolingPowerConsumptionCoefficient4() const; | ||
| 108 | OS_DEPRECATED(3, 2, 0) double coolingPowerConsumptionCoefficient5() const; | ||
| 109 | |||
| 110 | Curve partLoadFractionCorrelationCurve() const; | ||
| 111 | |||
| 112 | double nominalTimeforCondensateRemovaltoBegin() const; | ||
| 113 | |||
| 114 | bool isNominalTimeforCondensateRemovaltoBeginDefaulted() const; | ||
| 115 | |||
| 116 | double ratioofInitialMoistureEvaporationRateandSteadyStateLatentCapacity() const; | ||
| 117 | |||
| 118 | bool isRatioofInitialMoistureEvaporationRateandSteadyStateLatentCapacityDefaulted() const; | ||
| 119 | |||
| 120 | double maximumCyclingRate() const; | ||
| 121 | |||
| 122 | double latentCapacityTimeConstant() const; | ||
| 123 | |||
| 124 | double fanDelayTime() const; | ||
| 125 | |||
| 126 | /** @name Setters */ | ||
| 127 | |||
| 128 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 129 | |||
| 130 | bool setRatedAirFlowRate(double ratedAirFlowRate); | ||
| 131 | |||
| 132 | void resetRatedAirFlowRate(); | ||
| 133 | |||
| 134 | void autosizeRatedAirFlowRate(); | ||
| 135 | |||
| 136 | bool setRatedWaterFlowRate(double ratedWaterFlowRate); | ||
| 137 | |||
| 138 | void resetRatedWaterFlowRate(); | ||
| 139 | |||
| 140 | void autosizeRatedWaterFlowRate(); | ||
| 141 | |||
| 142 | bool setRatedTotalCoolingCapacity(double ratedTotalCoolingCapacity); | ||
| 143 | |||
| 144 | void resetRatedTotalCoolingCapacity(); | ||
| 145 | |||
| 146 | void autosizeRatedTotalCoolingCapacity(); | ||
| 147 | |||
| 148 | bool setRatedSensibleCoolingCapacity(double ratedSensibleCoolingCapacity); | ||
| 149 | |||
| 150 | void resetRatedSensibleCoolingCapacity(); | ||
| 151 | |||
| 152 | void autosizeRatedSensibleCoolingCapacity(); | ||
| 153 | |||
| 154 | bool setRatedCoolingCoefficientofPerformance(double ratedCoolingCoefficientofPerformance); | ||
| 155 | |||
| 156 | bool setRatedEnteringWaterTemperature(double ratedEnteringAirDryBulbTemperature); | ||
| 157 | |||
| 158 | bool setRatedEnteringAirDryBulbTemperature(double ratedEnteringAirDryBulbTemperature); | ||
| 159 | |||
| 160 | bool setRatedEnteringAirWetBulbTemperature(double ratedEnteringAirWetBulbTemperature); | ||
| 161 | |||
| 162 | bool setTotalCoolingCapacityCurve(const Curve& totalCoolingCapacityCurve); | ||
| 163 | |||
| 164 | OS_DEPRECATED(3, 2, 0) bool setTotalCoolingCapacityCoefficient1(double totalCoolingCapacityCoefficient1); | ||
| 165 | OS_DEPRECATED(3, 2, 0) bool setTotalCoolingCapacityCoefficient2(double totalCoolingCapacityCoefficient2); | ||
| 166 | OS_DEPRECATED(3, 2, 0) bool setTotalCoolingCapacityCoefficient3(double totalCoolingCapacityCoefficient3); | ||
| 167 | OS_DEPRECATED(3, 2, 0) bool setTotalCoolingCapacityCoefficient4(double totalCoolingCapacityCoefficient4); | ||
| 168 | OS_DEPRECATED(3, 2, 0) bool setTotalCoolingCapacityCoefficient5(double totalCoolingCapacityCoefficient5); | ||
| 169 | |||
| 170 | bool setSensibleCoolingCapacityCurve(const Curve& sensibleCoolingCapacityCurve); | ||
| 171 | |||
| 172 | OS_DEPRECATED(3, 2, 0) bool setSensibleCoolingCapacityCoefficient1(double sensibleCoolingCapacityCoefficient1); | ||
| 173 | OS_DEPRECATED(3, 2, 0) bool setSensibleCoolingCapacityCoefficient2(double sensibleCoolingCapacityCoefficient2); | ||
| 174 | OS_DEPRECATED(3, 2, 0) bool setSensibleCoolingCapacityCoefficient3(double sensibleCoolingCapacityCoefficient3); | ||
| 175 | OS_DEPRECATED(3, 2, 0) bool setSensibleCoolingCapacityCoefficient4(double sensibleCoolingCapacityCoefficient4); | ||
| 176 | OS_DEPRECATED(3, 2, 0) bool setSensibleCoolingCapacityCoefficient5(double sensibleCoolingCapacityCoefficient5); | ||
| 177 | OS_DEPRECATED(3, 2, 0) bool setSensibleCoolingCapacityCoefficient6(double sensibleCoolingCapacityCoefficient6); | ||
| 178 | |||
| 179 | bool setCoolingPowerConsumptionCurve(const Curve& coolingPowerConsumptionCurve); | ||
| 180 | |||
| 181 | OS_DEPRECATED(3, 2, 0) bool setCoolingPowerConsumptionCoefficient1(double coolingPowerConsumptionCoefficient1); | ||
| 182 | OS_DEPRECATED(3, 2, 0) bool setCoolingPowerConsumptionCoefficient2(double coolingPowerConsumptionCoefficient2); | ||
| 183 | OS_DEPRECATED(3, 2, 0) bool setCoolingPowerConsumptionCoefficient3(double coolingPowerConsumptionCoefficient3); | ||
| 184 | OS_DEPRECATED(3, 2, 0) bool setCoolingPowerConsumptionCoefficient4(double coolingPowerConsumptionCoefficient4); | ||
| 185 | OS_DEPRECATED(3, 2, 0) bool setCoolingPowerConsumptionCoefficient5(double coolingPowerConsumptionCoefficient5); | ||
| 186 | |||
| 187 | bool setPartLoadFractionCorrelationCurve(const Curve& partLoadFractionCorrelationCurve); | ||
| 188 | |||
| 189 | bool setNominalTimeforCondensateRemovaltoBegin(double nominalTimeforCondensateRemovaltoBegin); | ||
| 190 | |||
| 191 | void resetNominalTimeforCondensateRemovaltoBegin(); | ||
| 192 | |||
| 193 | bool | ||
| 194 | setRatioofInitialMoistureEvaporationRateandSteadyStateLatentCapacity(double ratioofInitialMoistureEvaporationRateandSteadyStateLatentCapacity); | ||
| 195 | |||
| 196 | void resetRatioofInitialMoistureEvaporationRateandSteadyStateLatentCapacity(); | ||
| 197 | |||
| 198 | bool setMaximumCyclingRate(double maximumCyclingRate); | ||
| 199 | |||
| 200 | bool setLatentCapacityTimeConstant(double latentCapacityTimeConstant); | ||
| 201 | |||
| 202 | bool setFanDelayTime(double fanDelayTime); | ||
| 203 | |||
| 204 | //@} | ||
| 205 | /** @name Other */ | ||
| 206 | //@{ | ||
| 207 | |||
| 208 | /** Returns an equivalent duct object, creating a new one if an object is not already attached. */ | ||
| 209 | AirflowNetworkEquivalentDuct getAirflowNetworkEquivalentDuct(double length, double diameter); | ||
| 210 | |||
| 211 | /** Returns the attached equivalent duct object if there is one. */ | ||
| 212 | boost::optional<AirflowNetworkEquivalentDuct> airflowNetworkEquivalentDuct() const; | ||
| 213 | |||
| 214 | boost::optional<double> autosizedRatedAirFlowRate() const; | ||
| 215 | |||
| 216 | boost::optional<double> autosizedRatedWaterFlowRate() const; | ||
| 217 | |||
| 218 | boost::optional<double> autosizedRatedTotalCoolingCapacity() const; | ||
| 219 | |||
| 220 | boost::optional<double> autosizedRatedSensibleCoolingCapacity() const; | ||
| 221 | |||
| 222 | //@} | ||
| 223 | protected: | ||
| 224 | /// @cond | ||
| 225 | using ImplType = detail::CoilCoolingWaterToAirHeatPumpEquationFit_Impl; | ||
| 226 | |||
| 227 | explicit CoilCoolingWaterToAirHeatPumpEquationFit(std::shared_ptr<detail::CoilCoolingWaterToAirHeatPumpEquationFit_Impl> impl); | ||
| 228 | |||
| 229 | friend class detail::CoilCoolingWaterToAirHeatPumpEquationFit_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.CoilCoolingWaterToAirHeatPumpEquationFit"); | |
| 236 | }; | ||
| 237 | |||
| 238 | /** \relates CoilCoolingWaterToAirHeatPumpEquationFit*/ | ||
| 239 | using OptionalCoilCoolingWaterToAirHeatPumpEquationFit = boost::optional<CoilCoolingWaterToAirHeatPumpEquationFit>; | ||
| 240 | |||
| 241 | /** \relates CoilCoolingWaterToAirHeatPumpEquationFit*/ | ||
| 242 | using CoilCoolingWaterToAirHeatPumpEquationFitVector = std::vector<CoilCoolingWaterToAirHeatPumpEquationFit>; | ||
| 243 | |||
| 244 | } // namespace model | ||
| 245 | } // namespace openstudio | ||
| 246 | |||
| 247 | #endif // MODEL_COILCOOLINGWATERTOAIRHEATPUMPEQUATIONFIT_HPP | ||
| 248 |