Line data Source code
1 : // EnergyPlus, Copyright (c) 1996-2023, 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/SiteDeepGroundTemperatures.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:Deep factory
67 771 : std::shared_ptr<SiteDeepGroundTemps> SiteDeepGroundTemps::DeepGTMFactory(EnergyPlusData &state, std::string objectName)
68 : {
69 : // SUBROUTINE INFORMATION:
70 : // AUTHOR Matt Mitchell
71 : // DATE WRITTEN Summer 2015
72 : // MODIFIED na
73 : // RE-ENGINEERED na
74 :
75 : // PURPOSE OF THIS SUBROUTINE:
76 : // Reads input and creates instance of Site:GroundTemperature:Deep object
77 :
78 : // USE STATEMENTS:
79 : using namespace GroundTemperatureManager;
80 :
81 : // Locals
82 : // SUBROUTINE LOCAL VARIABLE DECLARATIONS:
83 : int NumNums;
84 : int NumAlphas;
85 : int IOStat;
86 771 : bool errorsFound = false;
87 :
88 : // New shared pointer for this model object
89 1542 : std::shared_ptr<SiteDeepGroundTemps> thisModel(new SiteDeepGroundTemps());
90 :
91 771 : GroundTempObjType objType = GroundTempObjType::SiteDeepGroundTemp;
92 :
93 771 : std::string_view const cCurrentModuleObject = GroundTemperatureManager::groundTempModelNamesUC[static_cast<int>(objType)];
94 771 : int numCurrObjects = state.dataInputProcessing->inputProcessor->getNumObjectsFound(state, cCurrentModuleObject);
95 :
96 771 : thisModel->objectType = objType;
97 771 : thisModel->objectName = objectName;
98 :
99 771 : if (numCurrObjects == 1) {
100 :
101 : // Get the object names for each construction from the input processor
102 93 : state.dataInputProcessing->inputProcessor->getObjectItem(
103 62 : state, cCurrentModuleObject, 1, state.dataIPShortCut->cAlphaArgs, NumAlphas, state.dataIPShortCut->rNumericArgs, NumNums, IOStat);
104 :
105 31 : if (NumNums < 12) {
106 0 : ShowSevereError(
107 0 : state, fmt::format("{}: Less than 12 values entered.", GroundTemperatureManager::groundTempModelNames[static_cast<int>(objType)]));
108 0 : errorsFound = true;
109 : }
110 :
111 : // overwrite values read from weather file for the 0.5m set ground temperatures
112 403 : for (int i = 1; i <= 12; ++i) {
113 372 : thisModel->deepGroundTemps(i) = state.dataIPShortCut->rNumericArgs(i);
114 : }
115 :
116 31 : state.dataEnvrn->GroundTemp_DeepObjInput = true;
117 :
118 740 : } else if (numCurrObjects > 1) {
119 0 : ShowSevereError(state,
120 0 : fmt::format("{}: Too many objects entered. Only one allowed.",
121 0 : GroundTemperatureManager::groundTempModelNames[static_cast<int>(objType)]));
122 0 : errorsFound = true;
123 :
124 : } else {
125 740 : thisModel->deepGroundTemps = 16.0;
126 : }
127 :
128 : // Write Final Ground Temp Information to the initialization output file
129 771 : write_ground_temps(state.files.eio, "Deep", thisModel->deepGroundTemps);
130 :
131 771 : if (!errorsFound) {
132 771 : state.dataGrndTempModelMgr->groundTempModels.push_back(thisModel);
133 771 : return thisModel;
134 : } else {
135 0 : ShowFatalError(state,
136 0 : fmt::format("{}--Errors getting input for ground temperature model",
137 0 : GroundTemperatureManager::groundTempModelNames[static_cast<int>(objType)]));
138 0 : return nullptr;
139 : }
140 : }
141 :
142 : //******************************************************************************
143 :
144 2661169 : Real64 SiteDeepGroundTemps::getGroundTemp([[maybe_unused]] EnergyPlusData &state)
145 : {
146 : // SUBROUTINE INFORMATION:
147 : // AUTHOR Matt Mitchell
148 : // DATE WRITTEN Summer 2015
149 : // MODIFIED na
150 : // RE-ENGINEERED na
151 :
152 : // PURPOSE OF THIS SUBROUTINE:
153 : // Returns the ground temperature for Site:GroundTemperature:Deep
154 :
155 2661169 : return deepGroundTemps(timeOfSimInMonths);
156 : }
157 :
158 : //******************************************************************************
159 :
160 0 : Real64 SiteDeepGroundTemps::getGroundTempAtTimeInSeconds(EnergyPlusData &state, [[maybe_unused]] Real64 const _depth, Real64 const _seconds)
161 : {
162 : // SUBROUTINE INFORMATION:
163 : // AUTHOR Matt Mitchell
164 : // DATE WRITTEN Summer 2015
165 : // MODIFIED na
166 : // RE-ENGINEERED na
167 :
168 : // PURPOSE OF THIS SUBROUTINE:
169 : // Returns the ground temperature when input time is in seconds
170 :
171 : // USE STATEMENTS:
172 : // SUBROUTINE LOCAL VARIABLE DECLARATIONS:
173 0 : Real64 secPerMonth = state.dataWeatherManager->NumDaysInYear * DataGlobalConstants::SecsInDay / 12;
174 :
175 : // Convert secs to months
176 0 : int month = ceil(_seconds / secPerMonth);
177 :
178 0 : if (month >= 1 && month <= 12) {
179 0 : timeOfSimInMonths = month;
180 : } else {
181 0 : timeOfSimInMonths = remainder(month, 12);
182 : }
183 :
184 : // Get and return ground temp
185 0 : return getGroundTemp(state);
186 : }
187 :
188 : //******************************************************************************
189 :
190 2661169 : Real64 SiteDeepGroundTemps::getGroundTempAtTimeInMonths(EnergyPlusData &state, [[maybe_unused]] Real64 const _depth, int const _month)
191 : {
192 : // SUBROUTINE INFORMATION:
193 : // AUTHOR Matt Mitchell
194 : // DATE WRITTEN Summer 2015
195 : // MODIFIED na
196 : // RE-ENGINEERED na
197 :
198 : // PURPOSE OF THIS SUBROUTINE:
199 : // Returns the ground temperature when input time is in months
200 :
201 : // Set month
202 2661169 : if (_month >= 1 && _month <= 12) {
203 2661169 : timeOfSimInMonths = _month;
204 : } else {
205 0 : timeOfSimInMonths = remainder(_month, 12);
206 : }
207 :
208 : // Get and return ground temp
209 2661169 : return getGroundTemp(state);
210 : }
211 :
212 : //******************************************************************************
213 :
214 2313 : } // namespace EnergyPlus
|
