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/SiteFCFactorMethodGroundTemperatures.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:FCFactorMethod factory
67 796 : std::shared_ptr<SiteFCFactorMethodGroundTemps> SiteFCFactorMethodGroundTemps::FCFactorGTMFactory(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:GroundTemperature:FCfactorMethod object
75 :
76 : // SUBROUTINE LOCAL VARIABLE DECLARATIONS:
77 796 : bool found = false;
78 796 : bool errorsFound = false;
79 :
80 : // New shared pointer for this model object
81 796 : std::shared_ptr<SiteFCFactorMethodGroundTemps> thisModel(new SiteFCFactorMethodGroundTemps());
82 :
83 796 : GroundTempObjType objType = GroundTempObjType::SiteFCFactorMethodGroundTemp;
84 :
85 796 : std::string_view const cCurrentModuleObject = GroundTemperatureManager::groundTempModelNamesUC[static_cast<int>(objType)];
86 796 : int numCurrObjects = state.dataInputProcessing->inputProcessor->getNumObjectsFound(state, cCurrentModuleObject);
87 :
88 796 : thisModel->objectType = objType;
89 796 : thisModel->objectName = objectName;
90 :
91 796 : if (numCurrObjects == 1) {
92 :
93 : int NumNums;
94 : int NumAlphas;
95 : int IOStat;
96 :
97 : // Get the object names for each construction from the input processor
98 40 : state.dataInputProcessing->inputProcessor->getObjectItem(
99 20 : state, cCurrentModuleObject, 1, state.dataIPShortCut->cAlphaArgs, NumAlphas, state.dataIPShortCut->rNumericArgs, NumNums, IOStat);
100 :
101 20 : if (NumNums < 12) {
102 0 : ShowSevereError(
103 0 : state, fmt::format("{}: Less than 12 values entered.", GroundTemperatureManager::groundTempModelNames[static_cast<int>(objType)]));
104 0 : errorsFound = true;
105 : }
106 :
107 : // overwrite values read from weather file for the 0.5m set ground temperatures
108 260 : for (int i = 1; i <= 12; ++i) {
109 240 : thisModel->fcFactorGroundTemps(i) = state.dataIPShortCut->rNumericArgs(i);
110 : }
111 :
112 20 : state.dataEnvrn->GroundTempInputs[(int)DataEnvironment::GroundTempType::FCFactorMethod] = true;
113 20 : found = true;
114 :
115 776 : } else if (numCurrObjects > 1) {
116 0 : ShowSevereError(state,
117 0 : fmt::format("{}: Too many objects entered. Only one allowed.",
118 0 : GroundTemperatureManager::groundTempModelNames[static_cast<int>(objType)]));
119 0 : errorsFound = true;
120 :
121 776 : } else if (state.dataWeather->wthFCGroundTemps) {
122 :
123 9997 : for (int i = 1; i <= 12; ++i) {
124 9228 : thisModel->fcFactorGroundTemps(i) = state.dataWeather->GroundTempsFCFromEPWHeader(i);
125 : }
126 :
127 769 : state.dataEnvrn->GroundTempInputs[(int)DataEnvironment::GroundTempType::FCFactorMethod] = true;
128 769 : found = true;
129 :
130 : } else {
131 7 : thisModel->fcFactorGroundTemps = 0.0;
132 7 : found = true;
133 : }
134 :
135 : // Write Final Ground Temp Information to the initialization output file
136 796 : if (state.dataEnvrn->GroundTempInputs[(int)DataEnvironment::GroundTempType::FCFactorMethod]) {
137 789 : write_ground_temps(state.files.eio, "FCfactorMethod", thisModel->fcFactorGroundTemps);
138 : }
139 :
140 796 : if (found && !errorsFound) {
141 796 : state.dataGrndTempModelMgr->groundTempModels.push_back(thisModel);
142 796 : 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 796 : }
150 :
151 : //******************************************************************************
152 :
153 2900842 : Real64 SiteFCFactorMethodGroundTemps::getGroundTemp([[maybe_unused]] EnergyPlusData &state)
154 : {
155 : // SUBROUTINE INFORMATION:
156 : // AUTHOR Matt Mitchell
157 : // DATE WRITTEN Summer 2015
158 :
159 : // PURPOSE OF THIS SUBROUTINE:
160 : // Returns the ground temperature for Site:GroundTemperature:FCFactorMethod
161 :
162 2900842 : return fcFactorGroundTemps(timeOfSimInMonths);
163 : }
164 :
165 : //******************************************************************************
166 :
167 0 : Real64 SiteFCFactorMethodGroundTemps::getGroundTempAtTimeInSeconds(EnergyPlusData &state, [[maybe_unused]] Real64 const _depth, Real64 const _seconds)
168 : {
169 : // SUBROUTINE INFORMATION:
170 : // AUTHOR Matt Mitchell
171 : // DATE WRITTEN Summer 2015
172 :
173 : // PURPOSE OF THIS SUBROUTINE:
174 : // Returns the ground temperature when input time is in seconds
175 :
176 : // SUBROUTINE LOCAL VARIABLE DECLARATIONS:
177 0 : Real64 secPerMonth = state.dataWeather->NumDaysInYear * Constant::SecsInDay / 12;
178 :
179 : // Convert secs to months
180 0 : int month = ceil(_seconds / secPerMonth);
181 :
182 0 : if (month >= 1 && month <= 12) {
183 0 : timeOfSimInMonths = month;
184 : } else {
185 0 : timeOfSimInMonths = remainder(month, 12);
186 : }
187 :
188 : // Get and return ground temp
189 0 : return getGroundTemp(state);
190 : }
191 :
192 : //******************************************************************************
193 :
194 2900842 : Real64 SiteFCFactorMethodGroundTemps::getGroundTempAtTimeInMonths(EnergyPlusData &state, [[maybe_unused]] Real64 const _depth, int const _month)
195 : {
196 : // SUBROUTINE INFORMATION:
197 : // AUTHOR Matt Mitchell
198 : // DATE WRITTEN Summer 2015
199 :
200 : // PURPOSE OF THIS SUBROUTINE:
201 : // Returns the ground temperature when input time is in months
202 :
203 : // Set month
204 2900842 : if (_month >= 1 && _month <= 12) {
205 2900842 : timeOfSimInMonths = _month;
206 : } else {
207 0 : timeOfSimInMonths = remainder(_month, 12);
208 : }
209 :
210 : // Get and return ground temp
211 2900842 : return getGroundTemp(state);
212 : }
213 :
214 : //******************************************************************************
215 :
216 : } // namespace EnergyPlus
|
