src/model/HeatPumpWaterToWaterEquationFitCooling.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_HEATPUMPWATERTOWATEREQUATIONFITCOOLING_HPP | ||
| 7 | #define MODEL_HEATPUMPWATERTOWATEREQUATIONFITCOOLING_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 HeatPumpWaterToWaterEquationFitHeating; | ||
| 19 | class CurveQuadLinear; | ||
| 20 | |||
| 21 | namespace detail { | ||
| 22 | |||
| 23 | class HeatPumpWaterToWaterEquationFitCooling_Impl; | ||
| 24 | |||
| 25 | } // namespace detail | ||
| 26 | |||
| 27 | /** HeatPumpWaterToWaterEquationFitCooling is a WaterToWaterComponent that wraps the OpenStudio IDD object 'OS:HeatPump:WaterToWater:EquationFit:Cooling'. */ | ||
| 28 | class MODEL_API HeatPumpWaterToWaterEquationFitCooling : public WaterToWaterComponent | ||
| 29 | { | ||
| 30 | public: | ||
| 31 | /** @name Constructors and Destructors */ | ||
| 32 | //@{ | ||
| 33 | |||
| 34 | explicit HeatPumpWaterToWaterEquationFitCooling(const Model& model, const CurveQuadLinear& coolingCapacityCurve, | ||
| 35 | const CurveQuadLinear& coolingCompressorPowerCurve); | ||
| 36 | |||
| 37 | explicit HeatPumpWaterToWaterEquationFitCooling(const Model& model); | ||
| 38 | |||
| 39 | 6 | virtual ~HeatPumpWaterToWaterEquationFitCooling() override = default; | |
| 40 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 41 | ✗ | HeatPumpWaterToWaterEquationFitCooling(const HeatPumpWaterToWaterEquationFitCooling& other) = default; | |
| 42 | 2 | HeatPumpWaterToWaterEquationFitCooling(HeatPumpWaterToWaterEquationFitCooling&& other) = default; | |
| 43 | ✗ | HeatPumpWaterToWaterEquationFitCooling& operator=(const HeatPumpWaterToWaterEquationFitCooling&) = default; | |
| 44 | ✗ | HeatPumpWaterToWaterEquationFitCooling& operator=(HeatPumpWaterToWaterEquationFitCooling&&) = default; | |
| 45 | |||
| 46 | //@} | ||
| 47 | |||
| 48 | static IddObjectType iddObjectType(); | ||
| 49 | |||
| 50 | /** @name Getters */ | ||
| 51 | //@{ | ||
| 52 | |||
| 53 | boost::optional<double> referenceLoadSideFlowRate() const; | ||
| 54 | |||
| 55 | /** Prior to EnergyPlus 8.7.0 this field was not autosizeable. To preserve backwards compatibility this method will return -999.0 in autosized models.**/ | ||
| 56 | double ratedLoadSideFlowRate() const; | ||
| 57 | |||
| 58 | bool isReferenceLoadSideFlowRateAutosized() const; | ||
| 59 | |||
| 60 | boost::optional<double> referenceSourceSideFlowRate() const; | ||
| 61 | |||
| 62 | /** Prior to EnergyPlus 8.7.0 this field was not autosizeable. To preserve backwards compatibility this method will return -999.0 in autosized models.**/ | ||
| 63 | double ratedSourceSideFlowRate() const; | ||
| 64 | |||
| 65 | bool isReferenceSourceSideFlowRateAutosized() const; | ||
| 66 | |||
| 67 | /** In EnergyPlus 8.7.0 and above this field maps to the EnergyPlus field named "Reference Cooling Capacity" **/ | ||
| 68 | boost::optional<double> ratedCoolingCapacity() const; | ||
| 69 | |||
| 70 | bool isRatedCoolingCapacityAutosized() const; | ||
| 71 | |||
| 72 | /** In EnergyPlus 8.7.0 and above this field maps to the EnergyPlus field named "Reference Cooling Power Consumption" **/ | ||
| 73 | boost::optional<double> ratedCoolingPowerConsumption() const; | ||
| 74 | |||
| 75 | bool isRatedCoolingPowerConsumptionAutosized() const; | ||
| 76 | |||
| 77 | CurveQuadLinear coolingCapacityCurve() const; | ||
| 78 | OS_DEPRECATED(3, 2, 0) double coolingCapacityCoefficient1() const; | ||
| 79 | OS_DEPRECATED(3, 2, 0) double coolingCapacityCoefficient2() const; | ||
| 80 | OS_DEPRECATED(3, 2, 0) double coolingCapacityCoefficient3() const; | ||
| 81 | OS_DEPRECATED(3, 2, 0) double coolingCapacityCoefficient4() const; | ||
| 82 | OS_DEPRECATED(3, 2, 0) double coolingCapacityCoefficient5() const; | ||
| 83 | |||
| 84 | CurveQuadLinear coolingCompressorPowerCurve() const; | ||
| 85 | OS_DEPRECATED(3, 2, 0) double coolingCompressorPowerCoefficient1() const; | ||
| 86 | OS_DEPRECATED(3, 2, 0) double coolingCompressorPowerCoefficient2() const; | ||
| 87 | OS_DEPRECATED(3, 2, 0) double coolingCompressorPowerCoefficient3() const; | ||
| 88 | OS_DEPRECATED(3, 2, 0) double coolingCompressorPowerCoefficient4() const; | ||
| 89 | OS_DEPRECATED(3, 2, 0) double coolingCompressorPowerCoefficient5() const; | ||
| 90 | |||
| 91 | double referenceCoefficientofPerformance() const; | ||
| 92 | |||
| 93 | double sizingFactor() const; | ||
| 94 | |||
| 95 | boost::optional<HeatPumpWaterToWaterEquationFitHeating> companionHeatingHeatPump() const; | ||
| 96 | |||
| 97 | //@} | ||
| 98 | /** @name Setters */ | ||
| 99 | //@{ | ||
| 100 | |||
| 101 | bool setReferenceLoadSideFlowRate(double referenceLoadSideFlowRate); | ||
| 102 | |||
| 103 | /** Synonym of setReferenceLoadSideFlowRate for backwards compatibility **/ | ||
| 104 | bool setRatedLoadSideFlowRate(double ratedLoadSideFlowRate); | ||
| 105 | |||
| 106 | void autosizeReferenceLoadSideFlowRate(); | ||
| 107 | |||
| 108 | bool setReferenceSourceSideFlowRate(double referenceSourceSideFlowRate); | ||
| 109 | |||
| 110 | /** Synonym of setReferenceLoadSideFlowRate for backwards compatibility **/ | ||
| 111 | bool setRatedSourceSideFlowRate(double ratedSourceSideFlowRate); | ||
| 112 | |||
| 113 | void autosizeReferenceSourceSideFlowRate(); | ||
| 114 | |||
| 115 | /** In EnergyPlus 8.7.0 and above this field maps to the EnergyPlus field named "Reference Cooling Capacity" **/ | ||
| 116 | bool setRatedCoolingCapacity(double ratedCoolingCapacity); | ||
| 117 | |||
| 118 | void autosizeRatedCoolingCapacity(); | ||
| 119 | |||
| 120 | /** In EnergyPlus 8.7.0 and above this field maps to the EnergyPlus field named "Reference Cooling Power Consumption" **/ | ||
| 121 | bool setRatedCoolingPowerConsumption(double ratedCoolingPowerConsumption); | ||
| 122 | |||
| 123 | void autosizeRatedCoolingPowerConsumption(); | ||
| 124 | |||
| 125 | bool setCoolingCapacityCurve(const CurveQuadLinear& coolingCapacityCurve); | ||
| 126 | |||
| 127 | OS_DEPRECATED(3, 2, 0) bool setCoolingCapacityCoefficient1(double coolingCapacityCoefficient1); | ||
| 128 | OS_DEPRECATED(3, 2, 0) bool setCoolingCapacityCoefficient2(double coolingCapacityCoefficient2); | ||
| 129 | OS_DEPRECATED(3, 2, 0) bool setCoolingCapacityCoefficient3(double coolingCapacityCoefficient3); | ||
| 130 | OS_DEPRECATED(3, 2, 0) bool setCoolingCapacityCoefficient4(double coolingCapacityCoefficient4); | ||
| 131 | OS_DEPRECATED(3, 2, 0) bool setCoolingCapacityCoefficient5(double coolingCapacityCoefficient5); | ||
| 132 | |||
| 133 | bool setCoolingCompressorPowerCurve(const CurveQuadLinear& coolingCompressorPowerCurve); | ||
| 134 | |||
| 135 | OS_DEPRECATED(3, 2, 0) bool setCoolingCompressorPowerCoefficient1(double coolingCompressorPowerCoefficient1); | ||
| 136 | OS_DEPRECATED(3, 2, 0) bool setCoolingCompressorPowerCoefficient2(double coolingCompressorPowerCoefficient2); | ||
| 137 | OS_DEPRECATED(3, 2, 0) bool setCoolingCompressorPowerCoefficient3(double coolingCompressorPowerCoefficient3); | ||
| 138 | OS_DEPRECATED(3, 2, 0) bool setCoolingCompressorPowerCoefficient4(double coolingCompressorPowerCoefficient4); | ||
| 139 | OS_DEPRECATED(3, 2, 0) bool setCoolingCompressorPowerCoefficient5(double coolingCompressorPowerCoefficient5); | ||
| 140 | |||
| 141 | bool setReferenceCoefficientofPerformance(double referenceCoefficientofPerformance); | ||
| 142 | |||
| 143 | bool setSizingFactor(double sizingFactor); | ||
| 144 | |||
| 145 | bool setCompanionHeatingHeatPump(const HeatPumpWaterToWaterEquationFitHeating& companionHP); | ||
| 146 | |||
| 147 | //@} | ||
| 148 | /** @name Other */ | ||
| 149 | //@{ | ||
| 150 | |||
| 151 | boost::optional<double> autosizedReferenceLoadSideFlowRate() const; | ||
| 152 | |||
| 153 | boost::optional<double> autosizedReferenceSourceSideFlowRate() const; | ||
| 154 | |||
| 155 | boost::optional<double> autosizedRatedCoolingCapacity() const; | ||
| 156 | |||
| 157 | boost::optional<double> autosizedRatedCoolingPowerConsumption() const; | ||
| 158 | |||
| 159 | //@} | ||
| 160 | protected: | ||
| 161 | /// @cond | ||
| 162 | using ImplType = detail::HeatPumpWaterToWaterEquationFitCooling_Impl; | ||
| 163 | |||
| 164 | explicit HeatPumpWaterToWaterEquationFitCooling(std::shared_ptr<detail::HeatPumpWaterToWaterEquationFitCooling_Impl> impl); | ||
| 165 | |||
| 166 | friend class detail::HeatPumpWaterToWaterEquationFitCooling_Impl; | ||
| 167 | friend class Model; | ||
| 168 | friend class IdfObject; | ||
| 169 | friend class openstudio::detail::IdfObject_Impl; | ||
| 170 | /// @endcond | ||
| 171 | private: | ||
| 172 | − | REGISTER_LOGGER("openstudio.model.HeatPumpWaterToWaterEquationFitCooling"); | |
| 173 | }; | ||
| 174 | |||
| 175 | /** \relates HeatPumpWaterToWaterEquationFitCooling*/ | ||
| 176 | using OptionalHeatPumpWaterToWaterEquationFitCooling = boost::optional<HeatPumpWaterToWaterEquationFitCooling>; | ||
| 177 | |||
| 178 | /** \relates HeatPumpWaterToWaterEquationFitCooling*/ | ||
| 179 | using HeatPumpWaterToWaterEquationFitCoolingVector = std::vector<HeatPumpWaterToWaterEquationFitCooling>; | ||
| 180 | |||
| 181 | } // namespace model | ||
| 182 | } // namespace openstudio | ||
| 183 | |||
| 184 | #endif // MODEL_HEATPUMPWATERTOWATEREQUATIONFITCOOLING_HPP | ||
| 185 |