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 : #include <vector>
51 :
52 : // EnergyPlus Headers
53 : #include <EnergyPlus/Data/EnergyPlusData.hh>
54 : #include <EnergyPlus/EnergyPlus.hh>
55 : #include <EnergyPlus/GroundTemperatureModeling/BaseGroundTemperatureModel.hh>
56 : #include <EnergyPlus/GroundTemperatureModeling/FiniteDifferenceGroundTemperatureModel.hh>
57 : #include <EnergyPlus/GroundTemperatureModeling/GroundTemperatureModelManager.hh>
58 : #include <EnergyPlus/GroundTemperatureModeling/KusudaAchenbachGroundTemperatureModel.hh>
59 : #include <EnergyPlus/GroundTemperatureModeling/SiteBuildingSurfaceGroundTemperatures.hh>
60 : #include <EnergyPlus/GroundTemperatureModeling/SiteDeepGroundTemperatures.hh>
61 : #include <EnergyPlus/GroundTemperatureModeling/SiteFCFactorMethodGroundTemperatures.hh>
62 : #include <EnergyPlus/GroundTemperatureModeling/SiteShallowGroundTemperatures.hh>
63 : #include <EnergyPlus/GroundTemperatureModeling/XingGroundTemperatureModel.hh>
64 : #include <EnergyPlus/UtilityRoutines.hh>
65 :
66 : namespace EnergyPlus {
67 :
68 : namespace GroundTemperatureManager {
69 :
70 : constexpr std::array<std::string_view, static_cast<int>(GroundTempObjType::Num)> groundTempModelNamesUC = {
71 : "SITE:GROUNDTEMPERATURE:UNDISTURBED:KUSUDAACHENBACH",
72 : "SITE:GROUNDTEMPERATURE:UNDISTURBED:FINITEDIFFERENCE",
73 : "SITE:GROUNDTEMPERATURE:BUILDINGSURFACE",
74 : "SITE:GROUNDTEMPERATURE:SHALLOW",
75 : "SITE:GROUNDTEMPERATURE:DEEP",
76 : "SITE:GROUNDTEMPERATURE:FCFACTORMETHOD",
77 : "SITE:GROUNDTEMPERATURE:UNDISTURBED:XING"};
78 :
79 : constexpr std::array<std::string_view, static_cast<int>(GroundTempObjType::Num)> groundTempModelNames = {
80 : "Site:GroundTemperature:Undisturbed:KusudaAchenbach",
81 : "Site:GroundTemperature:Undisturbed:FiniteDifference",
82 : "Site:GroundTemperature:BuildingSurface",
83 : "Site:GroundTemperature:Shallow",
84 : "Site:GroundTemperature:Deep",
85 : "Site:GroundTemperature:FCfactorMethod",
86 : "Site:GroundTemperature:Undisturbed:Xing"};
87 :
88 : std::shared_ptr<BaseGroundTempsModel>
89 3119 : GetGroundTempModelAndInit(EnergyPlusData &state, std::string_view const objectType_str, std::string const &objectName)
90 : {
91 : // SUBROUTINE INFORMATION:
92 : // AUTHOR Matt Mitchell
93 : // DATE WRITTEN Summer 2015
94 : // MODIFIED na
95 : // RE-ENGINEERED na
96 :
97 : // PURPOSE OF THIS SUBROUTINE:
98 : // Called by objects requiring ground temperature models. Determines type and calls appropriate factory method.
99 :
100 : // Set object type
101 : GroundTempObjType objectType =
102 3119 : static_cast<GroundTempObjType>(getEnumerationValue(groundTempModelNamesUC, UtilityRoutines::MakeUPPERCase(objectType_str)));
103 :
104 3119 : assert(objectType != GroundTempObjType::Invalid);
105 :
106 3119 : int numGTMs = state.dataGrndTempModelMgr->groundTempModels.size();
107 :
108 : // Check if this instance of this model has already been retrieved
109 7885 : for (int i = 0; i < numGTMs; ++i) {
110 9532 : auto currentModel(state.dataGrndTempModelMgr->groundTempModels[i]);
111 : // Check if the type and name match
112 4766 : if (objectType == currentModel->objectType && objectName == currentModel->objectName) {
113 0 : return state.dataGrndTempModelMgr->groundTempModels[i];
114 : }
115 : }
116 :
117 : // If not found, create new instance of the model
118 3119 : if (objectType == GroundTempObjType::KusudaGroundTemp) {
119 33 : return KusudaGroundTempsModel::KusudaGTMFactory(state, objectName);
120 3086 : } else if (objectType == GroundTempObjType::FiniteDiffGroundTemp) {
121 1 : return FiniteDiffGroundTempsModel::FiniteDiffGTMFactory(state, objectName);
122 3085 : } else if (objectType == GroundTempObjType::SiteBuildingSurfaceGroundTemp) {
123 771 : return SiteBuildingSurfaceGroundTemps::BuildingSurfaceGTMFactory(state, objectName);
124 2314 : } else if (objectType == GroundTempObjType::SiteShallowGroundTemp) {
125 771 : return SiteShallowGroundTemps::ShallowGTMFactory(state, objectName);
126 1543 : } else if (objectType == GroundTempObjType::SiteDeepGroundTemp) {
127 771 : return SiteDeepGroundTemps::DeepGTMFactory(state, objectName);
128 772 : } else if (objectType == GroundTempObjType::SiteFCFactorMethodGroundTemp) {
129 771 : return SiteFCFactorMethodGroundTemps::FCFactorGTMFactory(state, objectName);
130 1 : } else if (objectType == GroundTempObjType::XingGroundTemp) {
131 1 : return XingGroundTempsModel::XingGTMFactory(state, objectName);
132 : } else {
133 0 : assert(false);
134 : return nullptr;
135 : }
136 : }
137 :
138 : } // namespace GroundTemperatureManager
139 :
140 2313 : } // namespace EnergyPlus
|
