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