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/GroundHeatExchangerHorizontalTrench.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_GROUNDHEATEXCHANGERHORIZONTALTRENCH_HPP
7 #define MODEL_GROUNDHEATEXCHANGERHORIZONTALTRENCH_HPP
8
9 #include "ModelAPI.hpp"
10 #include "StraightComponent.hpp"
11 #include "../utilities/core/Deprecated.hpp"
12
13 namespace openstudio {
14
15 namespace model {
16
17 namespace detail {
18
19 class GroundHeatExchangerHorizontalTrench_Impl;
20
21 } // namespace detail
22
23 /** GroundHeatExchangerHorizontalTrench is a StraightComponent that wraps the OpenStudio IDD object 'OS:GroundHeatExchanger:HorizontalTrench'. */
24 class MODEL_API GroundHeatExchangerHorizontalTrench : public StraightComponent
25 {
26 public:
27 /** @name Constructors and Destructors */
28 //@{
29
30 explicit GroundHeatExchangerHorizontalTrench(const Model& model);
31
32 explicit GroundHeatExchangerHorizontalTrench(const Model& model, const ModelObject& undisturbedGroundTemperatureModel);
33
34 32 virtual ~GroundHeatExchangerHorizontalTrench() override = default;
35 // Default the copy and move operators because the virtual dtor is explicit
36 ✗ GroundHeatExchangerHorizontalTrench(const GroundHeatExchangerHorizontalTrench& other) = default;
37 8 GroundHeatExchangerHorizontalTrench(GroundHeatExchangerHorizontalTrench&& other) = default;
38 ✗ GroundHeatExchangerHorizontalTrench& operator=(const GroundHeatExchangerHorizontalTrench&) = default;
39 ✗ GroundHeatExchangerHorizontalTrench& operator=(GroundHeatExchangerHorizontalTrench&&) = default;
40
41 //@}
42
43 static IddObjectType iddObjectType();
44
45 OS_DEPRECATED(3, 6, 0) static std::vector<std::string> groundTemperatureModelValues();
46
47 /** @name Getters */
48 //@{
49
50 double designFlowRate() const;
51
52 double trenchLengthinPipeAxialDirection() const;
53
54 int numberofTrenches() const;
55
56 double horizontalSpacingBetweenPipes() const;
57
58 double pipeInnerDiameter() const;
59
60 double pipeOuterDiameter() const;
61
62 double burialDepth() const;
63
64 double soilThermalConductivity() const;
65
66 double soilDensity() const;
67
68 double soilSpecificHeat() const;
69
70 double pipeThermalConductivity() const;
71
72 double pipeDensity() const;
73
74 double pipeSpecificHeat() const;
75
76 double soilMoistureContentPercent() const;
77
78 double soilMoistureContentPercentatSaturation() const;
79
80 OS_DEPRECATED(3, 6, 0) std::string groundTemperatureModel() const;
81
82 // cppcheck-suppress functionStatic
83 OS_DEPRECATED(3, 6, 0) bool isGroundTemperatureModelDefaulted() const;
84
85 OS_DEPRECATED(3, 6, 0) double kusudaAchenbachAverageSurfaceTemperature() const;
86
87 OS_DEPRECATED(3, 6, 0) double kusudaAchenbachAverageAmplitudeofSurfaceTemperature() const;
88
89 OS_DEPRECATED(3, 6, 0) double kusudaAchenbachPhaseShiftofMinimumSurfaceTemperature() const;
90
91 double evapotranspirationGroundCoverParameter() const;
92
93 ModelObject undisturbedGroundTemperatureModel() const;
94
95 //@}
96 /** @name Setters */
97 //@{
98
99 bool setDesignFlowRate(double designFlowRate);
100
101 bool setTrenchLengthinPipeAxialDirection(double trenchLengthinPipeAxialDirection);
102
103 bool setNumberofTrenches(int numberofTrenches);
104
105 bool setHorizontalSpacingBetweenPipes(double horizontalSpacingBetweenPipes);
106
107 bool setPipeInnerDiameter(double pipeInnerDiameter);
108
109 bool setPipeOuterDiameter(double pipeOuterDiameter);
110
111 bool setBurialDepth(double burialDepth);
112
113 bool setSoilThermalConductivity(double soilThermalConductivity);
114
115 bool setSoilDensity(double soilDensity);
116
117 bool setSoilSpecificHeat(double soilSpecificHeat);
118
119 bool setPipeThermalConductivity(double pipeThermalConductivity);
120
121 bool setPipeDensity(double pipeDensity);
122
123 bool setPipeSpecificHeat(double pipeSpecificHeat);
124
125 bool setSoilMoistureContentPercent(double soilMoistureContentPercent);
126
127 bool setSoilMoistureContentPercentatSaturation(double soilMoistureContentPercentatSaturation);
128
129 // cppcheck-suppress functionStatic
130 OS_DEPRECATED(3, 6, 0) bool setGroundTemperatureModel(const std::string& groundTemperatureModel);
131
132 // cppcheck-suppress functionStatic
133 OS_DEPRECATED(3, 6, 0) void resetGroundTemperatureModel();
134
135 OS_DEPRECATED(3, 6, 0) bool setKusudaAchenbachAverageSurfaceTemperature(double kusudaAchenbachAverageSurfaceTemperature);
136
137 OS_DEPRECATED(3, 6, 0) bool setKusudaAchenbachAverageAmplitudeofSurfaceTemperature(double kusudaAchenbachAverageAmplitudeofSurfaceTemperature);
138
139 OS_DEPRECATED(3, 6, 0) bool setKusudaAchenbachPhaseShiftofMinimumSurfaceTemperature(double kusudaAchenbachPhaseShiftofMinimumSurfaceTemperature);
140
141 bool setEvapotranspirationGroundCoverParameter(double evapotranspirationGroundCoverParameter);
142
143 bool setUndisturbedGroundTemperatureModel(const ModelObject& undisturbedGroundTemperatureModel);
144
145 //@}
146 /** @name Other */
147 //@{
148
149 //@}
150 protected:
151 /// @cond
152 using ImplType = detail::GroundHeatExchangerHorizontalTrench_Impl;
153
154 explicit GroundHeatExchangerHorizontalTrench(std::shared_ptr<detail::GroundHeatExchangerHorizontalTrench_Impl> impl);
155
156 friend class detail::GroundHeatExchangerHorizontalTrench_Impl;
157 friend class Model;
158 friend class IdfObject;
159 friend class openstudio::detail::IdfObject_Impl;
160 /// @endcond
161 private:
162 − REGISTER_LOGGER("openstudio.model.GroundHeatExchangerHorizontalTrench");
163 };
164
165 /** \relates GroundHeatExchangerHorizontalTrench*/
166 using OptionalGroundHeatExchangerHorizontalTrench = boost::optional<GroundHeatExchangerHorizontalTrench>;
167
168 /** \relates GroundHeatExchangerHorizontalTrench*/
169 using GroundHeatExchangerHorizontalTrenchVector = std::vector<GroundHeatExchangerHorizontalTrench>;
170
171 } // namespace model
172 } // namespace openstudio
173
174 #endif // MODEL_GROUNDHEATEXCHANGERHORIZONTALTRENCH_HPP
175