GCC Code Coverage Report


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

src/model/GroundHeatExchangerVertical_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_GROUNDHEATEXCHANGERVERTICAL_IMPL_HPP
7 #define MODEL_GROUNDHEATEXCHANGERVERTICAL_IMPL_HPP
8
9 #include "ModelAPI.hpp"
10 #include "StraightComponent_Impl.hpp"
11
12 namespace openstudio {
13
14 namespace model {
15 namespace detail {
16
17 /** GroundHeatExchangerVertical_Impl is a StraightComponent_Impl that is the implementation class for GroundHeatExchangerVertical.*/
18 class MODEL_API GroundHeatExchangerVertical_Impl : public StraightComponent_Impl
19 {
20 public:
21 /** @name Constructors and Destructors */
22 //@{
23
24 GroundHeatExchangerVertical_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle);
25
26 GroundHeatExchangerVertical_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle);
27
28 GroundHeatExchangerVertical_Impl(const GroundHeatExchangerVertical_Impl& other, Model_Impl* model, bool keepHandle);
29
30 26 virtual ~GroundHeatExchangerVertical_Impl() override = default;
31
32 //@}
33 /** @name Virtual Methods */
34 //@{
35
36 virtual const std::vector<std::string>& outputVariableNames() const override;
37
38 virtual IddObjectType iddObjectType() const override;
39
40 virtual ModelObject clone(Model model) const override;
41
42 virtual unsigned inletPort() const override;
43
44 virtual unsigned outletPort() const override;
45
46 virtual bool addToNode(Node& node) override;
47
48 virtual ComponentType componentType() const override;
49 virtual std::vector<FuelType> coolingFuelTypes() const override;
50 virtual std::vector<FuelType> heatingFuelTypes() const override;
51 virtual std::vector<AppGFuelType> appGHeatingFuelTypes() const override;
52
53 //@}
54 /** @name Getters */
55 //@{
56
57 boost::optional<int> numberofBoreHoles() const;
58
59 double boreHoleTopDepth() const;
60
61 boost::optional<double> boreHoleLength() const;
62
63 boost::optional<double> boreHoleRadius() const;
64
65 boost::optional<double> groundThermalConductivity() const;
66
67 boost::optional<double> groundThermalHeatCapacity() const;
68
69 boost::optional<double> groundTemperature() const;
70
71 boost::optional<double> designFlowRate() const;
72
73 boost::optional<double> groutThermalConductivity() const;
74
75 boost::optional<double> pipeThermalConductivity() const;
76
77 boost::optional<double> pipeOutDiameter() const;
78
79 boost::optional<double> uTubeDistance() const;
80
81 boost::optional<double> pipeThickness() const;
82
83 boost::optional<double> maximumLengthofSimulation() const;
84
85 double gFunctionReferenceRatio() const;
86
87 bool isGFunctionReferenceRatioDefaulted() const;
88
89 ModelObject undisturbedGroundTemperatureModel() const;
90
91 //@}
92 /** @name Setters */
93 //@{
94
95 bool setNumberofBoreHoles(boost::optional<int> numberofBoreHoles);
96
97 void resetNumberofBoreHoles();
98
99 bool setBoreHoleTopDepth(double boreHoleTopDepth);
100
101 bool setBoreHoleLength(boost::optional<double> boreHoleLength);
102
103 void resetBoreHoleLength();
104
105 bool setBoreHoleRadius(boost::optional<double> boreHoleRadius);
106
107 void resetBoreHoleRadius();
108
109 bool setGroundThermalConductivity(boost::optional<double> groundThermalConductivity);
110
111 void resetGroundThermalConductivity();
112
113 bool setGroundThermalHeatCapacity(boost::optional<double> groundThermalHeatCapacity);
114
115 void resetGroundThermalHeatCapacity();
116
117 bool setGroundTemperature(boost::optional<double> groundTemperature);
118
119 void resetGroundTemperature();
120
121 bool setDesignFlowRate(double designFlowRate);
122
123 bool setGroutThermalConductivity(boost::optional<double> groutThermalConductivity);
124
125 void resetGroutThermalConductivity();
126
127 bool setPipeThermalConductivity(boost::optional<double> pipeThermalConductivity);
128
129 void resetPipeThermalConductivity();
130
131 bool setPipeOutDiameter(boost::optional<double> pipeOutDiameter);
132
133 void resetPipeOutDiameter();
134
135 bool setUTubeDistance(boost::optional<double> uTubeDistance);
136
137 void resetUTubeDistance();
138
139 bool setPipeThickness(boost::optional<double> pipeThickness);
140
141 void resetPipeThickness();
142
143 bool setMaximumLengthofSimulation(boost::optional<double> maximumLengthofSimulation);
144
145 void resetMaximumLengthofSimulation();
146
147 bool setGFunctionReferenceRatio(double gFunctionReferenceRatio);
148
149 void resetGFunctionReferenceRatio();
150
151 bool setUndisturbedGroundTemperatureModel(const ModelObject& undisturbedGroundTemperatureModel);
152
153 //@}
154 /** @name Other */
155 //@{
156
157 bool addGFunction(double gFunctionLN, double gFunctionGValue);
158
159 void removeGFunction(unsigned groupIndex);
160
161 void removeAllGFunctions();
162
163 std::vector<std::pair<double, double>> gFunctions();
164
165 //@}
166 protected:
167 private:
168 REGISTER_LOGGER("openstudio.model.GroundHeatExchangerVertical");
169
170 // TODO: Check the return types of these methods.
171 // Optional getters for use by methods like children() so can remove() if the constructor fails.
172 // There are other ways for the public versions of these getters to fail--perhaps all required
173 // objects should be returned as boost::optionals
174 };
175
176 } // namespace detail
177
178 } // namespace model
179 } // namespace openstudio
180
181 #endif // MODEL_GROUNDHEATEXCHANGERVERTICAL_IMPL_HPP
182