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