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/CoilHeatingWater.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_COILHEATINGWATER_HPP
7 #define MODEL_COILHEATINGWATER_HPP
8
9 #include "ModelAPI.hpp"
10 #include "WaterToAirComponent.hpp"
11
12 namespace openstudio {
13 namespace model {
14
15 class Schedule;
16 class ControllerWaterCoil;
17 class AirflowNetworkEquivalentDuct;
18
19 namespace detail {
20 class CoilHeatingWater_Impl;
21 } // namespace detail
22
23 /** CoilHeatingWater is a WaterToAirComponent that wraps the IDD object named
24 * "OS:Coil:Heating:Water".
25 *
26 * Polymorphic behavior:
27 * <ol>
28 * <li> bool addToNode(Node& node);</li>
29 * <ul>
30 * <li>inherited from HVACComponent</li>
31 * <li>Adds this coil to node. If the coil is not allowed at the given node
32 * returns false. If controllerWaterCoil is associated with this coil, then
33 * the controller's sensor node will be set to the air outlet node.</li>
34 * </ul>
35 * </ol>
36 */
37 class MODEL_API CoilHeatingWater : public WaterToAirComponent
38 {
39 public:
40 /** @name Constructors and Destructors */
41 //@{
42
43 CoilHeatingWater(const Model& model, Schedule& availableSchedule);
44
45 CoilHeatingWater(const Model& model);
46
47 224 virtual ~CoilHeatingWater() override = default;
48 // Default the copy and move operators because the virtual dtor is explicit
49 ✗ CoilHeatingWater(const CoilHeatingWater& other) = default;
50 45 CoilHeatingWater(CoilHeatingWater&& other) = default;
51 ✗ CoilHeatingWater& operator=(const CoilHeatingWater&) = default;
52 ✗ CoilHeatingWater& operator=(CoilHeatingWater&&) = default;
53
54 //@}
55
56 static IddObjectType iddObjectType();
57
58 /** @name Getters and Setters */
59 //@{
60
61 /** Returns the schedule referred to by the Availability Schedule Name field. **/
62 Schedule availabilitySchedule() const;
63
64 /** \deprecated */
65 Schedule availableSchedule() const;
66
67 /** Sets the schedule referred to by the Availability Schedule Name field. **/
68 bool setAvailabilitySchedule(Schedule& schedule);
69
70 /** \deprecated */
71 bool setAvailableSchedule(Schedule& schedule);
72
73 /** Returns the value of the UFactorTimesAreaValue field. **/
74 boost::optional<double> uFactorTimesAreaValue();
75
76 /** Sets the value of the UFactorTimesAreaValue field. **/
77 bool setUFactorTimesAreaValue(double value);
78
79 /** Returns true if the UFactorTimesAreaValue field is set to autosize **/
80 bool isUFactorTimesAreaValueAutosized();
81
82 /** Sets the UFactorTimesAreaValue field to autosize **/
83 void autosizeUFactorTimesAreaValue();
84
85 /** Returns the value of the MaximumWaterFlowRate field. **/
86 boost::optional<double> maximumWaterFlowRate();
87
88 /** Sets the value of the MaximumWaterFlowRate field. **/
89 bool setMaximumWaterFlowRate(double value);
90
91 /** Returns true if the MaximumWaterFlowRate field is set to autosize **/
92 bool isMaximumWaterFlowRateAutosized();
93
94 /** Sets the MaximumWaterFlowRate field to autosize **/
95 void autosizeMaximumWaterFlowRate();
96
97 /** Returns the value of the PerformanceInputMethod field. **/
98 std::string performanceInputMethod();
99
100 /** Sets the value of the PerformanceInputMethod field.
101 * Options are UFactorTimesAreaAndDesignWaterFlowRate and NominalCapacity.
102 */
103 bool setPerformanceInputMethod(const std::string& value);
104
105 /** Returns the value of the RatedCapacity field. **/
106 boost::optional<double> ratedCapacity();
107
108 /** Sets the value of the RatedCapacity field. **/
109 bool setRatedCapacity(double value);
110
111 /** Returns true if the RatedCapacity field is set to autosize **/
112 bool isRatedCapacityAutosized();
113
114 /** Sets the RatedCapacity field to autosize **/
115 void autosizeRatedCapacity();
116
117 /** Returns the value of RatedInletWaterTemperature field. **/
118 double ratedInletWaterTemperature();
119
120 /** Sets the value of RatedInletWaterTemperature field. **/
121 bool setRatedInletWaterTemperature(double value);
122
123 /** Returns the value of RatedInletWaterTemperature field. **/
124 double ratedInletAirTemperature();
125
126 /** Sets the value of RatedInletWaterTemperature field. **/
127 bool setRatedInletAirTemperature(double value);
128
129 /** Returns the value of RatedOutletWaterTemperature field. **/
130 double ratedOutletWaterTemperature();
131
132 /** Sets the value of RatedOutletWaterTemperature field. **/
133 bool setRatedOutletWaterTemperature(double value);
134
135 /** Returns the value of RatedOutletAirTemperature field. **/
136 double ratedOutletAirTemperature();
137
138 /** Sets the value of RatedOutletAirTemperature field. **/
139 bool setRatedOutletAirTemperature(double value);
140
141 /** Returns the value of RatedRatioForAirAndWaterConvection field. **/
142 double ratedRatioForAirAndWaterConvection();
143
144 /** Sets the value of RatedRatioForAirAndWaterConvection field. **/
145 bool setRatedRatioForAirAndWaterConvection(double value);
146
147 /** Returns the optional ControllerWaterCoil associated with this coil.
148 */
149 boost::optional<ControllerWaterCoil> controllerWaterCoil();
150
151 boost::optional<double> autosizedUFactorTimesAreaValue() const;
152
153 boost::optional<double> autosizedMaximumWaterFlowRate() const;
154
155 boost::optional<double> autosizedRatedCapacity() const;
156
157 //@}
158 /** @name Other */
159 //@{
160
161 /** Creates a new equivalent duct object if an object is not already attached. */
162 AirflowNetworkEquivalentDuct getAirflowNetworkEquivalentDuct(double length, double diameter);
163
164 /** Returns the attached equivalent duct object, if any. */
165 boost::optional<AirflowNetworkEquivalentDuct> airflowNetworkEquivalentDuct() const;
166
167 //@}
168 protected:
169 friend class Model;
170
171 friend class openstudio::IdfObject;
172 friend class openstudio::detail::IdfObject_Impl;
173
174 /// @cond
175 using ImplType = detail::CoilHeatingWater_Impl;
176
177 explicit CoilHeatingWater(std::shared_ptr<detail::CoilHeatingWater_Impl> impl);
178
179 private:
180 REGISTER_LOGGER("openstudio.model.CoilHeatingWater");
181
182 CoilHeatingWater(const Handle& handle, const Model& model);
183
184 /// @endcond
185 }; // detail
186
187 using OptionalCoilHeatingWater = boost::optional<CoilHeatingWater>;
188
189 } // namespace model
190 } // namespace openstudio
191
192 #endif // MODEL_COILHEATINGWATER_HPP
193