Line data Source code
1 : // EnergyPlus, Copyright (c) 1996-2025, The Board of Trustees of the University of Illinois,
2 : // The Regents of the University of California, through Lawrence Berkeley National Laboratory
3 : // (subject to receipt of any required approvals from the U.S. Dept. of Energy), Oak Ridge
4 : // National Laboratory, managed by UT-Battelle, Alliance for Sustainable Energy, LLC, and other
5 : // contributors. All rights reserved.
6 : //
7 : // NOTICE: This Software was developed under funding from the U.S. Department of Energy and the
8 : // U.S. Government consequently retains certain rights. As such, the U.S. Government has been
9 : // granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable,
10 : // worldwide license in the Software to reproduce, distribute copies to the public, prepare
11 : // derivative works, and perform publicly and display publicly, and to permit others to do so.
12 : //
13 : // Redistribution and use in source and binary forms, with or without modification, are permitted
14 : // provided that the following conditions are met:
15 : //
16 : // (1) Redistributions of source code must retain the above copyright notice, this list of
17 : // conditions and the following disclaimer.
18 : //
19 : // (2) Redistributions in binary form must reproduce the above copyright notice, this list of
20 : // conditions and the following disclaimer in the documentation and/or other materials
21 : // provided with the distribution.
22 : //
23 : // (3) Neither the name of the University of California, Lawrence Berkeley National Laboratory,
24 : // the University of Illinois, U.S. Dept. of Energy nor the names of its contributors may be
25 : // used to endorse or promote products derived from this software without specific prior
26 : // written permission.
27 : //
28 : // (4) Use of EnergyPlus(TM) Name. If Licensee (i) distributes the software in stand-alone form
29 : // without changes from the version obtained under this License, or (ii) Licensee makes a
30 : // reference solely to the software portion of its product, Licensee must refer to the
31 : // software as "EnergyPlus version X" software, where "X" is the version number Licensee
32 : // obtained under this License and may not use a different name for the software. Except as
33 : // specifically required in this Section (4), Licensee shall not use in a company name, a
34 : // product name, in advertising, publicity, or other promotional activities any name, trade
35 : // name, trademark, logo, or other designation of "EnergyPlus", "E+", "e+" or confusingly
36 : // similar designation, without the U.S. Department of Energy's prior written consent.
37 : //
38 : // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
39 : // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
40 : // AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
41 : // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
42 : // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
43 : // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
44 : // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
45 : // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
46 : // POSSIBILITY OF SUCH DAMAGE.
47 :
48 : #ifndef EarthTube_hh_INCLUDED
49 : #define EarthTube_hh_INCLUDED
50 :
51 : // ObjexxFCL Headers
52 : #include <ObjexxFCL/Array1D.hh>
53 :
54 : // EnergyPlus Headers
55 : #include <EnergyPlus/Data/BaseData.hh>
56 : #include <EnergyPlus/DataGlobals.hh>
57 : #include <EnergyPlus/EnergyPlus.hh>
58 : #include <EnergyPlus/ScheduleManager.hh>
59 :
60 : namespace EnergyPlus {
61 :
62 : // Forward declarations
63 : struct EnergyPlusData;
64 :
65 : namespace EarthTube {
66 :
67 : // Parameters for Ventilation
68 : enum class Ventilation
69 : {
70 : Invalid = -1,
71 : Natural,
72 : Intake,
73 : Exhaust,
74 : Num
75 : };
76 :
77 : enum class EarthTubeModelType
78 : {
79 : Invalid = -1,
80 : Basic,
81 : Vertical,
82 : Num
83 : };
84 :
85 : struct EarthTubeData
86 : {
87 : int ZonePtr = 0;
88 : Sched::Schedule *availSched = nullptr; // Assuming this is an availability schedule
89 : Real64 DesignLevel = 0.0;
90 : Real64 MinTemperature = 0.0;
91 : Real64 MaxTemperature = 0.0;
92 : Real64 DelTemperature = 0.0;
93 : Ventilation FanType = Ventilation::Invalid;
94 : Real64 FanPressure = 0.0;
95 : Real64 FanEfficiency = 0.0;
96 : Real64 FanPower = 0.0;
97 : Real64 GroundTempt = 0.0; // ground temp at the depth of the earth tube midpoint at time t
98 : Real64 InsideAirTemp = 0.0;
99 : Real64 AirTemp = 0.0;
100 : Real64 HumRat = 0.0; // Humidity ratio of air leaving EarthTube and entering zone
101 : Real64 WetBulbTemp = 0.0; // Humidity ratio of air leaving EarthTube and entering zone
102 : Real64 r1 = 0.0; // Inner Pipe Radius (m)
103 : Real64 r2 = 0.0; // Pipe Thickness (m)
104 : Real64 r3 = 0.0; // Distance between Pipe Outer Surface and Undistubed Soil (m)
105 : Real64 PipeLength = 0.0; // Entire Pipe Length
106 : Real64 PipeThermCond = 0.0; // Pipe Thermal Conductivity
107 : Real64 z = 0.0; // Depth under the Ground Surface (m)
108 : Real64 SoilThermDiff = 0.0; // Soil Thermal Diffusivity
109 : Real64 SoilThermCond = 0.0; // Soil Thermal Conductivity
110 : Real64 AverSoilSurTemp = 0.0; // Average Soil Surface Temperature
111 : Real64 ApmlSoilSurTemp = 0.0; // Amplitude of Soil Surface Temperature
112 : int SoilSurPhaseConst = 0; // Phase constant of Soil Surface
113 : Real64 ConstantTermCoef = 0.0;
114 : Real64 TemperatureTermCoef = 0.0;
115 : Real64 VelocityTermCoef = 0.0;
116 : Real64 VelocitySQTermCoef = 0.0;
117 : EarthTubeModelType ModelType = EarthTubeModelType::Basic; // Type of modeling technique: Basic or Vertical
118 : int vertParametersPtr = 0; // Pointer to EarthTubeParameters structure
119 : int totNodes = 0; // Total number of nodes in Vertical solution (nodes above + nodes below + 1 for earth tube itself)
120 : std::vector<Real64> aCoeff; // Verticel solution: original a-coefficients of the main A matrix (tridiagonal--coefficient before the diagonal)
121 : std::vector<Real64> bCoeff; // Verticel solution: original b-coefficients of the main A matrix (tridiagonal--coefficient on the diagonal)
122 : std::vector<Real64> cCoeff; // Verticel solution: original c-coefficients of the main A matrix (tridiagonal--coefficient after the diagonal)
123 : std::vector<Real64> cCoeff0; // Verticel solution: original c-coefficients of the main A matrix (tridiagonal--coefficient after the diagonal)
124 : // when effectiveness is zero
125 : std::vector<Real64> dCoeff; // Vertical solution: original coefficients of the b matrix (in Ax = b)
126 : std::vector<Real64> cPrime; // c' of the forward sweep in the Thomas Algorithm for solving a triagonal matrix
127 : std::vector<Real64> dPrime; // d' of the forward sweep in the Thomas Algorithm for solving a triagonal matrix
128 : std::vector<Real64>
129 : cPrime0; // c' of the forward sweep in the Thomas Algorithm for solving a triagonal matrix when effectiveness is zero (no flow)
130 : std::vector<Real64> tCurrent; // Current time step nodal temperatures
131 : std::vector<Real64> tLast; // Last time step nodal temperatures
132 : std::vector<Real64> depthNode; // depth of the node
133 : Real64 dMult0 = 0.0; // multiplier for term in equation to determine dCoeff at top node
134 : Real64 dMultN = 0.0; // multiplier for term in equation to determine dCoeff at bottom node
135 : Real64 depthUpperBound = 0.0; // depth at the upper boundary of the solution space for the vertical solution
136 : Real64 depthLowerBound = 0.0; // depth at the lower boundary of the solution space for the vertical solution
137 : std::vector<Real64> tUndist; // temperature of undisturbed soil at the depths of the modes
138 : Real64 tUpperBound = 0.0; // temperature of undisturbed soil at the upper boundary
139 : Real64 tLowerBound = 0.0; // temperature of undisturbed soil at the lower boundary
140 : Real64 airFlowCoeff = 0.0; // constant portion of the air flow term that gets added to the bCoeff and dCoeff vectors at the earth tube node
141 :
142 : void initCPrime0(); // initialize c' for when effectiveness is zero
143 :
144 : Real64 calcUndisturbedGroundTemperature(EnergyPlusData &state, Real64 depth); // depth at which temperature is to be calculated
145 :
146 : void calcVerticalEarthTube(EnergyPlusData &state, Real64 airFlowTerm); // constant portion of term that accounts for air flow in earth tube
147 :
148 : void CalcEarthTubeHumRat(EnergyPlusData &state, int NZ); // Zone number (index)
149 : };
150 :
151 : struct EarthTubeZoneReportVars
152 : {
153 : // Members
154 : Real64 EarthTubeHeatLoss = 0.0; // [J] Heat loss or cooling to zone from air delivered by earth tube
155 : Real64 EarthTubeHeatLossRate = 0.0; // [W] Heat loss or cooling rate to zone from air delivered by earth tube
156 : Real64 EarthTubeHeatGain = 0.0; // [J] Heat Gain to zone from air delivered by earth tube
157 : Real64 EarthTubeHeatGainRate = 0.0; // [W] Heat Gain rate to zone from air delivered by earth tube
158 : Real64 EarthTubeOATreatmentPower = 0.0; // [W] rate of heat transfer to/from air. positive is heating OA to higher temp
159 : Real64 EarthTubeVolume = 0.0; // Volume of Air {m3} due to EarthTube
160 : Real64 EarthTubeVolFlowRate = 0.0; // Volume flow rate of air (m3/s) due to EarthTube
161 : Real64 EarthTubeVolFlowRateStd = 0.0; // Volume flow rate of air (m3/s) due to EarthTube at standard air conditions
162 : Real64 EarthTubeMass = 0.0; // Mass of Air {kg} due to EarthTube
163 : Real64 EarthTubeMassFlowRate = 0.0; // Mass flow rate of air (kg/s) due to EarthTube
164 : Real64 EarthTubeWaterMassFlowRate = 0.0; // Mass flow rate of water vapor (kg/s) due to EarthTube
165 : Real64 EarthTubeFanElec = 0.0; // [J] Fan Electricity consumed by EarthTube
166 : Real64 EarthTubeFanElecPower = 0.0; // [W] Fan Electric power for EarthTube
167 : Real64 EarthTubeAirTemp = 0.0; // Air Temp {C} of EarthTube, air leaving tube and entering zone
168 : Real64 EarthTubeWetBulbTemp = 0.0; // Wet Bulb Temperature {C} of EarthTube, air leaving tube and entering zone
169 : Real64 EarthTubeHumRat = 0.0; // Humidity Ratio {kg/kg} of EarthTube, air leaving tube and entering zone
170 : };
171 :
172 : struct EarthTubeParameters
173 : {
174 : std::string nameParameters; // Name of the parameters (referenced by earth tube object)
175 : int numNodesAbove; // Number of nodes above the earth tube (converted from integer in input)
176 : int numNodesBelow; // Number of nodes below the earth tube (converted from integer in input)
177 : Real64 dimBoundAbove; // Dimensionless location of upper boundary of solution space (multiplied by earth tube depth - radius)
178 : Real64 dimBoundBelow; // Dimensionless location of lower boundary of solution space (multiplied by earth tube depth - radius)
179 : Real64 width; // Dimensionless width of solution space (multiplied by earth tube radius)
180 : };
181 :
182 : void ManageEarthTube(EnergyPlusData &state);
183 :
184 : void GetEarthTube(EnergyPlusData &state, bool &ErrorsFound); // If errors found in input
185 :
186 : void CheckEarthTubesInZones(EnergyPlusData &state,
187 : std::string const &ZoneName, // name of zone for error reporting
188 : std::string_view FieldName, // name of earth tube in input
189 : bool &ErrorsFound // Found a problem
190 : );
191 :
192 : void initEarthTubeVertical(EnergyPlusData &state);
193 :
194 : void CalcEarthTube(EnergyPlusData &state);
195 :
196 : void ReportEarthTube(EnergyPlusData &state);
197 :
198 : } // namespace EarthTube
199 :
200 : struct EarthTubeData : BaseGlobalStruct
201 : {
202 : bool GetInputFlag = true;
203 : bool initFirstTime = true;
204 : Real64 timeElapsed =
205 : 0.0; // keeps track so that certain initializations only happen once even if earth tubes are called multiple times per time step
206 : EPVector<EarthTube::EarthTubeData> EarthTubeSys;
207 : EPVector<EarthTube::EarthTubeZoneReportVars> ZnRptET;
208 : EPVector<EarthTube::EarthTubeParameters> EarthTubePars;
209 :
210 2128 : void init_constant_state([[maybe_unused]] EnergyPlusData &state) override
211 : {
212 2128 : }
213 :
214 1153 : void init_state([[maybe_unused]] EnergyPlusData &state) override
215 : {
216 1153 : }
217 :
218 2102 : void clear_state() override
219 : {
220 2102 : new (this) EarthTubeData();
221 2102 : }
222 : };
223 :
224 : } // namespace EnergyPlus
225 :
226 : #endif
|
