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/CoilWaterHeatingDesuperheater.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_COILWATERHEATINGDESUPERHEATER_HPP
7 #define MODEL_COILWATERHEATINGDESUPERHEATER_HPP
8
9 #include "ModelAPI.hpp"
10 #include "StraightComponent.hpp"
11
12 namespace openstudio {
13
14 namespace model {
15
16 class Schedule;
17 class CurveBiquadratic;
18 class HVACComponent;
19
20 namespace detail {
21
22 class CoilWaterHeatingDesuperheater_Impl;
23
24 } // namespace detail
25
26 /** CoilWaterHeatingDesuperheater is a StraightComponent that wraps the OpenStudio IDD object 'OS:Coil:WaterHeating:Desuperheater'. */
27 class MODEL_API CoilWaterHeatingDesuperheater : public StraightComponent
28 {
29 public:
30 /** @name Constructors and Destructors */
31 //@{
32
33 explicit CoilWaterHeatingDesuperheater(const Model& model, Schedule& setpointTemperatureSchedule);
34
35 38 virtual ~CoilWaterHeatingDesuperheater() override = default;
36 // Default the copy and move operators because the virtual dtor is explicit
37 ✗ CoilWaterHeatingDesuperheater(const CoilWaterHeatingDesuperheater& other) = default;
38 3 CoilWaterHeatingDesuperheater(CoilWaterHeatingDesuperheater&& other) = default;
39 ✗ CoilWaterHeatingDesuperheater& operator=(const CoilWaterHeatingDesuperheater&) = default;
40 ✗ CoilWaterHeatingDesuperheater& operator=(CoilWaterHeatingDesuperheater&&) = default;
41
42 //@}
43
44 static IddObjectType iddObjectType();
45
46 boost::optional<ModelObject> heatRejectionTarget() const;
47
48 /** \fn bool addToHeatRejectionTarget(const ModelObject& heatRejectionTarget)
49 \brief Sets the heating rejection target from which the desuperheater heating coil rejects energy.
50 \param[in] heatRejectionTarget The heating rejection target.
51
52 Valid input: \n
53 \ref WaterHeaterMixed
54 \ref WaterHeaterStratified
55 */
56 bool addToHeatRejectionTarget(const ModelObject& heatRejectionTarget);
57
58 void removeFromHeatRejectionTarget();
59
60 /** @name Getters */
61 //@{
62
63 Schedule availabilitySchedule() const;
64
65 Schedule setpointTemperatureSchedule() const;
66
67 double deadBandTemperatureDifference() const;
68
69 bool isDeadBandTemperatureDifferenceDefaulted() const;
70
71 boost::optional<double> ratedHeatReclaimRecoveryEfficiency() const;
72
73 double ratedInletWaterTemperature() const;
74
75 double ratedOutdoorAirTemperature() const;
76
77 double maximumInletWaterTemperatureforHeatReclaim() const;
78
79 boost::optional<CurveBiquadratic> heatReclaimEfficiencyFunctionofTemperatureCurve() const;
80
81 // boost::optional<HVACComponent> tank() const;
82
83 boost::optional<ModelObject> heatingSource() const;
84
85 double waterFlowRate() const;
86
87 double waterPumpPower() const;
88
89 bool isWaterPumpPowerDefaulted() const;
90
91 double fractionofPumpHeattoWater() const;
92
93 bool isFractionofPumpHeattoWaterDefaulted() const;
94
95 double onCycleParasiticElectricLoad() const;
96
97 bool isOnCycleParasiticElectricLoadDefaulted() const;
98
99 double offCycleParasiticElectricLoad() const;
100
101 bool isOffCycleParasiticElectricLoadDefaulted() const;
102
103 //@}
104 /** @name Setters */
105 //@{
106
107 bool setAvailabilitySchedule(Schedule& schedule);
108
109 void resetAvailabilitySchedule();
110
111 bool setSetpointTemperatureSchedule(Schedule& schedule);
112
113 bool setDeadBandTemperatureDifference(double deadBandTemperatureDifference);
114
115 void resetDeadBandTemperatureDifference();
116
117 bool setRatedHeatReclaimRecoveryEfficiency(double ratedHeatReclaimRecoveryEfficiency);
118
119 void resetRatedHeatReclaimRecoveryEfficiency();
120
121 bool setRatedInletWaterTemperature(double ratedInletWaterTemperature);
122
123 bool setRatedOutdoorAirTemperature(double ratedOutdoorAirTemperature);
124
125 bool setMaximumInletWaterTemperatureforHeatReclaim(double maximumInletWaterTemperatureforHeatReclaim);
126
127 bool setHeatReclaimEfficiencyFunctionofTemperatureCurve(const CurveBiquadratic& curveBiquadratic);
128
129 void resetHeatReclaimEfficiencyFunctionofTemperatureCurve();
130
131 // bool setTank(const HVACComponent& waterHeater);
132
133 /** \fn bool setHeatingSource(const ModelObject& heatingSource)
134 \brief Sets the heating source from which the desuperheater heating coil recovers energy.
135 \param[in] heatingSource The heating source.
136
137 Valid inputs: \n
138 \ref CoilCoolingDXSingleSpeed \n
139 \ref CoilCoolingDXTwoSpeed \n
140 \ref CoilCoolingDXTwoStageWithHumidityControlMode \n
141 \ref CoilCoolingDXVariableSpeed \n
142 \ref CoilCoolingDxMultiSpeed \n
143 \ref CoilCoolingWaterToAirHeatPumpEquationFit \n
144 \ref RefrigerationCompressorRack \n
145 \ref RefrigerationCondenserAirCooled \n
146 \ref RefrigerationCondenserEvaporativeCooled \n
147 \ref RefrigerationCondenserWaterCooled \n
148 */
149 bool setHeatingSource(const ModelObject& heatingSource);
150
151 void resetHeatingSource();
152
153 bool setWaterFlowRate(double waterFlowRate);
154
155 bool setWaterPumpPower(double waterPumpPower);
156
157 void resetWaterPumpPower();
158
159 bool setFractionofPumpHeattoWater(double fractionofPumpHeattoWater);
160
161 void resetFractionofPumpHeattoWater();
162
163 bool setOnCycleParasiticElectricLoad(double onCycleParasiticElectricLoad);
164
165 void resetOnCycleParasiticElectricLoad();
166
167 bool setOffCycleParasiticElectricLoad(double offCycleParasiticElectricLoad);
168
169 void resetOffCycleParasiticElectricLoad();
170
171 //@}
172 /** @name Other */
173 //@{
174
175 //@}
176 protected:
177 /// @cond
178 using ImplType = detail::CoilWaterHeatingDesuperheater_Impl;
179
180 explicit CoilWaterHeatingDesuperheater(std::shared_ptr<detail::CoilWaterHeatingDesuperheater_Impl> impl);
181
182 friend class detail::CoilWaterHeatingDesuperheater_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.CoilWaterHeatingDesuperheater");
189 };
190
191 /** \relates CoilWaterHeatingDesuperheater*/
192 using OptionalCoilWaterHeatingDesuperheater = boost::optional<CoilWaterHeatingDesuperheater>;
193
194 /** \relates CoilWaterHeatingDesuperheater*/
195 using CoilWaterHeatingDesuperheaterVector = std::vector<CoilWaterHeatingDesuperheater>;
196
197 } // namespace model
198 } // namespace openstudio
199
200 #endif // MODEL_COILWATERHEATINGDESUPERHEATER_HPP
201