src/model/CoilCoolingDXSingleSpeed.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_COILCOOLINGDXSINGLESPEED_HPP | ||
| 7 | #define MODEL_COILCOOLINGDXSINGLESPEED_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | |||
| 11 | #include "ModelObject.hpp" | ||
| 12 | #include "StraightComponent.hpp" | ||
| 13 | #include "Connection.hpp" | ||
| 14 | #include "../utilities/core/Deprecated.hpp" | ||
| 15 | |||
| 16 | namespace openstudio { | ||
| 17 | namespace model { | ||
| 18 | |||
| 19 | class Curve; | ||
| 20 | class Schedule; | ||
| 21 | class AirflowNetworkEquivalentDuct; | ||
| 22 | |||
| 23 | namespace detail { | ||
| 24 | class CoilCoolingDXSingleSpeed_Impl; | ||
| 25 | } // namespace detail | ||
| 26 | |||
| 27 | /** CoilCoolingDXSingleSpeed is an interface to the IDD object named | ||
| 28 | * "OS:Coil:Cooling:DX:SingleSpeed" | ||
| 29 | * | ||
| 30 | * The purpose of this class is to simplify the construction and manipulation | ||
| 31 | * OS:Coil:Cooling:DX:SingleSpeed objects in energyplus. | ||
| 32 | */ | ||
| 33 | class MODEL_API CoilCoolingDXSingleSpeed : public StraightComponent | ||
| 34 | { | ||
| 35 | public: | ||
| 36 | /** @name Constructor and Destructors */ | ||
| 37 | //@{ | ||
| 38 | |||
| 39 | /** Constructs a new CoilCoolingDXSingleSpeed object and places it inside the | ||
| 40 | * model. The object is fully initialized with all companion objects. | ||
| 41 | * | ||
| 42 | * \param model the Model that this coil will live in | ||
| 43 | * \param availabilitySchedule the schedule that goes into field:Availability Schedule Name | ||
| 44 | * \param coolingCurveFofTemp curve for field: Total Cooling Capacity Function of Temperature Curve Name | ||
| 45 | * \param coolingCurveFofFlow curve for field: Total Cooling Capacity Function of Flow Fraction Curve Name | ||
| 46 | * \param energyInputRatioFofTemp curve for field: Energy Input Ratio Function of Temperature Curve Name | ||
| 47 | * \param energyInputRatioFofFlow curve for field: Energy Input Ratio Function of Flow Fraction Curve Name | ||
| 48 | * \param partLoadFraction curve for field: Part Load Fraction Correlation Curve Name | ||
| 49 | */ | ||
| 50 | explicit CoilCoolingDXSingleSpeed(const Model& model, Schedule& availabilitySchedule, const Curve& coolingCurveFofTemp, | ||
| 51 | const Curve& coolingCurveFofFlow, const Curve& energyInputRatioFofTemp, const Curve& energyInputRatioFofFlow, | ||
| 52 | const Curve& partLoadFraction); | ||
| 53 | |||
| 54 | explicit CoilCoolingDXSingleSpeed(const Model& model); | ||
| 55 | |||
| 56 | 408 | virtual ~CoilCoolingDXSingleSpeed() override = default; | |
| 57 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 58 | ✗ | CoilCoolingDXSingleSpeed(const CoilCoolingDXSingleSpeed& other) = default; | |
| 59 | 23 | CoilCoolingDXSingleSpeed(CoilCoolingDXSingleSpeed&& other) = default; | |
| 60 | ✗ | CoilCoolingDXSingleSpeed& operator=(const CoilCoolingDXSingleSpeed&) = default; | |
| 61 | ✗ | CoilCoolingDXSingleSpeed& operator=(CoilCoolingDXSingleSpeed&&) = default; | |
| 62 | |||
| 63 | //@} | ||
| 64 | |||
| 65 | static IddObjectType iddObjectType(); | ||
| 66 | |||
| 67 | static std::vector<std::string> condenserTypeValues(); | ||
| 68 | |||
| 69 | /** @name Getters */ | ||
| 70 | //@{ | ||
| 71 | |||
| 72 | /** Returns the Schedule referred to by the AvailabilitySchedule field. **/ | ||
| 73 | Schedule availabilitySchedule() const; | ||
| 74 | |||
| 75 | /** Returns the value of the RatedCOP field. **/ | ||
| 76 | double ratedCOP() const; | ||
| 77 | |||
| 78 | /** Returns the value of the RatedEvaporatorFanPowerPerVolumeFlowRate field. **/ | ||
| 79 | OS_DEPRECATED(3, 5, 0) double ratedEvaporatorFanPowerPerVolumeFlowRate() const; | ||
| 80 | |||
| 81 | /** Returns the value of the RatedEvaporatorFanPowerPerVolumeFlowRate2017 field. **/ | ||
| 82 | double ratedEvaporatorFanPowerPerVolumeFlowRate2017() const; | ||
| 83 | |||
| 84 | /** Returns the value of the RatedEvaporatorFanPowerPerVolumeFlowRate2023 field. **/ | ||
| 85 | double ratedEvaporatorFanPowerPerVolumeFlowRate2023() const; | ||
| 86 | |||
| 87 | /** Returns the CurveBiquadratic referred to by the TotalCoolingCapacityFunctionOfTemperatureCurveName field. **/ | ||
| 88 | Curve totalCoolingCapacityFunctionOfTemperatureCurve() const; | ||
| 89 | |||
| 90 | /** Returns the CurveQuadratic referred to by the TotalCoolingCapacityFunctionOfFlowFractionCurveName field. **/ | ||
| 91 | Curve totalCoolingCapacityFunctionOfFlowFractionCurve() const; | ||
| 92 | |||
| 93 | /** Returns the CurveBiquadratic referred to by the EnergyInputRatioFunctionOfTemperatureCurveName field. **/ | ||
| 94 | Curve energyInputRatioFunctionOfTemperatureCurve() const; | ||
| 95 | |||
| 96 | /** Returns the CurveQuadratic referred to by the EnergyInputRatioFunctionOfFlowFractionCurveName field. **/ | ||
| 97 | Curve energyInputRatioFunctionOfFlowFractionCurve() const; | ||
| 98 | |||
| 99 | /** Returns the CurveQuadratic referred to by the PartLoadFractionCorrelationCurveName field. **/ | ||
| 100 | Curve partLoadFractionCorrelationCurve() const; | ||
| 101 | |||
| 102 | /** Returns the value of the NominalTimeForCondensateRemovalToBegin field. **/ | ||
| 103 | double nominalTimeForCondensateRemovalToBegin() const; | ||
| 104 | |||
| 105 | /** Returns the value of the RatioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity field. **/ | ||
| 106 | double ratioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity() const; | ||
| 107 | |||
| 108 | /** Returns the value of the MaximumCyclingRate field. **/ | ||
| 109 | double maximumCyclingRate(); | ||
| 110 | |||
| 111 | /** Returns the value of the latentCapacityTimeConstant field. **/ | ||
| 112 | double latentCapacityTimeConstant() const; | ||
| 113 | |||
| 114 | boost::optional<std::string> condenserAirInletNodeName() const; | ||
| 115 | |||
| 116 | /** Returns the value of the CondenserType field. **/ | ||
| 117 | std::string condenserType() const; | ||
| 118 | |||
| 119 | /** Returns the value of the EvaporativeCondenserEffectiveness field. **/ | ||
| 120 | double evaporativeCondenserEffectiveness() const; | ||
| 121 | |||
| 122 | /** Returns the value of the EvaporativeCondenserAirFlowRate field. | ||
| 123 | optional == false means "autosize" | ||
| 124 | **/ | ||
| 125 | boost::optional<double> evaporativeCondenserAirFlowRate() const; | ||
| 126 | |||
| 127 | /** Returns the value of the EvaporativeCondenserPumpRatedPowerConsumption field. | ||
| 128 | optional == false means "autosize" | ||
| 129 | **/ | ||
| 130 | boost::optional<double> evaporativeCondenserPumpRatedPowerConsumption() const; | ||
| 131 | |||
| 132 | /** Returns the value of the crankcaseHeaterCapacity field. **/ | ||
| 133 | double crankcaseHeaterCapacity() const; | ||
| 134 | |||
| 135 | boost::optional<Curve> crankcaseHeaterCapacityFunctionofTemperatureCurve() const; | ||
| 136 | |||
| 137 | /** Returns the value of the MaximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation field. **/ | ||
| 138 | double maximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation() const; | ||
| 139 | |||
| 140 | /** Returns the value of the BasinHeaterCapacity field. **/ | ||
| 141 | double basinHeaterCapacity() const; | ||
| 142 | |||
| 143 | /** Returns the value of the BasinHeaterSetpointTemperature field. **/ | ||
| 144 | double basinHeaterSetpointTemperature() const; | ||
| 145 | |||
| 146 | /** Returns the Schedule referred to by the BasinHeaterOperatingSchedule field. **/ | ||
| 147 | boost::optional<Schedule> basinHeaterOperatingSchedule() const; | ||
| 148 | |||
| 149 | double minimumOutdoorDryBulbTemperatureforCompressorOperation() const; | ||
| 150 | |||
| 151 | //@} | ||
| 152 | /** @name Setters */ | ||
| 153 | //@{ | ||
| 154 | |||
| 155 | /** Sets the Schedule referred to by the AvailabilitySchedule field. **/ | ||
| 156 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 157 | |||
| 158 | /** Sets the value of the RatedCOP field. **/ | ||
| 159 | bool setRatedCOP(boost::optional<double> value); | ||
| 160 | |||
| 161 | bool setRatedCOP(double value); | ||
| 162 | |||
| 163 | /** Sets the value of the RatedEvaporatorFanPowerPerVolumeFlowRate field. **/ | ||
| 164 | OS_DEPRECATED(3, 5, 0) bool setRatedEvaporatorFanPowerPerVolumeFlowRate(boost::optional<double> value); | ||
| 165 | |||
| 166 | /** Sets the value of the RatedEvaporatorFanPowerPerVolumeFlowRate2017 field. **/ | ||
| 167 | bool setRatedEvaporatorFanPowerPerVolumeFlowRate2017(boost::optional<double> value); | ||
| 168 | |||
| 169 | /** Sets the value of the RatedEvaporatorFanPowerPerVolumeFlowRate2023 field. **/ | ||
| 170 | bool setRatedEvaporatorFanPowerPerVolumeFlowRate2023(boost::optional<double> value); | ||
| 171 | |||
| 172 | OS_DEPRECATED(3, 5, 0) bool setRatedEvaporatorFanPowerPerVolumeFlowRate(double value); | ||
| 173 | |||
| 174 | bool setRatedEvaporatorFanPowerPerVolumeFlowRate2017(double value); | ||
| 175 | |||
| 176 | bool setRatedEvaporatorFanPowerPerVolumeFlowRate2023(double value); | ||
| 177 | |||
| 178 | /** Sets the CurveBiquadratic referred to by the TotalCoolingCapacityFunctionOfTemperatureCurveName field. **/ | ||
| 179 | bool setTotalCoolingCapacityFunctionOfTemperatureCurve(const Curve& curve); | ||
| 180 | |||
| 181 | /** Sets the CurveQuadratic referred to by the TotalCoolingCapacityFunctionOfFlowFractionCurnveName field. **/ | ||
| 182 | bool setTotalCoolingCapacityFunctionOfFlowFractionCurve(const Curve& curve); | ||
| 183 | |||
| 184 | /** Sets the CurveBiquadratic referred to by the EnergyInputRatioFunctionOfTemperatureCurveName field. **/ | ||
| 185 | bool setEnergyInputRatioFunctionOfTemperatureCurve(const Curve& curve); | ||
| 186 | |||
| 187 | /** Sets the CurveQuadratic referred to by the EnergyInputRatioFunctionOfFlowFractionCurveName field. **/ | ||
| 188 | bool setEnergyInputRatioFunctionOfFlowFractionCurve(const Curve& curve); | ||
| 189 | |||
| 190 | /** Sets the CurveQuadratic referred to by the PartLoadFractionCorrelationCurveName field. **/ | ||
| 191 | bool setPartLoadFractionCorrelationCurve(const Curve& curve); | ||
| 192 | |||
| 193 | /** Sets the value of the NominalTimeForCondensateRemovalToBegin field. **/ | ||
| 194 | bool setNominalTimeForCondensateRemovalToBegin(boost::optional<double> value); | ||
| 195 | |||
| 196 | bool setNominalTimeForCondensateRemovalToBegin(double value); | ||
| 197 | |||
| 198 | /** Sets the value of the RatioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity field. **/ | ||
| 199 | bool setRatioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity(boost::optional<double> value); | ||
| 200 | |||
| 201 | bool setRatioOfInitialMoistureEvaporationRateAndSteadyStateLatentCapacity(double value); | ||
| 202 | |||
| 203 | /** Sets the value of the MaximumCyclingRate field. **/ | ||
| 204 | bool setMaximumCyclingRate(boost::optional<double> value); | ||
| 205 | |||
| 206 | bool setMaximumCyclingRate(double value); | ||
| 207 | |||
| 208 | /** Sets the value of the latentCapacityTimeConstant field. **/ | ||
| 209 | bool setLatentCapacityTimeConstant(boost::optional<double> value); | ||
| 210 | |||
| 211 | bool setLatentCapacityTimeConstant(double value); | ||
| 212 | |||
| 213 | bool setCondenserAirInletNodeName(const boost::optional<std::string>&); | ||
| 214 | |||
| 215 | /** Sets the value of the CondenserType field. | ||
| 216 | * Options are AirCooled and EvaporativelyCooled. | ||
| 217 | */ | ||
| 218 | bool setCondenserType(const std::string& value); | ||
| 219 | |||
| 220 | /** Sets the value of the EvaporativeCondenserEffectiveness field. **/ | ||
| 221 | bool setEvaporativeCondenserEffectiveness(boost::optional<double> value); | ||
| 222 | |||
| 223 | bool setEvaporativeCondenserEffectiveness(double value); | ||
| 224 | |||
| 225 | bool isEvaporativeCondenserAirFlowRateAutosized() const; | ||
| 226 | |||
| 227 | /** Sets the value of the EvaporativeCondenserAirFlowRate field. | ||
| 228 | if value==false then set field to "autosize" | ||
| 229 | **/ | ||
| 230 | bool setEvaporativeCondenserAirFlowRate(boost::optional<double> value); | ||
| 231 | |||
| 232 | bool setEvaporativeCondenserAirFlowRate(double value); | ||
| 233 | |||
| 234 | void autosizeEvaporativeCondenserAirFlowRate(); | ||
| 235 | |||
| 236 | bool isEvaporativeCondenserPumpRatedPowerConsumptionAutosized() const; | ||
| 237 | |||
| 238 | /** Sets the value of the EvaporativeCondenserPumpRatedPowerConsumption field. | ||
| 239 | if value==false then set field to "autosize" | ||
| 240 | **/ | ||
| 241 | bool setEvaporativeCondenserPumpRatedPowerConsumption(boost::optional<double> value); | ||
| 242 | |||
| 243 | bool setEvaporativeCondenserPumpRatedPowerConsumption(double value); | ||
| 244 | |||
| 245 | void autosizeEvaporativeCondenserPumpRatedPowerConsumption(); | ||
| 246 | |||
| 247 | /** Sets the value of the crankcaseHeaterCapacity field. **/ | ||
| 248 | bool setCrankcaseHeaterCapacity(boost::optional<double> value); | ||
| 249 | |||
| 250 | bool setCrankcaseHeaterCapacity(double value); | ||
| 251 | |||
| 252 | bool setCrankcaseHeaterCapacityFunctionofTemperatureCurve(const Curve& curve); | ||
| 253 | void resetCrankcaseHeaterCapacityFunctionofTemperatureCurve(); | ||
| 254 | |||
| 255 | /** Sets the value of the MaximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation field. **/ | ||
| 256 | bool setMaximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation(boost::optional<double> value); | ||
| 257 | |||
| 258 | bool setMaximumOutdoorDryBulbTemperatureForCrankcaseHeaterOperation(double value); | ||
| 259 | |||
| 260 | //getSupplyWaterStorageTankName | ||
| 261 | //setSupplyWaterStorageTankName | ||
| 262 | |||
| 263 | //getCondensateCollectionWaterStorageTankName | ||
| 264 | //setCondensateCollectionWaterStorageTankName | ||
| 265 | |||
| 266 | /** Sets the value of the BasinHeaterCapacity field. **/ | ||
| 267 | bool setBasinHeaterCapacity(boost::optional<double> value); | ||
| 268 | |||
| 269 | bool setBasinHeaterCapacity(double value); | ||
| 270 | |||
| 271 | /** Sets the value of the BasinHeaterSetpointTemperature field. **/ | ||
| 272 | bool setBasinHeaterSetpointTemperature(boost::optional<double> value); | ||
| 273 | |||
| 274 | bool setBasinHeaterSetpointTemperature(double value); | ||
| 275 | |||
| 276 | /** Sets the Schedule referred to by the BasinHeaterOperatingSchedule field. **/ | ||
| 277 | bool setBasinHeaterOperatingSchedule(Schedule& schedule); | ||
| 278 | |||
| 279 | void resetBasinHeaterOperatingSchedule(); | ||
| 280 | |||
| 281 | bool setMinimumOutdoorDryBulbTemperatureforCompressorOperation(double minimumOutdoorDryBulbTemperatureforCompressorOperation); | ||
| 282 | |||
| 283 | boost::optional<double> ratedTotalCoolingCapacity() const; | ||
| 284 | |||
| 285 | bool isRatedTotalCoolingCapacityAutosized() const; | ||
| 286 | |||
| 287 | bool setRatedTotalCoolingCapacity(double ratedTotalCoolingCapacity); | ||
| 288 | |||
| 289 | void autosizeRatedTotalCoolingCapacity(); | ||
| 290 | |||
| 291 | boost::optional<double> ratedSensibleHeatRatio() const; | ||
| 292 | |||
| 293 | bool isRatedSensibleHeatRatioAutosized() const; | ||
| 294 | |||
| 295 | bool setRatedSensibleHeatRatio(double ratedSensibleHeatRatio); | ||
| 296 | |||
| 297 | void autosizeRatedSensibleHeatRatio(); | ||
| 298 | |||
| 299 | boost::optional<double> ratedAirFlowRate() const; | ||
| 300 | |||
| 301 | bool isRatedAirFlowRateAutosized() const; | ||
| 302 | |||
| 303 | bool setRatedAirFlowRate(double ratedAirFlowRate); | ||
| 304 | |||
| 305 | void autosizeRatedAirFlowRate(); | ||
| 306 | |||
| 307 | /** Returns an equivalent duct object, creating a new one if an object is not already attached. */ | ||
| 308 | AirflowNetworkEquivalentDuct getAirflowNetworkEquivalentDuct(double length, double diameter); | ||
| 309 | |||
| 310 | /** Returns the attached equivalent duct object if there is one. */ | ||
| 311 | boost::optional<AirflowNetworkEquivalentDuct> airflowNetworkEquivalentDuct() const; | ||
| 312 | |||
| 313 | // Autosizing methods | ||
| 314 | |||
| 315 | boost::optional<double> autosizedRatedAirFlowRate() const; | ||
| 316 | |||
| 317 | boost::optional<double> autosizedRatedTotalCoolingCapacity() const; | ||
| 318 | |||
| 319 | boost::optional<double> autosizedRatedSensibleHeatRatio() const; | ||
| 320 | |||
| 321 | boost::optional<double> autosizedEvaporativeCondenserAirFlowRate() const; | ||
| 322 | |||
| 323 | boost::optional<double> autosizedEvaporativeCondenserPumpRatedPowerConsumption() const; | ||
| 324 | |||
| 325 | //@} | ||
| 326 | protected: | ||
| 327 | friend class Model; | ||
| 328 | |||
| 329 | friend class openstudio::IdfObject; | ||
| 330 | |||
| 331 | /// @cond | ||
| 332 | |||
| 333 | using ImplType = detail::CoilCoolingDXSingleSpeed_Impl; | ||
| 334 | |||
| 335 | explicit CoilCoolingDXSingleSpeed(std::shared_ptr<detail::CoilCoolingDXSingleSpeed_Impl> impl); | ||
| 336 | |||
| 337 | private: | ||
| 338 | − | REGISTER_LOGGER("openstudio.model.CoilCoolingDXSingleSpeed"); | |
| 339 | |||
| 340 | /// @endcond | ||
| 341 | }; | ||
| 342 | |||
| 343 | /** \relates CoilCoolingDXSingleSpeed */ | ||
| 344 | using OptionalCoilCoolingDXSingleSpeed = boost::optional<CoilCoolingDXSingleSpeed>; | ||
| 345 | |||
| 346 | /** \relates CoilCoolingDXSingleSpeed */ | ||
| 347 | using CoilCoolingDXSingleSpeedVector = std::vector<CoilCoolingDXSingleSpeed>; | ||
| 348 | |||
| 349 | } // namespace model | ||
| 350 | } // namespace openstudio | ||
| 351 | |||
| 352 | #endif // MODEL_COILCOOLINGDXSINGLESPEED_HPP | ||
| 353 |