GCC Code Coverage Report


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

src/model/CoilCoolingWater.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_COILCOOLINGWATER_HPP
7 #define MODEL_COILCOOLINGWATER_HPP
8
9 #include "ModelAPI.hpp"
10 #include "WaterToAirComponent.hpp"
11
12 namespace openstudio {
13
14 namespace model {
15
16 class Schedule;
17 class AirflowNetworkEquivalentDuct;
18 class ControllerWaterCoil;
19
20 namespace detail {
21 class CoilCoolingWater_Impl;
22 } // namespace detail
23
24 /** CoilCoolingWater is a WaterToAirComponent that wraps the IDD object named
25 * "OS:Coil:Cooling:Water".
26 *
27 * Polymorphic behavior:
28 * <ol>
29 * <li> bool addToNode(Node & node);</li>
30 * <ul>
31 * <li>inherited from HVACComponent</li>
32 * <li>Adds this coil to node. If the coil is not allowed at the given node
33 * returns false. If controllerWaterCoil is associated with this coil, then
34 * the controller's sensor node will be set to the air outlet node.</li>
35 * </ul>
36 * </ol>
37 */
38 class MODEL_API CoilCoolingWater : public WaterToAirComponent
39 {
40 public:
41 /** @name Constructors and Destructors */
42 //@{
43
44 /** Constructs a new CoilCoolingWater object and places it inside the
45 * model. The coil is fully initialized with all companion objects. */
46 CoilCoolingWater(const Model& model, Schedule& availableSchedule);
47
48 CoilCoolingWater(const Model& model);
49
50 220 virtual ~CoilCoolingWater() override = default;
51 // Default the copy and move operators because the virtual dtor is explicit
52 ✗ CoilCoolingWater(const CoilCoolingWater& other) = default;
53 51 CoilCoolingWater(CoilCoolingWater&& other) = default;
54 ✗ CoilCoolingWater& operator=(const CoilCoolingWater&) = default;
55 ✗ CoilCoolingWater& operator=(CoilCoolingWater&&) = default;
56
57 //@}
58
59 static IddObjectType iddObjectType();
60
61 /** @name Getters and Setters */
62 //@{
63
64 /** Returns the schedule referred to by the Availability Schedule Name field. **/
65 Schedule availabilitySchedule() const;
66
67 /** \deprecated */
68 Schedule availableSchedule() const;
69
70 /** Sets the schedule referred to by the Availability Schedule Name field. **/
71 bool setAvailabilitySchedule(Schedule& schedule);
72
73 /** \deprecated */
74 bool setAvailableSchedule(Schedule& schedule);
75
76 /** Returns the value of the DesignWaterFlowRate field. **/
77 boost::optional<double> designWaterFlowRate();
78
79 /** Sets the value of the DesignWaterFlowRate field. **/
80 bool setDesignWaterFlowRate(double value);
81
82 /** Returns true if the DesignWaterFlowRate field is set to autosize **/
83 bool isDesignWaterFlowRateAutosized();
84
85 /** Set the DesignWaterFlowRate field to autosize **/
86 void autosizeDesignWaterFlowRate();
87
88 /** Returns the value of the DesignAirFlowRate field. **/
89 boost::optional<double> designAirFlowRate();
90
91 /** Sets the value of the DesignAirFlowRate field. **/
92 bool setDesignAirFlowRate(double value);
93
94 /** Returns true if the DesignAirFlowRate field is set to autosize **/
95 bool isDesignAirFlowRateAutosized();
96
97 /** Set the DesignAirFlowRate field to autosize **/
98 void autosizeDesignAirFlowRate();
99
100 /** Returns the value of the DesignInletWaterTemperature field. **/
101 boost::optional<double> designInletWaterTemperature();
102
103 /** Sets the value of the DesignInletWaterTemperature field. **/
104 bool setDesignInletWaterTemperature(double value);
105
106 /** Returns true if the DesignInletWaterTemperature field is set to autosize **/
107 bool isDesignInletWaterTemperatureAutosized();
108
109 /** Set the DesignInletWaterTemperature field to autosize **/
110 void autosizeDesignInletWaterTemperature();
111
112 /** Returns the value of the DesignInletAirTemperature field. **/
113 boost::optional<double> designInletAirTemperature();
114
115 /** Sets the value of the DesignInletAirTemperature field. **/
116 bool setDesignInletAirTemperature(double value);
117
118 /** Returns true if the DesignInletAirTemperature field is set to autosize **/
119 bool isDesignInletAirTemperatureAutosized();
120
121 /** Set the DesignInletAirTemperature field to autosize **/
122 void autosizeDesignInletAirTemperature();
123
124 /** Returns the value of the DesignOutletAirTemperature field. **/
125 boost::optional<double> designOutletAirTemperature();
126
127 /** Sets the value of the DesignOutletAirTemperature field. **/
128 bool setDesignOutletAirTemperature(double value);
129
130 /** Returns true if the DesignOutletAirTemperature field is set to autosize **/
131 bool isDesignOutletAirTemperatureAutosized();
132
133 /** Set the DesignOutletAirTemperature field to autosize **/
134 void autosizeDesignOutletAirTemperature();
135
136 /** Returns the value of the DesignInletAirHumidityRatio field. **/
137 boost::optional<double> designInletAirHumidityRatio();
138
139 /** Sets the value of the DesignInletAirHumidityRatio field. **/
140 bool setDesignInletAirHumidityRatio(double value);
141
142 /** Returns true if the DesignInletAirHumidityRatio field is set to autosize **/
143 bool isDesignInletAirHumidityRatioAutosized();
144
145 /** Set the DesignInletAirHumidityRatio field to autosize **/
146 void autosizeDesignInletAirHumidityRatio();
147
148 /** Returns the value of the DesignOutletAirHumidityRatio field. **/
149 boost::optional<double> designOutletAirHumidityRatio();
150
151 /** Sets the value of the DesignOutletAirHumidityRatio field. **/
152 bool setDesignOutletAirHumidityRatio(double value);
153
154 /** Returns true if the DesignOutletAirHumidityRatio field is set to autosize **/
155 bool isDesignOutletAirHumidityRatioAutosized();
156
157 /** Set the DesignOutletAirHumidityRatio field to autosize **/
158 void autosizeDesignOutletAirHumidityRatio();
159
160 /** Returns the value of the TypeOfAnalysis field. **/
161 std::string typeOfAnalysis();
162
163 /** Sets the value of the TypeOfAnalysis field.
164 * Options are SimpleAnalysis and DetailedAnalysis
165 */
166 bool setTypeOfAnalysis(const std::string& value);
167
168 /** Returns the value of the HeatExchangerConfiguration field. **/
169 std::string heatExchangerConfiguration();
170
171 /** Sets the value of the HeatExchangerConfiguration field.
172 * Options are CrossFlow and CounterFlow.
173 */
174 bool setHeatExchangerConfiguration(const std::string& value);
175
176 /** Returns the optional ControllerWaterCoil associated with this coil.
177 */
178 boost::optional<ControllerWaterCoil> controllerWaterCoil();
179
180 /** Creates a new equivalent duct object if an object is not already attached. */
181 AirflowNetworkEquivalentDuct getAirflowNetworkEquivalentDuct(double length, double diameter);
182
183 /** Returns the attached equivalent duct object, if any. */
184 boost::optional<AirflowNetworkEquivalentDuct> airflowNetworkEquivalentDuct() const;
185
186 boost::optional<double> autosizedDesignWaterFlowRate() const;
187
188 boost::optional<double> autosizedDesignAirFlowRate() const;
189
190 boost::optional<double> autosizedDesignInletWaterTemperature() const;
191
192 boost::optional<double> autosizedDesignInletAirTemperature() const;
193
194 boost::optional<double> autosizedDesignOutletAirTemperature() const;
195
196 boost::optional<double> autosizedDesignInletAirHumidityRatio() const;
197
198 boost::optional<double> autosizedDesignOutletAirHumidityRatio() const;
199
200 // Not part of the applySizingValues
201 boost::optional<double> autosizedDesignCoilLoad() const;
202
203 //@}
204 protected:
205 friend class Model;
206
207 friend class openstudio::IdfObject;
208
209 friend class openstudio::detail::IdfObject_Impl;
210
211 /// @cond
212 using ImplType = detail::CoilCoolingWater_Impl;
213
214 explicit CoilCoolingWater(std::shared_ptr<detail::CoilCoolingWater_Impl> impl);
215
216 private:
217 REGISTER_LOGGER("openstudio.model.CoilCoolingWater");
218
219 CoilCoolingWater(const Handle& handle, const Model& model);
220
221 /// @endcond
222
223 }; // detail
224
225 using OptionalCoilCoolingWater = boost::optional<CoilCoolingWater>;
226
227 } // namespace model
228 } // namespace openstudio
229
230 #endif // MODEL_COILCOOLINGWATER_HPP
231