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