GCC Code Coverage Report


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

src/model/HeatPumpPlantLoopEIRHeating_Impl.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_HEATPUMPPLANTLOOPEIRHEATING_IMPL_HPP
7 #define MODEL_HEATPUMPPLANTLOOPEIRHEATING_IMPL_HPP
8
9 #include "ModelAPI.hpp"
10 #include "WaterToWaterComponent_Impl.hpp"
11
12 namespace openstudio {
13
14 namespace model {
15
16 class HeatPumpPlantLoopEIRCooling;
17 class Curve;
18
19 namespace detail {
20
21 /** HeatPumpPlantLoopEIRHeating_Impl is a WaterToWaterComponent_Impl that is the implementation class for HeatPumpPlantLoopEIRHeating.*/
22 class MODEL_API HeatPumpPlantLoopEIRHeating_Impl : public WaterToWaterComponent_Impl
23 {
24 public:
25 /** @name Constructors and Destructors */
26 //@{
27
28 HeatPumpPlantLoopEIRHeating_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle);
29
30 HeatPumpPlantLoopEIRHeating_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle);
31
32 HeatPumpPlantLoopEIRHeating_Impl(const HeatPumpPlantLoopEIRHeating_Impl& other, Model_Impl* model, bool keepHandle);
33
34 22 virtual ~HeatPumpPlantLoopEIRHeating_Impl() override = default;
35
36 //@}
37 /** @name Virtual Methods */
38 //@{
39
40 virtual const std::vector<std::string>& outputVariableNames() const override;
41
42 virtual IddObjectType iddObjectType() const override;
43
44 virtual unsigned supplyInletPort() const override;
45
46 virtual unsigned supplyOutletPort() const override;
47
48 virtual unsigned demandInletPort() const override;
49
50 virtual unsigned demandOutletPort() const override;
51
52 virtual unsigned tertiaryInletPort() const override;
53
54 virtual unsigned tertiaryOutletPort() const override;
55
56 /* This function will call the base class' method WaterToWaterComponent_Impl::addToNode()
57 * If this is connecting to the demand side of a loop, will set the condenserType to 'WaterSource'
58 */
59 virtual bool addToNode(Node& node) override;
60
61 /* Restricts addToTertiaryNode to a node that is on the demand side of a plant loop (tertiary = Heat Recovery Loop) */
62 virtual bool addToTertiaryNode(Node& node) override;
63
64 /** Override to switch the condenser type to 'AirSource' **/
65 virtual bool removeFromSecondaryPlantLoop() override;
66
67 virtual void autosize() override;
68
69 virtual void applySizingValues() override;
70
71 virtual ComponentType componentType() const override;
72 virtual std::vector<FuelType> coolingFuelTypes() const override;
73 virtual std::vector<FuelType> heatingFuelTypes() const override;
74 virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override;
75
76 //@}
77 /** @name Getters */
78 //@{
79
80 std::string condenserType() const;
81
82 boost::optional<HeatPumpPlantLoopEIRCooling> companionCoolingHeatPump() const;
83
84 boost::optional<double> loadSideReferenceFlowRate() const;
85
86 bool isLoadSideReferenceFlowRateAutosized() const;
87
88 boost::optional<double> sourceSideReferenceFlowRate() const;
89
90 bool isSourceSideReferenceFlowRateAutosized() const;
91
92 boost::optional<double> heatRecoveryReferenceFlowRate() const;
93
94 bool isHeatRecoveryReferenceFlowRateAutosized() const;
95
96 boost::optional<double> referenceCapacity() const;
97
98 bool isReferenceCapacityAutosized() const;
99
100 double referenceCoefficientofPerformance() const;
101
102 double sizingFactor() const;
103
104 Curve capacityModifierFunctionofTemperatureCurve() const;
105
106 Curve electricInputtoOutputRatioModifierFunctionofTemperatureCurve() const;
107
108 Curve electricInputtoOutputRatioModifierFunctionofPartLoadRatioCurve() const;
109
110 double heatingToCoolingCapacitySizingRatio() const;
111
112 std::string heatPumpSizingMethod() const;
113
114 std::string controlType() const;
115
116 std::string flowMode() const;
117
118 double minimumPartLoadRatio() const;
119
120 double minimumSourceInletTemperature() const;
121
122 double maximumSourceInletTemperature() const;
123
124 boost::optional<Curve> minimumSupplyWaterTemperatureCurve() const;
125
126 boost::optional<Curve> maximumSupplyWaterTemperatureCurve() const;
127
128 boost::optional<Curve> dryOutdoorCorrectionFactorCurve() const;
129
130 double maximumOutdoorDryBulbTemperatureForDefrostOperation() const;
131
132 std::string heatPumpDefrostControl() const;
133
134 double heatPumpDefrostTimePeriodFraction() const;
135
136 boost::optional<Curve> defrostEnergyInputRatioFunctionofTemperatureCurve() const;
137
138 boost::optional<Curve> timedEmpiricalDefrostFrequencyCurve() const;
139
140 boost::optional<Curve> timedEmpiricalDefrostHeatLoadPenaltyCurve() const;
141
142 boost::optional<Curve> timedEmpiricalDefrostHeatInputEnergyFractionCurve() const;
143
144 double minimumHeatRecoveryOutletTemperature() const;
145
146 boost::optional<Curve> heatRecoveryCapacityModifierFunctionofTemperatureCurve() const;
147
148 boost::optional<Curve> heatRecoveryElectricInputtoOutputRatioModifierFunctionofTemperatureCurve() const;
149
150 //@}
151 /** @name Setters */
152 //@{
153
154 bool setCondenserType(const std::string& condenserType);
155
156 bool setCompanionCoolingHeatPump(const HeatPumpPlantLoopEIRCooling& companionHP);
157
158 bool setLoadSideReferenceFlowRate(double loadSideReferenceFlowRate);
159
160 void autosizeLoadSideReferenceFlowRate();
161
162 bool setSourceSideReferenceFlowRate(double sourceSideReferenceFlowRate);
163
164 void autosizeSourceSideReferenceFlowRate();
165
166 bool setHeatRecoveryReferenceFlowRate(double heatRecoveryReferenceFlowRate);
167
168 void autosizeHeatRecoveryReferenceFlowRate();
169
170 bool setReferenceCapacity(double referenceCapacity);
171
172 void autosizeReferenceCapacity();
173
174 bool setReferenceCoefficientofPerformance(double referenceCoefficientofPerformance);
175
176 bool setSizingFactor(double sizingFactor);
177
178 bool setCapacityModifierFunctionofTemperatureCurve(const Curve& capacityModifierFunctionofTemperatureCurve);
179
180 bool setElectricInputtoOutputRatioModifierFunctionofTemperatureCurve(const Curve& electricInputtoOutputRatioModifierFunctionofTemperatureCurve);
181
182 bool setElectricInputtoOutputRatioModifierFunctionofPartLoadRatioCurve(
183 const Curve& electricInputtoOutputRatioModifierFunctionofPartLoadRatioCurve);
184
185 bool setHeatingToCoolingCapacitySizingRatio(double heatingToCoolingCapacitySizingRatio);
186
187 bool setHeatPumpSizingMethod(const std::string& heatPumpSizingMethod);
188
189 bool setControlType(const std::string& controlType);
190
191 bool setFlowMode(const std::string& flowMode);
192
193 bool setMinimumPartLoadRatio(double minimumPartLoadRatio);
194
195 bool setMinimumSourceInletTemperature(double minimumSourceInletTemperature);
196
197 bool setMaximumSourceInletTemperature(double maximumSourceInletTemperature);
198
199 bool setMinimumSupplyWaterTemperatureCurve(const Curve& minimumSupplyWaterTemperatureCurve);
200
201 void resetMinimumSupplyWaterTemperatureCurve();
202
203 bool setMaximumSupplyWaterTemperatureCurve(const Curve& maximumSupplyWaterTemperatureCurve);
204
205 void resetMaximumSupplyWaterTemperatureCurve();
206
207 bool setDryOutdoorCorrectionFactorCurve(const Curve& dryOutdoorCorrectionFactorCurve);
208
209 void resetDryOutdoorCorrectionFactorCurve();
210
211 bool setMaximumOutdoorDryBulbTemperatureForDefrostOperation(double maximumOutdoorDryBulbTemperatureForDefrostOperation);
212
213 bool setHeatPumpDefrostControl(const std::string& heatPumpDefrostControl);
214
215 bool setHeatPumpDefrostTimePeriodFraction(double heatPumpDefrostTimePeriodFraction);
216
217 bool setDefrostEnergyInputRatioFunctionofTemperatureCurve(const Curve& defrostEnergyInputRatioFunctionofTemperatureCurve);
218
219 void resetDefrostEnergyInputRatioFunctionofTemperatureCurve();
220
221 bool setTimedEmpiricalDefrostFrequencyCurve(const Curve& timedEmpiricalDefrostFrequencyCurve);
222
223 void resetTimedEmpiricalDefrostFrequencyCurve();
224
225 bool setTimedEmpiricalDefrostHeatLoadPenaltyCurve(const Curve& timedEmpiricalDefrostHeatLoadPenaltyCurve);
226
227 void resetTimedEmpiricalDefrostHeatLoadPenaltyCurve();
228
229 bool setTimedEmpiricalDefrostHeatInputEnergyFractionCurve(const Curve& timedEmpiricalDefrostHeatInputEnergyFractionCurve);
230
231 void resetTimedEmpiricalDefrostHeatInputEnergyFractionCurve();
232
233 bool setMinimumHeatRecoveryOutletTemperature(double minimumHeatRecoveryOutletTemperature);
234
235 bool setHeatRecoveryCapacityModifierFunctionofTemperatureCurve(const Curve& heatRecoveryCapacityModifierFunctionofTemperatureCurve);
236
237 void resetHeatRecoveryCapacityModifierFunctionofTemperatureCurve();
238
239 bool setHeatRecoveryElectricInputtoOutputRatioModifierFunctionofTemperatureCurve(
240 const Curve& heatRecoveryElectricInputtoOutputRatioModifierFunctionofTemperatureCurve);
241
242 void resetHeatRecoveryElectricInputtoOutputRatioModifierFunctionofTemperatureCurve();
243
244 //@}
245 /** @name Other */
246 //@{
247
248 boost::optional<double> autosizedLoadSideReferenceFlowRate() const;
249
250 boost::optional<double> autosizedSourceSideReferenceFlowRate() const;
251
252 boost::optional<double> autosizedHeatRecoveryReferenceFlowRate() const;
253
254 boost::optional<double> autosizedReferenceCapacity() const;
255
256 /** Convenience Function to return the Load Side Water Loop (HeatPump on supply side) **/
257 boost::optional<PlantLoop> loadSideWaterLoop() const;
258
259 /** Convenience Function to return the Source Side (Condenser) Water Loop (HeatPump on demand side) **/
260 boost::optional<PlantLoop> sourceSideWaterLoop() const;
261
262 /** Convenience Function to return the Heat Recovery Loop (HeatPump on demand side - tertiary) **/
263 boost::optional<PlantLoop> heatRecoveryLoop() const;
264
265 // Convenience function to return the inletNode on the Source Side
266 boost::optional<Node> sourceSideWaterInletNode() const;
267 // Convenience function to return the outletNode on the Source Side
268 boost::optional<Node> sourceSideWaterOutletNode() const;
269
270 // Convenience function to return the inletNode on the Load Side
271 boost::optional<Node> loadSideWaterInletNode() const;
272 // Convenience function to return the outletNode on the Load Side
273 boost::optional<Node> loadSideWaterOutletNode() const;
274
275 // Convenience function to return the inletNode on the Heat Recovery
276 boost::optional<Node> heatRecoveryInletNode() const;
277 // Convenience function to return the outletNode on the Heat Recovery
278 boost::optional<Node> heatRecoveryOutletNode() const;
279
280 //@}
281 protected:
282 private:
283 − REGISTER_LOGGER("openstudio.model.HeatPumpPlantLoopEIRHeating");
284 };
285
286 } // namespace detail
287
288 } // namespace model
289 } // namespace openstudio
290
291 #endif // MODEL_HEATPUMPPLANTLOOPEIRHEATING_IMPL_HPP
292