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 : // C++ Headers
49 :
50 : // EnergyPlus Headers
51 : #include <EnergyPlus/Data/EnergyPlusData.hh>
52 : #include <EnergyPlus/DataEnvironment.hh>
53 : #include <EnergyPlus/DataGlobals.hh>
54 : #include <EnergyPlus/DataIPShortCuts.hh>
55 : #include <EnergyPlus/GroundTemperatureModeling/SiteShallowGroundTemperatures.hh>
56 : #include <EnergyPlus/InputProcessing/InputProcessor.hh>
57 : #include <EnergyPlus/UtilityRoutines.hh>
58 : #include <EnergyPlus/WeatherManager.hh>
59 :
60 : namespace EnergyPlus {
61 :
62 : //******************************************************************************
63 : namespace GroundTemp {
64 : // Site:GroundTemperature:Shallow factory
65 113 : SiteShallowGroundTemps *SiteShallowGroundTemps::ShallowGTMFactory(EnergyPlusData &state, const std::string &objectName)
66 : {
67 : // SUBROUTINE INFORMATION:
68 : // AUTHOR Matt Mitchell
69 : // DATE WRITTEN Summer 2015
70 :
71 : // PURPOSE OF THIS SUBROUTINE:
72 : // Reads input and creates instance of Site:GroundDomain:Shallow object
73 :
74 : // SUBROUTINE LOCAL VARIABLE DECLARATIONS:
75 113 : bool errorsFound = false;
76 :
77 : // New shared pointer for this model object
78 113 : auto *thisModel = new SiteShallowGroundTemps();
79 :
80 113 : ModelType modelType = ModelType::SiteShallow;
81 :
82 113 : std::string_view const cCurrentModuleObject = GroundTemp::modelTypeNamesUC[(int)modelType];
83 113 : const int numCurrObjects = state.dataInputProcessing->inputProcessor->getNumObjectsFound(state, cCurrentModuleObject);
84 :
85 113 : thisModel->modelType = modelType;
86 113 : thisModel->Name = objectName;
87 :
88 113 : if (numCurrObjects == 1) {
89 :
90 : int NumNums;
91 : int NumAlphas;
92 : int IOStat;
93 :
94 : // Get the object names for each construction from the input processor
95 4 : state.dataInputProcessing->inputProcessor->getObjectItem(
96 2 : state, cCurrentModuleObject, 1, state.dataIPShortCut->cAlphaArgs, NumAlphas, state.dataIPShortCut->rNumericArgs, NumNums, IOStat);
97 :
98 2 : if (NumNums < 12) {
99 0 : ShowSevereError(state, fmt::format("{}: Less than 12 values entered.", GroundTemp::modelTypeNames[(int)modelType]));
100 0 : errorsFound = true;
101 : }
102 :
103 : // Assign the ground temps to the variable
104 26 : for (int i = 1; i <= 12; ++i) {
105 24 : thisModel->surfaceGroundTemps[i - 1] = state.dataIPShortCut->rNumericArgs(i);
106 : }
107 :
108 2 : state.dataEnvrn->GroundTempInputs[static_cast<int>(DataEnvironment::GroundTempType::Shallow)] = true;
109 :
110 111 : } else if (numCurrObjects > 1) {
111 0 : ShowSevereError(state, fmt::format("{}: Too many objects entered. Only one allowed.", GroundTemp::modelTypeNames[(int)modelType]));
112 0 : errorsFound = true;
113 : } else {
114 111 : std::fill(thisModel->surfaceGroundTemps.begin(), thisModel->surfaceGroundTemps.end(), 13.0);
115 : }
116 :
117 : // Write Final Ground Temp Information to the initialization output file
118 339 : write_ground_temps(state.files.eio, "Shallow", thisModel->surfaceGroundTemps);
119 :
120 113 : if (!errorsFound) {
121 113 : state.dataGrndTempModelMgr->groundTempModels.push_back(thisModel);
122 113 : return thisModel;
123 : }
124 :
125 0 : ShowFatalError(state, fmt::format("{}--Errors getting input for ground temperature model", GroundTemp::modelTypeNames[(int)modelType]));
126 0 : return nullptr;
127 : }
128 :
129 : //******************************************************************************
130 :
131 326138 : Real64 SiteShallowGroundTemps::getGroundTemp([[maybe_unused]] EnergyPlusData &state)
132 : {
133 : // SUBROUTINE INFORMATION:
134 : // AUTHOR Matt Mitchell
135 : // DATE WRITTEN Summer 2015
136 :
137 : // PURPOSE OF THIS SUBROUTINE:
138 : // Return the ground temperature from Site:GroundTemperature:Shallow
139 :
140 326138 : return surfaceGroundTemps[timeOfSimInMonths - 1];
141 : }
142 :
143 : //******************************************************************************
144 :
145 3 : Real64 SiteShallowGroundTemps::getGroundTempAtTimeInSeconds(EnergyPlusData &state, [[maybe_unused]] Real64 const _depth, Real64 const _seconds)
146 : {
147 : // SUBROUTINE INFORMATION:
148 : // AUTHOR Matt Mitchell
149 : // DATE WRITTEN Summer 2015
150 :
151 : // PURPOSE OF THIS SUBROUTINE:
152 : // Returns the ground temperature when input time is in seconds
153 :
154 : // USE STATEMENTS:
155 : // SUBROUTINE LOCAL VARIABLE DECLARATIONS:
156 3 : Real64 secPerMonth = state.dataWeather->NumDaysInYear * Constant::rSecsInDay / 12;
157 :
158 : // Convert secs to months
159 3 : int month = ceil(_seconds / secPerMonth);
160 :
161 3 : if (month >= 1 && month <= 12) {
162 2 : timeOfSimInMonths = month;
163 : } else {
164 1 : timeOfSimInMonths = month % 12;
165 : }
166 :
167 : // Get and return ground temp
168 3 : return getGroundTemp(state);
169 : }
170 :
171 : //******************************************************************************
172 :
173 326135 : Real64 SiteShallowGroundTemps::getGroundTempAtTimeInMonths(EnergyPlusData &state, [[maybe_unused]] Real64 const _depth, int const _month)
174 : {
175 : // SUBROUTINE INFORMATION:
176 : // AUTHOR Matt Mitchell
177 : // DATE WRITTEN Summer 2015
178 :
179 : // PURPOSE OF THIS SUBROUTINE:
180 : // Returns the ground temperature when input time is in months
181 :
182 : // Set month
183 326135 : if (_month >= 1 && _month <= 12) {
184 326134 : timeOfSimInMonths = _month;
185 : } else {
186 1 : timeOfSimInMonths = _month % 12;
187 : }
188 :
189 : // Get and return ground temp
190 326135 : return getGroundTemp(state);
191 : }
192 :
193 : //******************************************************************************
194 : } // namespace GroundTemp
195 : } // namespace EnergyPlus
|
