src/model/HeatPumpWaterToWaterEquationFitHeating.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_HEATPUMPWATERTOWATEREQUATIONFITHEATING_HPP | ||
| 7 | #define MODEL_HEATPUMPWATERTOWATEREQUATIONFITHEATING_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "WaterToWaterComponent.hpp" | ||
| 11 | |||
| 12 | #include "../utilities/core/Deprecated.hpp" | ||
| 13 | |||
| 14 | namespace openstudio { | ||
| 15 | |||
| 16 | namespace model { | ||
| 17 | |||
| 18 | class HeatPumpWaterToWaterEquationFitCooling; | ||
| 19 | class CurveQuadLinear; | ||
| 20 | |||
| 21 | namespace detail { | ||
| 22 | |||
| 23 | class HeatPumpWaterToWaterEquationFitHeating_Impl; | ||
| 24 | |||
| 25 | } // namespace detail | ||
| 26 | |||
| 27 | /** HeatPumpWaterToWaterEquationFitHeating is a WaterToWaterComponent that wraps the OpenStudio IDD object 'OS:HeatPump:WaterToWater:EquationFit:Heating'. */ | ||
| 28 | class MODEL_API HeatPumpWaterToWaterEquationFitHeating : public WaterToWaterComponent | ||
| 29 | { | ||
| 30 | public: | ||
| 31 | /** @name Constructors and Destructors */ | ||
| 32 | //@{ | ||
| 33 | |||
| 34 | explicit HeatPumpWaterToWaterEquationFitHeating(const Model& model, const CurveQuadLinear& heatingCapacityCurve, | ||
| 35 | const CurveQuadLinear& heatingCompressorPowerCurve); | ||
| 36 | |||
| 37 | explicit HeatPumpWaterToWaterEquationFitHeating(const Model& model); | ||
| 38 | |||
| 39 | 6 | virtual ~HeatPumpWaterToWaterEquationFitHeating() override = default; | |
| 40 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 41 | ✗ | HeatPumpWaterToWaterEquationFitHeating(const HeatPumpWaterToWaterEquationFitHeating& other) = default; | |
| 42 | 2 | HeatPumpWaterToWaterEquationFitHeating(HeatPumpWaterToWaterEquationFitHeating&& other) = default; | |
| 43 | ✗ | HeatPumpWaterToWaterEquationFitHeating& operator=(const HeatPumpWaterToWaterEquationFitHeating&) = default; | |
| 44 | ✗ | HeatPumpWaterToWaterEquationFitHeating& operator=(HeatPumpWaterToWaterEquationFitHeating&&) = default; | |
| 45 | |||
| 46 | //@} | ||
| 47 | |||
| 48 | static IddObjectType iddObjectType(); | ||
| 49 | |||
| 50 | boost::optional<double> referenceLoadSideFlowRate() const; | ||
| 51 | |||
| 52 | /** Prior to EnergyPlus 8.7.0 this field was not autosizeable. To preserve backwards compatibility this method will return -999.0 in autosized models.**/ | ||
| 53 | double ratedLoadSideFlowRate() const; | ||
| 54 | |||
| 55 | bool isReferenceLoadSideFlowRateAutosized() const; | ||
| 56 | |||
| 57 | boost::optional<double> referenceSourceSideFlowRate() const; | ||
| 58 | |||
| 59 | /** Prior to EnergyPlus 8.7.0 this field was not autosizeable. To preserve backwards compatibility this method will return -999.0 in autosized models.**/ | ||
| 60 | double ratedSourceSideFlowRate() const; | ||
| 61 | |||
| 62 | bool isReferenceSourceSideFlowRateAutosized() const; | ||
| 63 | |||
| 64 | /** In EnergyPlus 8.7.0 and above this field maps to the EnergyPlus field named "Reference Heating Capacity" **/ | ||
| 65 | boost::optional<double> ratedHeatingCapacity() const; | ||
| 66 | |||
| 67 | bool isRatedHeatingCapacityAutosized() const; | ||
| 68 | |||
| 69 | /** In EnergyPlus 8.7.0 and above this field maps to the EnergyPlus field named "Reference Heating Power Consumption" **/ | ||
| 70 | boost::optional<double> ratedHeatingPowerConsumption() const; | ||
| 71 | |||
| 72 | bool isRatedHeatingPowerConsumptionAutosized() const; | ||
| 73 | |||
| 74 | CurveQuadLinear heatingCapacityCurve() const; | ||
| 75 | OS_DEPRECATED(3, 2, 0) double heatingCapacityCoefficient1() const; | ||
| 76 | OS_DEPRECATED(3, 2, 0) double heatingCapacityCoefficient2() const; | ||
| 77 | OS_DEPRECATED(3, 2, 0) double heatingCapacityCoefficient3() const; | ||
| 78 | OS_DEPRECATED(3, 2, 0) double heatingCapacityCoefficient4() const; | ||
| 79 | OS_DEPRECATED(3, 2, 0) double heatingCapacityCoefficient5() const; | ||
| 80 | |||
| 81 | CurveQuadLinear heatingCompressorPowerCurve() const; | ||
| 82 | OS_DEPRECATED(3, 2, 0) double heatingCompressorPowerCoefficient1() const; | ||
| 83 | OS_DEPRECATED(3, 2, 0) double heatingCompressorPowerCoefficient2() const; | ||
| 84 | OS_DEPRECATED(3, 2, 0) double heatingCompressorPowerCoefficient3() const; | ||
| 85 | OS_DEPRECATED(3, 2, 0) double heatingCompressorPowerCoefficient4() const; | ||
| 86 | OS_DEPRECATED(3, 2, 0) double heatingCompressorPowerCoefficient5() const; | ||
| 87 | |||
| 88 | double referenceCoefficientofPerformance() const; | ||
| 89 | |||
| 90 | double sizingFactor() const; | ||
| 91 | |||
| 92 | boost::optional<HeatPumpWaterToWaterEquationFitCooling> companionCoolingHeatPump() const; | ||
| 93 | |||
| 94 | //@} | ||
| 95 | /** @name Setters */ | ||
| 96 | //@{ | ||
| 97 | |||
| 98 | bool setReferenceLoadSideFlowRate(double referenceLoadSideFlowRate); | ||
| 99 | |||
| 100 | /** Synonym of setReferenceLoadSideFlowRate for backwards compatibility **/ | ||
| 101 | bool setRatedLoadSideFlowRate(double ratedLoadSideFlowRate); | ||
| 102 | |||
| 103 | void autosizeReferenceLoadSideFlowRate(); | ||
| 104 | |||
| 105 | bool setReferenceSourceSideFlowRate(double referenceSourceSideFlowRate); | ||
| 106 | |||
| 107 | /** Synonym of setReferenceSourceSideFlowRate for backwards compatibility **/ | ||
| 108 | bool setRatedSourceSideFlowRate(double ratedLoadSideFlowRate); | ||
| 109 | |||
| 110 | void autosizeReferenceSourceSideFlowRate(); | ||
| 111 | |||
| 112 | /** In EnergyPlus 8.7.0 and above this field maps to the EnergyPlus field named "Reference Heating Capacity" **/ | ||
| 113 | bool setRatedHeatingCapacity(double ratedHeatingCapacity); | ||
| 114 | |||
| 115 | void autosizeRatedHeatingCapacity(); | ||
| 116 | |||
| 117 | /** In EnergyPlus 8.7.0 and above this field maps to the EnergyPlus field named "Reference Heating Power Consumption" **/ | ||
| 118 | bool setRatedHeatingPowerConsumption(double ratedHeatingPowerConsumption); | ||
| 119 | |||
| 120 | void autosizeRatedHeatingPowerConsumption(); | ||
| 121 | |||
| 122 | bool setHeatingCapacityCurve(const CurveQuadLinear& heatingCapacityCurve); | ||
| 123 | |||
| 124 | OS_DEPRECATED(3, 2, 0) bool setHeatingCapacityCoefficient1(double heatingCapacityCoefficient1); | ||
| 125 | OS_DEPRECATED(3, 2, 0) bool setHeatingCapacityCoefficient2(double heatingCapacityCoefficient2); | ||
| 126 | OS_DEPRECATED(3, 2, 0) bool setHeatingCapacityCoefficient3(double heatingCapacityCoefficient3); | ||
| 127 | OS_DEPRECATED(3, 2, 0) bool setHeatingCapacityCoefficient4(double heatingCapacityCoefficient4); | ||
| 128 | OS_DEPRECATED(3, 2, 0) bool setHeatingCapacityCoefficient5(double heatingCapacityCoefficient5); | ||
| 129 | |||
| 130 | bool setHeatingCompressorPowerCurve(const CurveQuadLinear& heatingCompressorPowerCurve); | ||
| 131 | |||
| 132 | OS_DEPRECATED(3, 2, 0) bool setHeatingCompressorPowerCoefficient1(double heatingCompressorPowerCoefficient1); | ||
| 133 | OS_DEPRECATED(3, 2, 0) bool setHeatingCompressorPowerCoefficient2(double heatingCompressorPowerCoefficient2); | ||
| 134 | OS_DEPRECATED(3, 2, 0) bool setHeatingCompressorPowerCoefficient3(double heatingCompressorPowerCoefficient3); | ||
| 135 | OS_DEPRECATED(3, 2, 0) bool setHeatingCompressorPowerCoefficient4(double heatingCompressorPowerCoefficient4); | ||
| 136 | OS_DEPRECATED(3, 2, 0) bool setHeatingCompressorPowerCoefficient5(double heatingCompressorPowerCoefficient5); | ||
| 137 | |||
| 138 | bool setReferenceCoefficientofPerformance(double referenceCoefficientofPerformance); | ||
| 139 | |||
| 140 | bool setSizingFactor(double sizingFactor); | ||
| 141 | |||
| 142 | bool setCompanionCoolingHeatPump(const HeatPumpWaterToWaterEquationFitCooling& companionHP); | ||
| 143 | |||
| 144 | //@} | ||
| 145 | /** @name Other */ | ||
| 146 | //@{ | ||
| 147 | |||
| 148 | boost::optional<double> autosizedReferenceLoadSideFlowRate() const; | ||
| 149 | |||
| 150 | boost::optional<double> autosizedReferenceSourceSideFlowRate() const; | ||
| 151 | |||
| 152 | boost::optional<double> autosizedRatedHeatingCapacity() const; | ||
| 153 | |||
| 154 | boost::optional<double> autosizedRatedHeatingPowerConsumption() const; | ||
| 155 | |||
| 156 | //@} | ||
| 157 | protected: | ||
| 158 | /// @cond | ||
| 159 | using ImplType = detail::HeatPumpWaterToWaterEquationFitHeating_Impl; | ||
| 160 | |||
| 161 | explicit HeatPumpWaterToWaterEquationFitHeating(std::shared_ptr<detail::HeatPumpWaterToWaterEquationFitHeating_Impl> impl); | ||
| 162 | |||
| 163 | friend class detail::HeatPumpWaterToWaterEquationFitHeating_Impl; | ||
| 164 | friend class Model; | ||
| 165 | friend class IdfObject; | ||
| 166 | friend class openstudio::detail::IdfObject_Impl; | ||
| 167 | /// @endcond | ||
| 168 | private: | ||
| 169 | − | REGISTER_LOGGER("openstudio.model.HeatPumpWaterToWaterEquationFitHeating"); | |
| 170 | }; | ||
| 171 | |||
| 172 | /** \relates HeatPumpWaterToWaterEquationFitHeating*/ | ||
| 173 | using OptionalHeatPumpWaterToWaterEquationFitHeating = boost::optional<HeatPumpWaterToWaterEquationFitHeating>; | ||
| 174 | |||
| 175 | /** \relates HeatPumpWaterToWaterEquationFitHeating*/ | ||
| 176 | using HeatPumpWaterToWaterEquationFitHeatingVector = std::vector<HeatPumpWaterToWaterEquationFitHeating>; | ||
| 177 | |||
| 178 | } // namespace model | ||
| 179 | } // namespace openstudio | ||
| 180 | |||
| 181 | #endif // MODEL_HEATPUMPWATERTOWATEREQUATIONFITHEATING_HPP | ||
| 182 |