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/FoundationKivaSettings_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_FOUNDATIONKIVASETTINGS_IMPL_HPP
7 #define MODEL_FOUNDATIONKIVASETTINGS_IMPL_HPP
8
9 #include <vector>
10 #include "ModelAPI.hpp"
11 #include "ModelObject_Impl.hpp"
12
13 namespace openstudio {
14 namespace model {
15
16 namespace detail {
17
18 /** FoundationKivaSettings_Impl is a ModelObject_Impl that is the implementation class for FoundationKivaSettings.*/
19 class MODEL_API FoundationKivaSettings_Impl : public ModelObject_Impl
20 {
21
22 public:
23 /** @name Constructors and Destructors */
24 //@{
25
26 FoundationKivaSettings_Impl(const IdfObject& idfObject, Model_Impl* model, bool keepHandle);
27
28 FoundationKivaSettings_Impl(const openstudio::detail::WorkspaceObject_Impl& other, Model_Impl* model, bool keepHandle);
29
30 FoundationKivaSettings_Impl(const FoundationKivaSettings_Impl& other, Model_Impl* model, bool keepHandle);
31
32 16 virtual ~FoundationKivaSettings_Impl() override = default;
33
34 //@}
35 /** @name Virtual Methods */
36 //@{
37
38 virtual boost::optional<ParentObject> parent() const override;
39
40 virtual const std::vector<std::string>& outputVariableNames() const override;
41
42 virtual IddObjectType iddObjectType() const override;
43
44 //@}
45 /** @name Getters */
46 //@{
47
48 double soilConductivity() const;
49
50 bool isSoilConductivityDefaulted() const;
51
52 double soilDensity() const;
53
54 bool isSoilDensityDefaulted() const;
55
56 double soilSpecificHeat() const;
57
58 bool isSoilSpecificHeatDefaulted() const;
59
60 double groundSolarAbsorptivity() const;
61
62 bool isGroundSolarAbsorptivityDefaulted() const;
63
64 double groundThermalAbsorptivity() const;
65
66 bool isGroundThermalAbsorptivityDefaulted() const;
67
68 double groundSurfaceRoughness() const;
69
70 bool isGroundSurfaceRoughnessDefaulted() const;
71
72 double farFieldWidth() const;
73
74 bool isFarFieldWidthDefaulted() const;
75
76 std::string deepGroundBoundaryCondition() const;
77
78 bool isDeepGroundBoundaryConditionAutoselected();
79
80 boost::optional<double> deepGroundDepth();
81
82 bool isDeepGroundDepthAutocalculated();
83
84 double minimumCellDimension() const;
85
86 bool isMinimumCellDimensionDefaulted() const;
87
88 double maximumCellGrowthCoefficient() const;
89
90 bool isMaximumCellGrowthCoefficientDefaulted() const;
91
92 std::string simulationTimestep() const;
93
94 bool isSimulationTimestepDefaulted() const;
95
96 //@}
97 /** @name Setters */
98 //@{
99
100 bool setSoilConductivity(double soilConductivity);
101
102 void resetSoilConductivity();
103
104 bool setSoilDensity(double soilDensity);
105
106 void resetSoilDensity();
107
108 bool setSoilSpecificHeat(double soilSpecificHeat);
109
110 void resetSoilSpecificHeat();
111
112 bool setGroundSolarAbsorptivity(double groundSolarAbsorptivity);
113
114 void resetGroundSolarAbsorptivity();
115
116 bool setGroundThermalAbsorptivity(double groundThermalAbsorptivity);
117
118 void resetGroundThermalAbsorptivity();
119
120 bool setGroundSurfaceRoughness(double groundSurfaceRoughness);
121
122 void resetGroundSurfaceRoughness();
123
124 bool setFarFieldWidth(double farFieldWidth);
125
126 void resetFarFieldWidth();
127
128 bool setDeepGroundBoundaryCondition(const std::string& deepGroundBoundaryCondition);
129
130 void resetDeepGroundBoundaryCondition();
131
132 bool setDeepGroundDepth(double deepGroundDepth);
133
134 void autocalculateDeepGroundDepth();
135
136 bool setMinimumCellDimension(double minimumCellDimension);
137
138 void resetMinimumCellDimension();
139
140 bool setMaximumCellGrowthCoefficient(double maximumCellGrowthCoefficient);
141
142 void resetMaximumCellGrowthCoefficient();
143
144 bool setSimulationTimestep(const std::string& simulationTimestep);
145
146 void resetSimulationTimestep();
147
148 //@}
149 /** @name Other */
150 //@{
151
152 //@}
153 protected:
154 private:
155 REGISTER_LOGGER("openstudio.model.FoundationKivaSettings");
156 };
157
158 } // namespace detail
159
160 } // namespace model
161 } // namespace openstudio
162
163 #endif // MODEL_FOUNDATIONKIVASETTINGS_IMPL_HPP
164