GCC Code Coverage Report


Directory: ./
Coverage: low: ≥ 0% medium: ≥ 75.0% high: ≥ 90.0%
Coverage Exec / Excl / Total
Lines: 40.0% 2 / 1 / 6
Functions: 40.0% 2 / 1 / 6
Branches: -% 0 / 1 / 1

src/model/HeatPumpPlantLoopEIRCooling.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_HEATPUMPPLANTLOOPEIRCOOLING_HPP
7 #define MODEL_HEATPUMPPLANTLOOPEIRCOOLING_HPP
8
9 #include "ModelAPI.hpp"
10 #include "WaterToWaterComponent.hpp"
11
12 namespace openstudio {
13
14 namespace model {
15
16 class HeatPumpPlantLoopEIRHeating;
17 class Curve;
18
19 namespace detail {
20
21 class HeatPumpPlantLoopEIRCooling_Impl;
22
23 } // namespace detail
24
25 /** HeatPumpPlantLoopEIRCooling is a WaterToWaterComponent that wraps the OpenStudio IDD object 'OS:HeatPump:PlantLoop:EIR:Cooling'. */
26 class MODEL_API HeatPumpPlantLoopEIRCooling : public WaterToWaterComponent
27 {
28 public:
29 /** @name Constructors and Destructors */
30 //@{
31
32 explicit HeatPumpPlantLoopEIRCooling(const Model& model, const Curve& capacityModifierFunctionofTemperatureCurve,
33 const Curve& electricInputtoOutputRatioModifierFunctionofTemperatureCurve,
34 const Curve& electricInputtoOutputRatioModifierFunctionofPartLoadRatioCurve);
35
36 explicit HeatPumpPlantLoopEIRCooling(const Model& model);
37
38 31 virtual ~HeatPumpPlantLoopEIRCooling() override = default;
39 // Default the copy and move operators because the virtual dtor is explicit
40 ✗ HeatPumpPlantLoopEIRCooling(const HeatPumpPlantLoopEIRCooling& other) = default;
41 10 HeatPumpPlantLoopEIRCooling(HeatPumpPlantLoopEIRCooling&& other) = default;
42 ✗ HeatPumpPlantLoopEIRCooling& operator=(const HeatPumpPlantLoopEIRCooling&) = default;
43 ✗ HeatPumpPlantLoopEIRCooling& operator=(HeatPumpPlantLoopEIRCooling&&) = default;
44
45 //@}
46
47 static IddObjectType iddObjectType();
48
49 static std::vector<std::string> validCondenserTypeValues();
50
51 static std::vector<std::string> condenserTypeValues();
52
53 /** @name Getters */
54 //@{
55
56 std::string condenserType() const;
57
58 boost::optional<HeatPumpPlantLoopEIRHeating> companionHeatingHeatPump() const;
59
60 boost::optional<double> loadSideReferenceFlowRate() const;
61
62 bool isLoadSideReferenceFlowRateAutosized() const;
63
64 boost::optional<double> sourceSideReferenceFlowRate() const;
65
66 bool isSourceSideReferenceFlowRateAutosized() const;
67
68 boost::optional<double> heatRecoveryReferenceFlowRate() const;
69
70 bool isHeatRecoveryReferenceFlowRateAutosized() const;
71
72 boost::optional<double> referenceCapacity() const;
73
74 bool isReferenceCapacityAutosized() const;
75
76 double referenceCoefficientofPerformance() const;
77
78 double sizingFactor() const;
79
80 Curve capacityModifierFunctionofTemperatureCurve() const;
81
82 Curve electricInputtoOutputRatioModifierFunctionofTemperatureCurve() const;
83
84 Curve electricInputtoOutputRatioModifierFunctionofPartLoadRatioCurve() const;
85
86 std::string controlType() const;
87
88 std::string flowMode() const;
89
90 double minimumPartLoadRatio() const;
91
92 double minimumSourceInletTemperature() const;
93
94 double maximumSourceInletTemperature() const;
95
96 boost::optional<Curve> minimumSupplyWaterTemperatureCurve() const;
97
98 boost::optional<Curve> maximumSupplyWaterTemperatureCurve() const;
99
100 double maximumHeatRecoveryOutletTemperature() const;
101
102 boost::optional<Curve> heatRecoveryCapacityModifierFunctionofTemperatureCurve() const;
103
104 boost::optional<Curve> heatRecoveryElectricInputtoOutputRatioModifierFunctionofTemperatureCurve() const;
105
106 boost::optional<Curve> thermosiphonCapacityFractionCurve() const;
107
108 double thermosiphonMinimumTemperatureDifference() const;
109
110 //@}
111 /** @name Setters */
112 //@{
113
114 bool setCondenserType(const std::string& condenserType);
115
116 bool setCompanionHeatingHeatPump(const HeatPumpPlantLoopEIRHeating& companionHP);
117
118 bool setLoadSideReferenceFlowRate(double loadSideReferenceFlowRate);
119
120 void autosizeLoadSideReferenceFlowRate();
121
122 bool setSourceSideReferenceFlowRate(double sourceSideReferenceFlowRate);
123
124 void autosizeSourceSideReferenceFlowRate();
125
126 bool setHeatRecoveryReferenceFlowRate(double heatRecoveryReferenceFlowRate);
127
128 void autosizeHeatRecoveryReferenceFlowRate();
129
130 bool setReferenceCapacity(double referenceCapacity);
131
132 void autosizeReferenceCapacity();
133
134 bool setReferenceCoefficientofPerformance(double referenceCoefficientofPerformance);
135
136 bool setSizingFactor(double sizingFactor);
137
138 bool setCapacityModifierFunctionofTemperatureCurve(const Curve& capacityModifierFunctionofTemperatureCurve);
139
140 bool setElectricInputtoOutputRatioModifierFunctionofTemperatureCurve(const Curve& electricInputtoOutputRatioModifierFunctionofTemperatureCurve);
141
142 bool
143 setElectricInputtoOutputRatioModifierFunctionofPartLoadRatioCurve(const Curve& electricInputtoOutputRatioModifierFunctionofPartLoadRatioCurve);
144
145 bool setControlType(const std::string& controlType);
146
147 bool setFlowMode(const std::string& flowMode);
148
149 bool setMinimumPartLoadRatio(double minimumPartLoadRatio);
150
151 bool setMinimumSourceInletTemperature(double minimumSourceInletTemperature);
152
153 bool setMaximumSourceInletTemperature(double maximumSourceInletTemperature);
154
155 bool setMinimumSupplyWaterTemperatureCurve(const Curve& minimumSupplyWaterTemperatureCurve);
156
157 void resetMinimumSupplyWaterTemperatureCurve();
158
159 bool setMaximumSupplyWaterTemperatureCurve(const Curve& maximumSupplyWaterTemperatureCurve);
160
161 void resetMaximumSupplyWaterTemperatureCurve();
162
163 bool setMaximumHeatRecoveryOutletTemperature(double maximumHeatRecoveryOutletTemperature);
164
165 bool setHeatRecoveryCapacityModifierFunctionofTemperatureCurve(const Curve& heatRecoveryCapacityModifierFunctionofTemperatureCurve);
166
167 void resetHeatRecoveryCapacityModifierFunctionofTemperatureCurve();
168
169 bool setHeatRecoveryElectricInputtoOutputRatioModifierFunctionofTemperatureCurve(
170 const Curve& heatRecoveryElectricInputtoOutputRatioModifierFunctionofTemperatureCurve);
171
172 void resetHeatRecoveryElectricInputtoOutputRatioModifierFunctionofTemperatureCurve();
173
174 bool setThermosiphonCapacityFractionCurve(const Curve& thermosiphonCapacityFractionCurve);
175
176 void resetThermosiphonCapacityFractionCurve();
177
178 bool setThermosiphonMinimumTemperatureDifference(double thermosiphonMinimumTemperatureDifference);
179
180 //@}
181 /** @name Other */
182 //@{
183
184 boost::optional<double> autosizedLoadSideReferenceFlowRate() const;
185
186 boost::optional<double> autosizedSourceSideReferenceFlowRate() const;
187
188 boost::optional<double> autosizedHeatRecoveryReferenceFlowRate() const;
189
190 boost::optional<double> autosizedReferenceCapacity() const;
191
192 /** Convenience Function to return the Load Side Water Loop (HeatPump on supply side) **/
193 boost::optional<PlantLoop> loadSideWaterLoop() const;
194
195 /** Convenience Function to return the Source Side (Condenser) Water Loop (HeatPump on demand side) **/
196 boost::optional<PlantLoop> sourceSideWaterLoop() const;
197
198 /** Convenience Function to return the Heat Recovery Loop (HeatPump on demand side - tertiary) **/
199 boost::optional<PlantLoop> heatRecoveryLoop() const;
200
201 // Convenience function to return the inletNode on the Source Side
202 boost::optional<Node> sourceSideWaterInletNode() const;
203 // Convenience function to return the outletNode on the Source Side
204 boost::optional<Node> sourceSideWaterOutletNode() const;
205
206 // Convenience function to return the inletNode on the Load Side
207 boost::optional<Node> loadSideWaterInletNode() const;
208 // Convenience function to return the outletNode on the Load Side
209 boost::optional<Node> loadSideWaterOutletNode() const;
210
211 // Convenience function to return the inletNode on the Heat Recovery
212 boost::optional<Node> heatRecoveryInletNode() const;
213 // Convenience function to return the outletNode on the Heat Recovery
214 boost::optional<Node> heatRecoveryOutletNode() const;
215
216 //@}
217 protected:
218 /// @cond
219 using ImplType = detail::HeatPumpPlantLoopEIRCooling_Impl;
220
221 explicit HeatPumpPlantLoopEIRCooling(std::shared_ptr<detail::HeatPumpPlantLoopEIRCooling_Impl> impl);
222
223 friend class detail::HeatPumpPlantLoopEIRCooling_Impl;
224 friend class Model;
225 friend class IdfObject;
226 friend class openstudio::detail::IdfObject_Impl;
227 /// @endcond
228 private:
229 − REGISTER_LOGGER("openstudio.model.HeatPumpPlantLoopEIRCooling");
230 };
231
232 /** \relates HeatPumpPlantLoopEIRCooling*/
233 using OptionalHeatPumpPlantLoopEIRCooling = boost::optional<HeatPumpPlantLoopEIRCooling>;
234
235 /** \relates HeatPumpPlantLoopEIRCooling*/
236 using HeatPumpPlantLoopEIRCoolingVector = std::vector<HeatPumpPlantLoopEIRCooling>;
237
238 } // namespace model
239 } // namespace openstudio
240
241 #endif // MODEL_HEATPUMPPLANTLOOPEIRCOOLING_HPP
242