src/model/GroundHeatExchangerVertical.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_HPP | ||
| 7 | #define MODEL_GROUNDHEATEXCHANGERVERTICAL_HPP | ||
| 8 | |||
| 9 | #include "ModelAPI.hpp" | ||
| 10 | #include "StraightComponent.hpp" | ||
| 11 | |||
| 12 | namespace openstudio { | ||
| 13 | namespace model { | ||
| 14 | namespace detail { | ||
| 15 | |||
| 16 | class GroundHeatExchangerVertical_Impl; | ||
| 17 | |||
| 18 | } // namespace detail | ||
| 19 | |||
| 20 | class MODEL_API GFunction | ||
| 21 | { | ||
| 22 | |||
| 23 | public: | ||
| 24 | GFunction(double lnValue, double gValue); | ||
| 25 | double lnValue() const; | ||
| 26 | double gValue() const; | ||
| 27 | |||
| 28 | private: | ||
| 29 | double m_lnValue; | ||
| 30 | double m_gValue; | ||
| 31 | }; | ||
| 32 | |||
| 33 | /** GroundHeatExchangerVertical is a StraightComponent that wraps the OpenStudio IDD object 'OS:GroundHeatExchanger:Vertical'. */ | ||
| 34 | class MODEL_API GroundHeatExchangerVertical : public StraightComponent | ||
| 35 | { | ||
| 36 | public: | ||
| 37 | /** @name Constructors and Destructors */ | ||
| 38 | //@{ | ||
| 39 | |||
| 40 | explicit GroundHeatExchangerVertical(const Model& model); | ||
| 41 | |||
| 42 | explicit GroundHeatExchangerVertical(const Model& model, const ModelObject& undisturbedGroundTemperatureModel); | ||
| 43 | |||
| 44 | 20 | virtual ~GroundHeatExchangerVertical() override = default; | |
| 45 | // Default the copy and move operators because the virtual dtor is explicit | ||
| 46 | ✗ | GroundHeatExchangerVertical(const GroundHeatExchangerVertical& other) = default; | |
| 47 | ✗ | GroundHeatExchangerVertical(GroundHeatExchangerVertical&& other) = default; | |
| 48 | ✗ | GroundHeatExchangerVertical& operator=(const GroundHeatExchangerVertical&) = default; | |
| 49 | ✗ | GroundHeatExchangerVertical& operator=(GroundHeatExchangerVertical&&) = default; | |
| 50 | |||
| 51 | //@} | ||
| 52 | |||
| 53 | static IddObjectType iddObjectType(); | ||
| 54 | |||
| 55 | bool addGFunction(double gFunctionLN, double gFunctionGValue); | ||
| 56 | |||
| 57 | bool addGFunction(GFunction gFunc); | ||
| 58 | |||
| 59 | void removeGFunction(int groupIndex); | ||
| 60 | |||
| 61 | void removeAllGFunctions(); | ||
| 62 | |||
| 63 | std::vector<GFunction> gFunctions(); | ||
| 64 | |||
| 65 | /** @name Getters */ | ||
| 66 | //@{ | ||
| 67 | |||
| 68 | boost::optional<double> designFlowRate() const; | ||
| 69 | |||
| 70 | boost::optional<int> numberofBoreHoles() const; | ||
| 71 | |||
| 72 | double boreHoleTopDepth() const; | ||
| 73 | |||
| 74 | boost::optional<double> boreHoleLength() const; | ||
| 75 | |||
| 76 | boost::optional<double> boreHoleRadius() const; | ||
| 77 | |||
| 78 | boost::optional<double> groundThermalConductivity() const; | ||
| 79 | |||
| 80 | boost::optional<double> groundThermalHeatCapacity() const; | ||
| 81 | |||
| 82 | boost::optional<double> groundTemperature() const; | ||
| 83 | |||
| 84 | boost::optional<double> groutThermalConductivity() const; | ||
| 85 | |||
| 86 | boost::optional<double> pipeThermalConductivity() const; | ||
| 87 | |||
| 88 | boost::optional<double> pipeOutDiameter() const; | ||
| 89 | |||
| 90 | boost::optional<double> uTubeDistance() const; | ||
| 91 | |||
| 92 | boost::optional<double> pipeThickness() const; | ||
| 93 | |||
| 94 | boost::optional<double> maximumLengthofSimulation() const; | ||
| 95 | |||
| 96 | double gFunctionReferenceRatio() const; | ||
| 97 | |||
| 98 | bool isGFunctionReferenceRatioDefaulted() const; | ||
| 99 | |||
| 100 | ModelObject undisturbedGroundTemperatureModel() const; | ||
| 101 | |||
| 102 | //@} | ||
| 103 | /** @name Setters */ | ||
| 104 | |||
| 105 | //@{ | ||
| 106 | |||
| 107 | bool setDesignFlowRate(double designFlowRate); | ||
| 108 | |||
| 109 | bool setNumberofBoreHoles(int numberofBoreHoles); | ||
| 110 | |||
| 111 | void resetNumberofBoreHoles(); | ||
| 112 | |||
| 113 | bool setBoreHoleTopDepth(double boreHoleTopDepth); | ||
| 114 | |||
| 115 | bool setBoreHoleLength(double boreHoleLength); | ||
| 116 | |||
| 117 | void resetBoreHoleLength(); | ||
| 118 | |||
| 119 | bool setBoreHoleRadius(double boreHoleRadius); | ||
| 120 | |||
| 121 | void resetBoreHoleRadius(); | ||
| 122 | |||
| 123 | bool setGroundThermalConductivity(double groundThermalConductivity); | ||
| 124 | |||
| 125 | void resetGroundThermalConductivity(); | ||
| 126 | |||
| 127 | bool setGroundThermalHeatCapacity(double groundThermalHeatCapacity); | ||
| 128 | |||
| 129 | void resetGroundThermalHeatCapacity(); | ||
| 130 | |||
| 131 | bool setGroundTemperature(double groundTemperature); | ||
| 132 | |||
| 133 | void resetGroundTemperature(); | ||
| 134 | |||
| 135 | bool setGroutThermalConductivity(double groutThermalConductivity); | ||
| 136 | |||
| 137 | void resetGroutThermalConductivity(); | ||
| 138 | |||
| 139 | bool setPipeThermalConductivity(double pipeThermalConductivity); | ||
| 140 | |||
| 141 | void resetPipeThermalConductivity(); | ||
| 142 | |||
| 143 | bool setPipeOutDiameter(double pipeOutDiameter); | ||
| 144 | |||
| 145 | void resetPipeOutDiameter(); | ||
| 146 | |||
| 147 | bool setUTubeDistance(double uTubeDistance); | ||
| 148 | |||
| 149 | void resetUTubeDistance(); | ||
| 150 | |||
| 151 | bool setPipeThickness(double pipeThickness); | ||
| 152 | |||
| 153 | void resetPipeThickness(); | ||
| 154 | |||
| 155 | bool setMaximumLengthofSimulation(double maximumLengthofSimulation); | ||
| 156 | |||
| 157 | void resetMaximumLengthofSimulation(); | ||
| 158 | |||
| 159 | bool setGFunctionReferenceRatio(double gFunctionReferenceRatio); | ||
| 160 | |||
| 161 | void resetGFunctionReferenceRatio(); | ||
| 162 | |||
| 163 | bool setUndisturbedGroundTemperatureModel(const ModelObject& undisturbedGroundTemperatureModel); | ||
| 164 | |||
| 165 | //@} | ||
| 166 | /** @name Other */ | ||
| 167 | //@{ | ||
| 168 | |||
| 169 | //@} | ||
| 170 | protected: | ||
| 171 | /// @cond | ||
| 172 | using ImplType = detail::GroundHeatExchangerVertical_Impl; | ||
| 173 | |||
| 174 | explicit GroundHeatExchangerVertical(std::shared_ptr<detail::GroundHeatExchangerVertical_Impl> impl); | ||
| 175 | |||
| 176 | friend class detail::GroundHeatExchangerVertical_Impl; | ||
| 177 | friend class Model; | ||
| 178 | friend class IdfObject; | ||
| 179 | friend class openstudio::detail::IdfObject_Impl; | ||
| 180 | /// @endcond | ||
| 181 | private: | ||
| 182 | − | REGISTER_LOGGER("openstudio.model.GroundHeatExchangerVertical"); | |
| 183 | }; | ||
| 184 | |||
| 185 | /** \relates GroundHeatExchangerVertical*/ | ||
| 186 | using OptionalGroundHeatExchangerVertical = boost::optional<GroundHeatExchangerVertical>; | ||
| 187 | |||
| 188 | /** \relates GroundHeatExchangerVertical*/ | ||
| 189 | using GroundHeatExchangerVerticalVector = std::vector<GroundHeatExchangerVertical>; | ||
| 190 | |||
| 191 | } // namespace model | ||
| 192 | } // namespace openstudio | ||
| 193 | |||
| 194 | #endif // MODEL_GROUNDHEATEXCHANGERVERTICAL_HPP | ||
| 195 |