src/model/CoilWaterHeatingAirToWaterHeatPump.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_COILWATERHEATINGAIRTOWATERHEATPUMP_HPP | ||
| 7 | #define MODEL_COILWATERHEATINGAIRTOWATERHEATPUMP_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "HVACComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | |||
| 14 | namespace model { | ||
| 15 | |||
| 16 | class Curve; | ||
| 17 | |||
| 18 | namespace detail { | ||
| 19 | |||
| 20 | class CoilWaterHeatingAirToWaterHeatPump_Impl; | ||
| 21 | |||
| 22 | } // namespace detail | ||
| 23 | |||
| 24 | /** CoilWaterHeatingAirToWaterHeatPump is a ModelObject that wraps the OpenStudio IDD object 'OS:Coil:WaterHeating:AirToWaterHeatPump'. | ||
| 25 | * As of EnergyPlus version 8.4.0 this object maps to Coil:WaterHeating:AirToWaterHeatPump:Pumped in idf format. | ||
| 26 | */ | ||
| 27 | class MODEL_API CoilWaterHeatingAirToWaterHeatPump : public HVACComponent | ||
| 28 | { | ||
| 29 | public: | ||
| 30 | /** @name Constructors and Destructors */ | ||
| 31 | //@{ | ||
| 32 | |||
| 33 | explicit CoilWaterHeatingAirToWaterHeatPump(const Model& model); | ||
| 34 | |||
| 35 | explicit CoilWaterHeatingAirToWaterHeatPump(const Model& model, Curve& heatingCapacityFunctionofTemperatureCurve, | ||
| 36 | Curve& heatingCapacityFunctionofAirFlowFractionCurve, | ||
| 37 | Curve& heatingCapacityFunctionofWaterFlowFractionCurve, Curve& heatingCOPFunctionofTemperatureCurve, | ||
| 38 | Curve& heatingCOPFunctionofAirFlowFractionCurve, Curve& heatingCOPFunctionofWaterFlowFractionCurve, | ||
| 39 | Curve& partLoadFractionCorrelationCurve); | ||
| 40 | |||
| 41 | 19 | virtual ~CoilWaterHeatingAirToWaterHeatPump() override = default; | |
| 42 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 43 | ✗ | CoilWaterHeatingAirToWaterHeatPump(const CoilWaterHeatingAirToWaterHeatPump& other) = default; | |
| 44 | ✗ | CoilWaterHeatingAirToWaterHeatPump(CoilWaterHeatingAirToWaterHeatPump&& other) = default; | |
| 45 | ✗ | CoilWaterHeatingAirToWaterHeatPump& operator=(const CoilWaterHeatingAirToWaterHeatPump&) = default; | |
| 46 | ✗ | CoilWaterHeatingAirToWaterHeatPump& operator=(CoilWaterHeatingAirToWaterHeatPump&&) = default; | |
| 47 | |||
| 48 | //@} | ||
| 49 | |||
| 50 | static IddObjectType iddObjectType(); | ||
| 51 | |||
| 52 | static std::vector<std::string> evaporatorAirTemperatureTypeforCurveObjectsValues(); | ||
| 53 | |||
| 54 | /** @name Getters */ | ||
| 55 | //@{ | ||
| 56 | |||
| 57 | Schedule availabilitySchedule() const; | ||
| 58 | |||
| 59 | double ratedHeatingCapacity() const; | ||
| 60 | |||
| 61 | double ratedCOP() const; | ||
| 62 | |||
| 63 | double ratedSensibleHeatRatio() const; | ||
| 64 | |||
| 65 | double ratedEvaporatorInletAirDryBulbTemperature() const; | ||
| 66 | |||
| 67 | double ratedEvaporatorInletAirWetBulbTemperature() const; | ||
| 68 | |||
| 69 | double ratedCondenserInletWaterTemperature() const; | ||
| 70 | |||
| 71 | boost::optional<double> ratedEvaporatorAirFlowRate() const; | ||
| 72 | |||
| 73 | bool isRatedEvaporatorAirFlowRateAutosized() const; | ||
| 74 | |||
| 75 | boost::optional<double> ratedCondenserWaterFlowRate() const; | ||
| 76 | |||
| 77 | bool isRatedCondenserWaterFlowRateAutosized() const; | ||
| 78 | |||
| 79 | bool evaporatorFanPowerIncludedinRatedCOP() const; | ||
| 80 | |||
| 81 | bool condenserPumpPowerIncludedinRatedCOP() const; | ||
| 82 | |||
| 83 | bool condenserPumpHeatIncludedinRatedHeatingCapacityandRatedCOP() const; | ||
| 84 | |||
| 85 | double condenserWaterPumpPower() const; | ||
| 86 | |||
| 87 | double fractionofCondenserPumpHeattoWater() const; | ||
| 88 | |||
| 89 | double crankcaseHeaterCapacity() const; | ||
| 90 | |||
| 91 | boost::optional<Curve> crankcaseHeaterCapacityFunctionofTemperatureCurve() const; | ||
| 92 | |||
| 93 | double maximumAmbientTemperatureforCrankcaseHeaterOperation() const; | ||
| 94 | |||
| 95 | std::string evaporatorAirTemperatureTypeforCurveObjects() const; | ||
| 96 | |||
| 97 | Curve heatingCapacityFunctionofTemperatureCurve() const; | ||
| 98 | |||
| 99 | Curve heatingCapacityFunctionofAirFlowFractionCurve() const; | ||
| 100 | |||
| 101 | Curve heatingCapacityFunctionofWaterFlowFractionCurve() const; | ||
| 102 | |||
| 103 | Curve heatingCOPFunctionofTemperatureCurve() const; | ||
| 104 | |||
| 105 | Curve heatingCOPFunctionofAirFlowFractionCurve() const; | ||
| 106 | |||
| 107 | Curve heatingCOPFunctionofWaterFlowFractionCurve() const; | ||
| 108 | |||
| 109 | Curve partLoadFractionCorrelationCurve() const; | ||
| 110 | |||
| 111 | //@} | ||
| 112 | /** @name Setters */ | ||
| 113 | //@{ | ||
| 114 | |||
| 115 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 116 | |||
| 117 | bool setRatedHeatingCapacity(double ratedHeatingCapacity); | ||
| 118 | |||
| 119 | bool setRatedCOP(double ratedCOP); | ||
| 120 | |||
| 121 | bool setRatedSensibleHeatRatio(double ratedSensibleHeatRatio); | ||
| 122 | |||
| 123 | bool setRatedEvaporatorInletAirDryBulbTemperature(double ratedEvaporatorInletAirDryBulbTemperature); | ||
| 124 | |||
| 125 | bool setRatedEvaporatorInletAirWetBulbTemperature(double ratedEvaporatorInletAirWetBulbTemperature); | ||
| 126 | |||
| 127 | bool setRatedCondenserInletWaterTemperature(double ratedCondenserInletWaterTemperature); | ||
| 128 | |||
| 129 | bool setRatedEvaporatorAirFlowRate(double ratedEvaporatorAirFlowRate); | ||
| 130 | |||
| 131 | void autosizeRatedEvaporatorAirFlowRate(); | ||
| 132 | |||
| 133 | bool setRatedCondenserWaterFlowRate(double ratedCondenserWaterFlowRate); | ||
| 134 | |||
| 135 | void autosizeRatedCondenserWaterFlowRate(); | ||
| 136 | |||
| 137 | bool setEvaporatorFanPowerIncludedinRatedCOP(bool evaporatorFanPowerIncludedinRatedCOP); | ||
| 138 | |||
| 139 | bool setCondenserPumpPowerIncludedinRatedCOP(bool condenserPumpPowerIncludedinRatedCOP); | ||
| 140 | |||
| 141 | bool setCondenserPumpHeatIncludedinRatedHeatingCapacityandRatedCOP(bool condenserPumpHeatIncludedinRatedHeatingCapacityandRatedCOP); | ||
| 142 | |||
| 143 | bool setCondenserWaterPumpPower(double condenserWaterPumpPower); | ||
| 144 | |||
| 145 | bool setFractionofCondenserPumpHeattoWater(double fractionofCondenserPumpHeattoWater); | ||
| 146 | |||
| 147 | bool setCrankcaseHeaterCapacity(double crankcaseHeaterCapacity); | ||
| 148 | |||
| 149 | bool setCrankcaseHeaterCapacityFunctionofTemperatureCurve(const Curve& curve); | ||
| 150 | void resetCrankcaseHeaterCapacityFunctionofTemperatureCurve(); | ||
| 151 | |||
| 152 | bool setMaximumAmbientTemperatureforCrankcaseHeaterOperation(double maximumAmbientTemperatureforCrankcaseHeaterOperation); | ||
| 153 | |||
| 154 | bool setEvaporatorAirTemperatureTypeforCurveObjects(const std::string& evaporatorAirTemperatureTypeforCurveObjects); | ||
| 155 | |||
| 156 | bool setHeatingCapacityFunctionofTemperatureCurve(const Curve& curve); | ||
| 157 | |||
| 158 | bool setHeatingCapacityFunctionofAirFlowFractionCurve(const Curve& curve); | ||
| 159 | |||
| 160 | bool setHeatingCapacityFunctionofWaterFlowFractionCurve(const Curve& curve); | ||
| 161 | |||
| 162 | bool setHeatingCOPFunctionofTemperatureCurve(const Curve& curve); | ||
| 163 | |||
| 164 | bool setHeatingCOPFunctionofAirFlowFractionCurve(const Curve& curve); | ||
| 165 | |||
| 166 | bool setHeatingCOPFunctionofWaterFlowFractionCurve(const Curve& curve); | ||
| 167 | |||
| 168 | bool setPartLoadFractionCorrelationCurve(const Curve& curve); | ||
| 169 | |||
| 170 | //@} | ||
| 171 | /** @name Other */ | ||
| 172 | //@{ | ||
| 173 | |||
| 174 | boost::optional<double> autosizedRatedEvaporatorAirFlowRate() const; | ||
| 175 | |||
| 176 | boost::optional<double> autosizedRatedCondenserWaterFlowRate() const; | ||
| 177 | |||
| 178 | //@} | ||
| 179 | protected: | ||
| 180 | /// @cond | ||
| 181 | using ImplType = detail::CoilWaterHeatingAirToWaterHeatPump_Impl; | ||
| 182 | |||
| 183 | explicit CoilWaterHeatingAirToWaterHeatPump(std::shared_ptr<detail::CoilWaterHeatingAirToWaterHeatPump_Impl> impl); | ||
| 184 | |||
| 185 | friend class detail::CoilWaterHeatingAirToWaterHeatPump_Impl; | ||
| 186 | friend class Model; | ||
| 187 | friend class IdfObject; | ||
| 188 | friend class openstudio::detail::IdfObject_Impl; | ||
| 189 | /// @endcond | ||
| 190 | private: | ||
| 191 | REGISTER_LOGGER("openstudio.model.CoilWaterHeatingAirToWaterHeatPump"); | ||
| 192 | }; | ||
| 193 | |||
| 194 | /** \relates CoilWaterHeatingAirToWaterHeatPump*/ | ||
| 195 | using OptionalCoilWaterHeatingAirToWaterHeatPump = boost::optional<CoilWaterHeatingAirToWaterHeatPump>; | ||
| 196 | |||
| 197 | /** \relates CoilWaterHeatingAirToWaterHeatPump*/ | ||
| 198 | using CoilWaterHeatingAirToWaterHeatPumpVector = std::vector<CoilWaterHeatingAirToWaterHeatPump>; | ||
| 199 | |||
| 200 | } // namespace model | ||
| 201 | } // namespace openstudio | ||
| 202 | |||
| 203 | #endif // MODEL_COILWATERHEATINGAIRTOWATERHEATPUMP_HPP | ||
| 204 |