src/model/CoilCoolingDXTwoSpeed.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_COILCOOLINGDXTWOSPEED_HPP | ||
| 7 | #define MODEL_COILCOOLINGDXTWOSPEED_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | |||
| 11 | #include "ModelObject.hpp" | ||
| 12 | #include "StraightComponent.hpp" | ||
| 13 | #include "Connection.hpp" | ||
| 14 | |||
| 15 | namespace openstudio { | ||
| 16 | namespace model { | ||
| 17 | |||
| 18 | class Curve; | ||
| 19 | class Schedule; | ||
| 20 | class AirflowNetworkEquivalentDuct; | ||
| 21 | |||
| 22 | namespace detail { | ||
| 23 | class CoilCoolingDXTwoSpeed_Impl; | ||
| 24 | } // namespace detail | ||
| 25 | |||
| 26 | /** CoilCoolingDXTwoSpeed is an interface to the IDD object named | ||
| 27 | * "OS:Coil:Cooling:DX:SingleSpeed" | ||
| 28 | * | ||
| 29 | * The purpose of this class is to simplify the construction and manipulation | ||
| 30 | * OS:Coil:Cooling:DX:SingleSpeed objects in energyplus. | ||
| 31 | */ | ||
| 32 | class MODEL_API CoilCoolingDXTwoSpeed : public StraightComponent | ||
| 33 | { | ||
| 34 | public: | ||
| 35 | /** @name Constructors and Destructors */ | ||
| 36 | //@{ | ||
| 37 | |||
| 38 | /** Constructs a new CoilCoolingDXTwoSpeed object and places it inside the | ||
| 39 | * model. The object is fully initialized with all companion objects. | ||
| 40 | * | ||
| 41 | * \param model the Model that this coil will live in | ||
| 42 | * \param availabilitySchedule the schedule that goes into field:Availability Schedule Name | ||
| 43 | * \param coolingCurveFofTemp curve for field: Total Cooling Capacity Function of Temperature Curve Name | ||
| 44 | * \param coolingCurveFofFlow curve for field: Total Cooling Capacity Function of Flow Fraction Curve Name | ||
| 45 | * \param energyInputRatioFofTemp curve for field: Energy Input Ratio Function of Temperature Curve Name | ||
| 46 | * \param energyInputRatioFofFlow curve for field: Energy Input Ratio Function of Flow Fraction Curve Name | ||
| 47 | * \param partLoadFraction curve for field: Part Load Fraction Correlation Curve Name | ||
| 48 | * \param lowSpeedCoolingCurveFofTemp curve for field: Low Speed Total Cooling Capacity Function of Temperature Curve Name | ||
| 49 | * \param lowSpeedEnergyInputRatioFofTemp curve for field: Low Speed Energy Input Ratio Function of Temperature Curve Name | ||
| 50 | */ | ||
| 51 | CoilCoolingDXTwoSpeed(const Model& model, Schedule& availabilitySchedule, const Curve& coolingCurveFofTemp, const Curve& coolingCurveFofFlow, | ||
| 52 | const Curve& energyInputRatioFofTemp, const Curve& energyInputRatioFofFlow, const Curve& partLoadFraction, | ||
| 53 | const Curve& lowSpeedCoolingCurveFofTemp, const Curve& lowSpeedEnergyInputRatioFofTemp); | ||
| 54 | |||
| 55 | CoilCoolingDXTwoSpeed(const Model& model); | ||
| 56 | |||
| 57 | 31 | virtual ~CoilCoolingDXTwoSpeed() override = default; | |
| 58 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 59 | ✗ | CoilCoolingDXTwoSpeed(const CoilCoolingDXTwoSpeed& other) = default; | |
| 60 | ✗ | CoilCoolingDXTwoSpeed(CoilCoolingDXTwoSpeed&& other) = default; | |
| 61 | ✗ | CoilCoolingDXTwoSpeed& operator=(const CoilCoolingDXTwoSpeed&) = default; | |
| 62 | ✗ | CoilCoolingDXTwoSpeed& operator=(CoilCoolingDXTwoSpeed&&) = default; | |
| 63 | |||
| 64 | //@} | ||
| 65 | |||
| 66 | static IddObjectType iddObjectType(); | ||
| 67 | |||
| 68 | /** @name Getters */ | ||
| 69 | //@{ | ||
| 70 | |||
| 71 | /** Returns the Schedule referred to by the AvailabilitySchedule field. **/ | ||
| 72 | Schedule availabilitySchedule() const; | ||
| 73 | |||
| 74 | /** Returns the value of the RatedHighSpeedTotalCoolingCapacity field. | ||
| 75 | * Optional == false means "Autocalculate" */ | ||
| 76 | boost::optional<double> ratedHighSpeedTotalCoolingCapacity() const; | ||
| 77 | |||
| 78 | /** Returns the value of the RatedHighSpeedSensibleHeatRatio field. | ||
| 79 | * Optional == false means "Autocalculate" */ | ||
| 80 | boost::optional<double> ratedHighSpeedSensibleHeatRatio() const; | ||
| 81 | |||
| 82 | /** Returns the value of the RatedHighSpeedCOP field. **/ | ||
| 83 | double ratedHighSpeedCOP() const; | ||
| 84 | |||
| 85 | /** Returns the value of the RatedHighSpeedAirFlowRate field. | ||
| 86 | * Optional == false means "Autocalculate" */ | ||
| 87 | boost::optional<double> ratedHighSpeedAirFlowRate() const; | ||
| 88 | |||
| 89 | double ratedHighSpeedEvaporatorFanPowerPerVolumeFlowRate2017() const; | ||
| 90 | |||
| 91 | double ratedHighSpeedEvaporatorFanPowerPerVolumeFlowRate2023() const; | ||
| 92 | |||
| 93 | /** Returns the Curve referred to by the | ||
| 94 | * TotalCoolingCapacityFunctionOfTemperatureCurveName field. */ | ||
| 95 | Curve totalCoolingCapacityFunctionOfTemperatureCurve() const; | ||
| 96 | |||
| 97 | /** Returns the Curve referred to by the | ||
| 98 | * TotalCoolingCapacityFunctionOfFlowFractionCurveName field. */ | ||
| 99 | Curve totalCoolingCapacityFunctionOfFlowFractionCurve() const; | ||
| 100 | |||
| 101 | /** Returns the Curve referred to by the | ||
| 102 | * EnergyInputRatioFunctionOfTemperatureCurveName field. */ | ||
| 103 | Curve energyInputRatioFunctionOfTemperatureCurve() const; | ||
| 104 | |||
| 105 | /** Returns the Curve referred to by the | ||
| 106 | * EnergyInputRatioFunctionOfFlowFractionCurveName field. */ | ||
| 107 | Curve energyInputRatioFunctionOfFlowFractionCurve() const; | ||
| 108 | |||
| 109 | /** Returns the Curve referred to by the PartLoadFractionCorrelationCurveName | ||
| 110 | * field. **/ | ||
| 111 | Curve partLoadFractionCorrelationCurve() const; | ||
| 112 | |||
| 113 | /** Returns the value of the RatedLowSpeedTotalCoolingCapacity field. | ||
| 114 | * Optional == false means "Autocalculate" */ | ||
| 115 | boost::optional<double> ratedLowSpeedTotalCoolingCapacity() const; | ||
| 116 | |||
| 117 | /** Returns the value of the RatedLowSpeedSensibleHeatRatio field. | ||
| 118 | * Optional == false means "Autocalculate" */ | ||
| 119 | boost::optional<double> ratedLowSpeedSensibleHeatRatio() const; | ||
| 120 | |||
| 121 | /** Returns the value of the RatedLowSpeedCOP field. */ | ||
| 122 | double ratedLowSpeedCOP() const; | ||
| 123 | |||
| 124 | /** Returns the value of the RatedLowSpeedAirFlowRate field. | ||
| 125 | * Optional == false means "Autocalculate" */ | ||
| 126 | boost::optional<double> ratedLowSpeedAirFlowRate() const; | ||
| 127 | |||
| 128 | double ratedLowSpeedEvaporatorFanPowerPerVolumeFlowRate2017() const; | ||
| 129 | |||
| 130 | double ratedLowSpeedEvaporatorFanPowerPerVolumeFlowRate2023() const; | ||
| 131 | |||
| 132 | /** Returns the Curve referred to by the | ||
| 133 | * TotalCoolingCapacityFunctionOfTemperatureCurveName field. */ | ||
| 134 | Curve lowSpeedTotalCoolingCapacityFunctionOfTemperatureCurve() const; | ||
| 135 | |||
| 136 | /** Returns the Curve referred to by the | ||
| 137 | * LowSpeedEnergyInputRatioFunctionOfTemperatureCurveName field. */ | ||
| 138 | Curve lowSpeedEnergyInputRatioFunctionOfTemperatureCurve() const; | ||
| 139 | |||
| 140 | boost::optional<std::string> condenserAirInletNodeName() const; | ||
| 141 | |||
| 142 | /** Returns the value of the CondenserType field. */ | ||
| 143 | std::string condenserType() const; | ||
| 144 | |||
| 145 | /** Returns the value of the HighSpeedEvaporativeCondenserEffectiveness field. */ | ||
| 146 | double highSpeedEvaporativeCondenserEffectiveness() const; | ||
| 147 | |||
| 148 | /** Returns the value of the HighSpeedEvaporativeCondenserAirFlowRate field. | ||
| 149 | * optional == flase means "autosize" */ | ||
| 150 | boost::optional<double> highSpeedEvaporativeCondenserAirFlowRate() const; | ||
| 151 | |||
| 152 | /** Returns the value of the HighSpeedEvaporativeCondenserPumpRatedPowerConsumption field. | ||
| 153 | * optional == flase means "autosize" */ | ||
| 154 | boost::optional<double> highSpeedEvaporativeCondenserPumpRatedPowerConsumption() const; | ||
| 155 | |||
| 156 | /** Returns the value of the LowSpeedEvaporativeCondenserEffectiveness field. */ | ||
| 157 | double lowSpeedEvaporativeCondenserEffectiveness() const; | ||
| 158 | |||
| 159 | /** Returns the value of the LowSpeedEvaporativeCondenserAirFlowRate field. | ||
| 160 | * optional == flase means "autosize" */ | ||
| 161 | boost::optional<double> lowSpeedEvaporativeCondenserAirFlowRate() const; | ||
| 162 | |||
| 163 | /** Returns the value of the LowSpeedEvaporativeCondenserPumpRatedPowerConsumption field. | ||
| 164 | * optional == flase means "autosize" */ | ||
| 165 | boost::optional<double> lowSpeedEvaporativeCondenserPumpRatedPowerConsumption() const; | ||
| 166 | |||
| 167 | /** Returns the value of the BasinHeaterCapacity field. **/ | ||
| 168 | double basinHeaterCapacity() const; | ||
| 169 | |||
| 170 | /** Returns the value of the BasinHeaterSetpointTemperature field. **/ | ||
| 171 | double basinHeaterSetpointTemperature() const; | ||
| 172 | |||
| 173 | /** Returns the Schedule referred to by the BasinHeaterOperatingSchedule field. **/ | ||
| 174 | boost::optional<Schedule> basinHeaterOperatingSchedule() const; | ||
| 175 | |||
| 176 | double minimumOutdoorDryBulbTemperatureforCompressorOperation() const; | ||
| 177 | |||
| 178 | double unitInternalStaticAirPressure() const; | ||
| 179 | |||
| 180 | //@} | ||
| 181 | /** @name Setters */ | ||
| 182 | //@{ | ||
| 183 | |||
| 184 | /** Sets the Schedule referred to by the AvailabilitySchedule field. **/ | ||
| 185 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 186 | |||
| 187 | /** Sets the value of the RatedHighSpeedTotalCoolingCapacity field. | ||
| 188 | If optional is false, field is set to autocalculate | ||
| 189 | **/ | ||
| 190 | bool setRatedHighSpeedTotalCoolingCapacity(boost::optional<double> value); | ||
| 191 | |||
| 192 | bool setRatedHighSpeedTotalCoolingCapacity(double value); | ||
| 193 | |||
| 194 | /** Sets the value of the RatedHighSpeedSensibleHeatRatio field. | ||
| 195 | * If optional is false, field is set to autocalculate */ | ||
| 196 | bool setRatedHighSpeedSensibleHeatRatio(boost::optional<double> value); | ||
| 197 | |||
| 198 | bool setRatedHighSpeedSensibleHeatRatio(double value); | ||
| 199 | |||
| 200 | /** Sets the value of the RatedHighSpeedCOP field. **/ | ||
| 201 | bool setRatedHighSpeedCOP(double value); | ||
| 202 | |||
| 203 | /** Sets the value of the RatedHighSpeedAirFlowRate field. | ||
| 204 | * If optional is false, field is set to autocalculate */ | ||
| 205 | bool setRatedHighSpeedAirFlowRate(boost::optional<double> value); | ||
| 206 | |||
| 207 | bool setRatedHighSpeedAirFlowRate(double value); | ||
| 208 | |||
| 209 | bool setRatedHighSpeedEvaporatorFanPowerPerVolumeFlowRate2017(double ratedHighSpeedEvaporatorFanPowerPerVolumeFlowRate2017); | ||
| 210 | |||
| 211 | bool setRatedHighSpeedEvaporatorFanPowerPerVolumeFlowRate2023(double ratedHighSpeedEvaporatorFanPowerPerVolumeFlowRate2023); | ||
| 212 | |||
| 213 | /** Sets the Curve referred to by the | ||
| 214 | * TotalCoolingCapacityFunctionOfTemperatureCurveName field. **/ | ||
| 215 | bool setTotalCoolingCapacityFunctionOfTemperatureCurve(const Curve& curve); | ||
| 216 | |||
| 217 | /** Sets the Curve referred to by the TotalCoolingCapacityFunctionOfFlowFractionCurnveName field. **/ | ||
| 218 | bool setTotalCoolingCapacityFunctionOfFlowFractionCurve(const Curve& curve); | ||
| 219 | |||
| 220 | /** Sets the Curve referred to by the EnergyInputRatioFunctionOfTemperatureCurveName field. **/ | ||
| 221 | bool setEnergyInputRatioFunctionOfTemperatureCurve(const Curve& curve); | ||
| 222 | |||
| 223 | /** Sets the Curve referred to by the EnergyInputRatioFunctionOfFlowFractionCurveName field. **/ | ||
| 224 | bool setEnergyInputRatioFunctionOfFlowFractionCurve(const Curve& curve); | ||
| 225 | |||
| 226 | /** Sets the Curve referred to by the PartLoadFractionCorrelationCurveName field. **/ | ||
| 227 | bool setPartLoadFractionCorrelationCurve(const Curve& curve); | ||
| 228 | |||
| 229 | /** Sets the value of the RatedLowSpeedTotalCoolingCapacity field. | ||
| 230 | * If optional is false, field is set to autocalculate */ | ||
| 231 | bool setRatedLowSpeedTotalCoolingCapacity(boost::optional<double> value); | ||
| 232 | |||
| 233 | bool setRatedLowSpeedTotalCoolingCapacity(double value); | ||
| 234 | |||
| 235 | /** Sets the value of the RatedLowSpeedSensibleHeatRatio field. | ||
| 236 | If optional is false, field is set to autocalculate | ||
| 237 | **/ | ||
| 238 | bool setRatedLowSpeedSensibleHeatRatio(boost::optional<double> value); | ||
| 239 | |||
| 240 | bool setRatedLowSpeedSensibleHeatRatio(double value); | ||
| 241 | |||
| 242 | /** Sets the value of the RatedLowSpeedCOP field. **/ | ||
| 243 | bool setRatedLowSpeedCOP(double value); | ||
| 244 | |||
| 245 | /** Sets the value of the RatedLowSpeedAirFlowRate field. | ||
| 246 | * If optional is false, field is set to autocalculate */ | ||
| 247 | bool setRatedLowSpeedAirFlowRate(boost::optional<double> value); | ||
| 248 | |||
| 249 | bool setRatedLowSpeedAirFlowRate(double value); | ||
| 250 | |||
| 251 | bool setRatedLowSpeedEvaporatorFanPowerPerVolumeFlowRate2017(double ratedLowSpeedEvaporatorFanPowerPerVolumeFlowRate2017); | ||
| 252 | |||
| 253 | bool setRatedLowSpeedEvaporatorFanPowerPerVolumeFlowRate2023(double ratedLowSpeedEvaporatorFanPowerPerVolumeFlowRate2023); | ||
| 254 | |||
| 255 | /** Sets the Curve referred to by the LowSpeedTotalCoolingCapacityFunctionOfTemperatureCurveName field. */ | ||
| 256 | bool setLowSpeedTotalCoolingCapacityFunctionOfTemperatureCurve(const Curve& curve); | ||
| 257 | |||
| 258 | /** Sets the Curve referred to by the LowSpeedEnergyInputRatioFunctionOfTemperatureCurveName field. */ | ||
| 259 | bool setLowSpeedEnergyInputRatioFunctionOfTemperatureCurve(const Curve& curve); | ||
| 260 | |||
| 261 | bool setCondenserAirInletNodeName(const std::string&); | ||
| 262 | |||
| 263 | /** Sets the value of the CondenserType field. | ||
| 264 | * Options are AirCooled and EvaporativelyCooled. */ | ||
| 265 | bool setCondenserType(const std::string& value); | ||
| 266 | |||
| 267 | /** Sets the value of the HighSpeedEvaporativeCondenserEffectiveness field. */ | ||
| 268 | bool setHighSpeedEvaporativeCondenserEffectiveness(double value); | ||
| 269 | |||
| 270 | /** Sets the value of the HighSpeedEvaporativeCondenserAirFlowRate field. | ||
| 271 | * if value==false then set field to "autosize" */ | ||
| 272 | bool setHighSpeedEvaporativeCondenserAirFlowRate(boost::optional<double> value); | ||
| 273 | |||
| 274 | bool setHighSpeedEvaporativeCondenserAirFlowRate(double value); | ||
| 275 | |||
| 276 | /** Sets the value of the HighSpeedEvaporativeCondenserPumpRatedPowerConsumption field. | ||
| 277 | * if value==false then set field to "autosize" */ | ||
| 278 | bool setHighSpeedEvaporativeCondenserPumpRatedPowerConsumption(boost::optional<double> value); | ||
| 279 | |||
| 280 | bool setHighSpeedEvaporativeCondenserPumpRatedPowerConsumption(double value); | ||
| 281 | |||
| 282 | /** Sets the value of the LowSpeedEvaporativeCondenserEffectiveness field. */ | ||
| 283 | bool setLowSpeedEvaporativeCondenserEffectiveness(double value); | ||
| 284 | |||
| 285 | /** Sets the value of the LowSpeedEvaporativeCondenserAirFlowRate field. | ||
| 286 | * if value==false then set field to "autosize" */ | ||
| 287 | bool setLowSpeedEvaporativeCondenserAirFlowRate(boost::optional<double> value); | ||
| 288 | |||
| 289 | bool setLowSpeedEvaporativeCondenserAirFlowRate(double value); | ||
| 290 | |||
| 291 | /** Sets the value of the LowSpeedEvaporativeCondenserPumpRatedPowerConsumption field. | ||
| 292 | * if value==false then set field to "autosize" */ | ||
| 293 | bool setLowSpeedEvaporativeCondenserPumpRatedPowerConsumption(boost::optional<double> value); | ||
| 294 | |||
| 295 | bool setLowSpeedEvaporativeCondenserPumpRatedPowerConsumption(double value); | ||
| 296 | |||
| 297 | //supplyWaterStorageTankName | ||
| 298 | //setSupplyWaterStorageTankName | ||
| 299 | |||
| 300 | //condensateCollectionWaterStorageTankName | ||
| 301 | //setCondensateCollectionWaterStorageTankName | ||
| 302 | |||
| 303 | /** Sets the value of the BasinHeaterCapacity field. **/ | ||
| 304 | bool setBasinHeaterCapacity(double value); | ||
| 305 | |||
| 306 | /** Sets the value of the BasinHeaterSetpointTemperature field. **/ | ||
| 307 | bool setBasinHeaterSetpointTemperature(double value); | ||
| 308 | |||
| 309 | /** Sets the Schedule referred to by the BasinHeaterOperatingSchedule field. **/ | ||
| 310 | bool setBasinHeaterOperatingSchedule(Schedule& schedule); | ||
| 311 | |||
| 312 | void resetBasinHeaterOperatingSchedule(); | ||
| 313 | |||
| 314 | bool setMinimumOutdoorDryBulbTemperatureforCompressorOperation(double minimumOutdoorDryBulbTemperatureforCompressorOperation); | ||
| 315 | |||
| 316 | bool setUnitInternalStaticAirPressure(double unitInternalStaticAirPressure); | ||
| 317 | |||
| 318 | //@} | ||
| 319 | /** @name Other */ | ||
| 320 | //@{ | ||
| 321 | |||
| 322 | /** Returns an equivalent duct object, creating a new one if an object is not already attached. */ | ||
| 323 | AirflowNetworkEquivalentDuct getAirflowNetworkEquivalentDuct(double length, double diameter); | ||
| 324 | |||
| 325 | /** Returns the attached equivalent duct object if there is one. */ | ||
| 326 | boost::optional<AirflowNetworkEquivalentDuct> airflowNetworkEquivalentDuct() const; | ||
| 327 | |||
| 328 | boost::optional<double> autosizedRatedHighSpeedTotalCoolingCapacity() const; | ||
| 329 | |||
| 330 | boost::optional<double> autosizedRatedHighSpeedSensibleHeatRatio() const; | ||
| 331 | |||
| 332 | boost::optional<double> autosizedRatedHighSpeedAirFlowRate() const; | ||
| 333 | |||
| 334 | boost::optional<double> autosizedRatedLowSpeedTotalCoolingCapacity() const; | ||
| 335 | |||
| 336 | boost::optional<double> autosizedRatedLowSpeedSensibleHeatRatio() const; | ||
| 337 | |||
| 338 | boost::optional<double> autosizedRatedLowSpeedAirFlowRate() const; | ||
| 339 | |||
| 340 | boost::optional<double> autosizedHighSpeedEvaporativeCondenserAirFlowRate() const; | ||
| 341 | |||
| 342 | boost::optional<double> autosizedHighSpeedEvaporativeCondenserPumpRatedPowerConsumption() const; | ||
| 343 | |||
| 344 | boost::optional<double> autosizedLowSpeedEvaporativeCondenserAirFlowRate() const; | ||
| 345 | |||
| 346 | boost::optional<double> autosizedLowSpeedEvaporativeCondenserPumpRatedPowerConsumption() const; | ||
| 347 | |||
| 348 | //@} | ||
| 349 | protected: | ||
| 350 | friend class Model; | ||
| 351 | friend class openstudio::IdfObject; | ||
| 352 | |||
| 353 | /// @cond | ||
| 354 | using ImplType = detail::CoilCoolingDXTwoSpeed_Impl; | ||
| 355 | |||
| 356 | explicit CoilCoolingDXTwoSpeed(std::shared_ptr<detail::CoilCoolingDXTwoSpeed_Impl> impl); | ||
| 357 | |||
| 358 | private: | ||
| 359 | − | REGISTER_LOGGER("openstudio.model.CoilCoolingDXTwoSpeed"); | |
| 360 | /// @endcond | ||
| 361 | }; | ||
| 362 | |||
| 363 | /** \relates CoilCoolingDXTwoSpeed */ | ||
| 364 | using OptionalCoilCoolingDXTwoSpeed = boost::optional<CoilCoolingDXTwoSpeed>; | ||
| 365 | |||
| 366 | /** \relates CoilCoolingDXTwoSpeed */ | ||
| 367 | using CoilCoolingDXTwoSpeedVector = std::vector<CoilCoolingDXTwoSpeed>; | ||
| 368 | |||
| 369 | } // namespace model | ||
| 370 | } // namespace openstudio | ||
| 371 | |||
| 372 | #endif // MODEL_COILCOOLINGDXTWOSPEED_HPP | ||
| 373 |