src/model/CoilHeatingWaterToAirHeatPumpEquationFit.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_COILHEATINGWATERTOAIRHEATPUMPEQUATIONFIT_HPP | ||
| 7 | #define MODEL_COILHEATINGWATERTOAIRHEATPUMPEQUATIONFIT_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 | |||
| 23 | class CoilHeatingWaterToAirHeatPumpEquationFit_Impl; | ||
| 24 | |||
| 25 | } // namespace detail | ||
| 26 | |||
| 27 | /** CoilHeatingWaterToAirHeatPumpEquationFit is a WaterToAirComponent that wraps the OpenStudio IDD object 'OS:Coil:Heating:WaterToAirHeatPump:EquationFit'. */ | ||
| 28 | class MODEL_API CoilHeatingWaterToAirHeatPumpEquationFit : public WaterToAirComponent | ||
| 29 | { | ||
| 30 | public: | ||
| 31 | /** @name Constructors and Destructors */ | ||
| 32 | //@{ | ||
| 33 | |||
| 34 | /** Constructs a new CoilCoolingWaterToAirHeatPumpEquationFit with required curve objects */ | ||
| 35 | CoilHeatingWaterToAirHeatPumpEquationFit(const Model& model, const Curve& heatingCapacityCurve, const Curve& heatingPowerConsumptionCurve); | ||
| 36 | |||
| 37 | CoilHeatingWaterToAirHeatPumpEquationFit(const Model& model); | ||
| 38 | |||
| 39 | 16 | virtual ~CoilHeatingWaterToAirHeatPumpEquationFit() override = default; | |
| 40 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 41 | ✗ | CoilHeatingWaterToAirHeatPumpEquationFit(const CoilHeatingWaterToAirHeatPumpEquationFit& other) = default; | |
| 42 | ✗ | CoilHeatingWaterToAirHeatPumpEquationFit(CoilHeatingWaterToAirHeatPumpEquationFit&& other) = default; | |
| 43 | ✗ | CoilHeatingWaterToAirHeatPumpEquationFit& operator=(const CoilHeatingWaterToAirHeatPumpEquationFit&) = default; | |
| 44 | ✗ | CoilHeatingWaterToAirHeatPumpEquationFit& operator=(CoilHeatingWaterToAirHeatPumpEquationFit&&) = default; | |
| 45 | |||
| 46 | //@} | ||
| 47 | |||
| 48 | static IddObjectType iddObjectType(); | ||
| 49 | |||
| 50 | /** @name Getters */ | ||
| 51 | //@{ | ||
| 52 | |||
| 53 | Schedule availabilitySchedule() const; | ||
| 54 | |||
| 55 | boost::optional<double> ratedAirFlowRate() const; | ||
| 56 | |||
| 57 | bool isRatedAirFlowRateDefaulted() const; | ||
| 58 | |||
| 59 | bool isRatedAirFlowRateAutosized() const; | ||
| 60 | |||
| 61 | boost::optional<double> ratedWaterFlowRate() const; | ||
| 62 | |||
| 63 | bool isRatedWaterFlowRateDefaulted() const; | ||
| 64 | |||
| 65 | bool isRatedWaterFlowRateAutosized() const; | ||
| 66 | |||
| 67 | boost::optional<double> ratedHeatingCapacity() const; | ||
| 68 | |||
| 69 | bool isRatedHeatingCapacityDefaulted() const; | ||
| 70 | |||
| 71 | bool isRatedHeatingCapacityAutosized() const; | ||
| 72 | |||
| 73 | double ratedHeatingCoefficientofPerformance() const; | ||
| 74 | |||
| 75 | bool isRatedHeatingCoefficientofPerformanceDefaulted() const; | ||
| 76 | |||
| 77 | double ratedEnteringWaterTemperature() const; | ||
| 78 | |||
| 79 | double ratedEnteringAirDryBulbTemperature() const; | ||
| 80 | |||
| 81 | double ratioofRatedHeatingCapacitytoRatedCoolingCapacity() const; | ||
| 82 | |||
| 83 | Curve heatingCapacityCurve() const; | ||
| 84 | |||
| 85 | OS_DEPRECATED(3, 2, 0) double heatingCapacityCoefficient1() const; | ||
| 86 | OS_DEPRECATED(3, 2, 0) double heatingCapacityCoefficient2() const; | ||
| 87 | OS_DEPRECATED(3, 2, 0) double heatingCapacityCoefficient3() const; | ||
| 88 | OS_DEPRECATED(3, 2, 0) double heatingCapacityCoefficient4() const; | ||
| 89 | OS_DEPRECATED(3, 2, 0) double heatingCapacityCoefficient5() const; | ||
| 90 | |||
| 91 | Curve heatingPowerConsumptionCurve() const; | ||
| 92 | |||
| 93 | OS_DEPRECATED(3, 2, 0) double heatingPowerConsumptionCoefficient1() const; | ||
| 94 | OS_DEPRECATED(3, 2, 0) double heatingPowerConsumptionCoefficient2() const; | ||
| 95 | OS_DEPRECATED(3, 2, 0) double heatingPowerConsumptionCoefficient3() const; | ||
| 96 | OS_DEPRECATED(3, 2, 0) double heatingPowerConsumptionCoefficient4() const; | ||
| 97 | OS_DEPRECATED(3, 2, 0) double heatingPowerConsumptionCoefficient5() const; | ||
| 98 | |||
| 99 | Curve partLoadFractionCorrelationCurve() const; | ||
| 100 | |||
| 101 | //@} | ||
| 102 | /** @name Setters */ | ||
| 103 | //@{ | ||
| 104 | |||
| 105 | bool setAvailabilitySchedule(Schedule& schedule); | ||
| 106 | |||
| 107 | bool setRatedAirFlowRate(boost::optional<double> ratedAirFlowRate); | ||
| 108 | |||
| 109 | bool setRatedAirFlowRate(double ratedAirFlowRate); | ||
| 110 | |||
| 111 | void resetRatedAirFlowRate(); | ||
| 112 | |||
| 113 | void autosizeRatedAirFlowRate(); | ||
| 114 | |||
| 115 | bool setRatedWaterFlowRate(boost::optional<double> ratedWaterFlowRate); | ||
| 116 | |||
| 117 | bool setRatedWaterFlowRate(double ratedWaterFlowRate); | ||
| 118 | |||
| 119 | void resetRatedWaterFlowRate(); | ||
| 120 | |||
| 121 | void autosizeRatedWaterFlowRate(); | ||
| 122 | |||
| 123 | bool setRatedHeatingCapacity(boost::optional<double> ratedHeatingCapacity); | ||
| 124 | |||
| 125 | bool setRatedHeatingCapacity(double ratedHeatingCapacity); | ||
| 126 | |||
| 127 | void resetRatedHeatingCapacity(); | ||
| 128 | |||
| 129 | void autosizeRatedHeatingCapacity(); | ||
| 130 | |||
| 131 | bool setRatedHeatingCoefficientofPerformance(double ratedHeatingCoefficientofPerformance); | ||
| 132 | |||
| 133 | void resetRatedHeatingCoefficientofPerformance(); | ||
| 134 | |||
| 135 | bool setRatedEnteringWaterTemperature(double ratedEnteringWaterTemperature); | ||
| 136 | |||
| 137 | bool setRatedEnteringAirDryBulbTemperature(double ratedEnteringAirDryBulbTemperature); | ||
| 138 | |||
| 139 | bool setRatioofRatedHeatingCapacitytoRatedCoolingCapacity(double ratioofRatedHeatingCapacitytoRatedCoolingCapacity); | ||
| 140 | |||
| 141 | bool setHeatingCapacityCurve(const Curve& heatingCapacityCurve); | ||
| 142 | |||
| 143 | OS_DEPRECATED(3, 2, 0) bool setHeatingCapacityCoefficient1(double heatingCapacityCoefficient1); | ||
| 144 | OS_DEPRECATED(3, 2, 0) bool setHeatingCapacityCoefficient2(double heatingCapacityCoefficient2); | ||
| 145 | OS_DEPRECATED(3, 2, 0) bool setHeatingCapacityCoefficient3(double heatingCapacityCoefficient3); | ||
| 146 | OS_DEPRECATED(3, 2, 0) bool setHeatingCapacityCoefficient4(double heatingCapacityCoefficient4); | ||
| 147 | OS_DEPRECATED(3, 2, 0) bool setHeatingCapacityCoefficient5(double heatingCapacityCoefficient5); | ||
| 148 | |||
| 149 | bool setHeatingPowerConsumptionCurve(const Curve& heatingPowerConsumptionCurve); | ||
| 150 | |||
| 151 | OS_DEPRECATED(3, 2, 0) bool setHeatingPowerConsumptionCoefficient1(double heatingPowerConsumptionCoefficient1); | ||
| 152 | OS_DEPRECATED(3, 2, 0) bool setHeatingPowerConsumptionCoefficient2(double heatingPowerConsumptionCoefficient2); | ||
| 153 | OS_DEPRECATED(3, 2, 0) bool setHeatingPowerConsumptionCoefficient3(double heatingPowerConsumptionCoefficient3); | ||
| 154 | OS_DEPRECATED(3, 2, 0) bool setHeatingPowerConsumptionCoefficient4(double heatingPowerConsumptionCoefficient4); | ||
| 155 | OS_DEPRECATED(3, 2, 0) bool setHeatingPowerConsumptionCoefficient5(double heatingPowerConsumptionCoefficient5); | ||
| 156 | |||
| 157 | bool setPartLoadFractionCorrelationCurve(const Curve& partLoadFractionCorrelationCurve); | ||
| 158 | |||
| 159 | //@} | ||
| 160 | /** @name Other */ | ||
| 161 | //@{ | ||
| 162 | |||
| 163 | /** Returns an equivalent duct object, creating a new one if an object is not already attached. */ | ||
| 164 | AirflowNetworkEquivalentDuct getAirflowNetworkEquivalentDuct(double length, double diameter); | ||
| 165 | |||
| 166 | /** Returns the attached equivalent duct object if there is one. */ | ||
| 167 | boost::optional<AirflowNetworkEquivalentDuct> airflowNetworkEquivalentDuct() const; | ||
| 168 | |||
| 169 | boost::optional<double> autosizedRatedAirFlowRate() const; | ||
| 170 | |||
| 171 | boost::optional<double> autosizedRatedWaterFlowRate() const; | ||
| 172 | |||
| 173 | boost::optional<double> autosizedRatedHeatingCapacity() const; | ||
| 174 | |||
| 175 | //@} | ||
| 176 | protected: | ||
| 177 | /// @cond | ||
| 178 | using ImplType = detail::CoilHeatingWaterToAirHeatPumpEquationFit_Impl; | ||
| 179 | |||
| 180 | explicit CoilHeatingWaterToAirHeatPumpEquationFit(std::shared_ptr<detail::CoilHeatingWaterToAirHeatPumpEquationFit_Impl> impl); | ||
| 181 | |||
| 182 | friend class detail::CoilHeatingWaterToAirHeatPumpEquationFit_Impl; | ||
| 183 | friend class Model; | ||
| 184 | friend class IdfObject; | ||
| 185 | friend class openstudio::detail::IdfObject_Impl; | ||
| 186 | /// @endcond | ||
| 187 | private: | ||
| 188 | − | REGISTER_LOGGER("openstudio.model.CoilHeatingWaterToAirHeatPumpEquationFit"); | |
| 189 | }; | ||
| 190 | |||
| 191 | /** \relates CoilHeatingWaterToAirHeatPumpEquationFit*/ | ||
| 192 | using OptionalCoilHeatingWaterToAirHeatPumpEquationFit = boost::optional<CoilHeatingWaterToAirHeatPumpEquationFit>; | ||
| 193 | |||
| 194 | /** \relates CoilHeatingWaterToAirHeatPumpEquationFit*/ | ||
| 195 | using CoilHeatingWaterToAirHeatPumpEquationFitVector = std::vector<CoilHeatingWaterToAirHeatPumpEquationFit>; | ||
| 196 | |||
| 197 | } // namespace model | ||
| 198 | } // namespace openstudio | ||
| 199 | |||
| 200 | #endif // MODEL_COILHEATINGWATERTOAIRHEATPUMPEQUATIONFIT_HPP | ||
| 201 |