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