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 : #ifndef BaseGroundTemperatureModel_hh_INCLUDED
49 : #define BaseGroundTemperatureModel_hh_INCLUDED
50 :
51 : // EnergyPlus Headers
52 : #include <EnergyPlus/DataGlobals.hh>
53 : #include <EnergyPlus/EnergyPlus.hh>
54 :
55 : namespace EnergyPlus {
56 :
57 : // Forward declarations
58 : struct EnergyPlusData;
59 :
60 : namespace GroundTemp {
61 :
62 : enum class ModelType
63 : {
64 : Invalid = -1,
65 : Kusuda,
66 : FiniteDiff,
67 : SiteBuildingSurface,
68 : SiteShallow,
69 : SiteDeep,
70 : SiteFCFactorMethod,
71 : Xing,
72 : Num
73 : };
74 :
75 : constexpr std::array<std::string_view, (int)ModelType::Num> modelTypeNamesUC = {"SITE:GROUNDTEMPERATURE:UNDISTURBED:KUSUDAACHENBACH",
76 : "SITE:GROUNDTEMPERATURE:UNDISTURBED:FINITEDIFFERENCE",
77 : "SITE:GROUNDTEMPERATURE:BUILDINGSURFACE",
78 : "SITE:GROUNDTEMPERATURE:SHALLOW",
79 : "SITE:GROUNDTEMPERATURE:DEEP",
80 : "SITE:GROUNDTEMPERATURE:FCFACTORMETHOD",
81 : "SITE:GROUNDTEMPERATURE:UNDISTURBED:XING"};
82 :
83 : constexpr std::array<std::string_view, (int)ModelType::Num> modelTypeNames = {"Site:GroundTemperature:Undisturbed:KusudaAchenbach",
84 : "Site:GroundTemperature:Undisturbed:FiniteDifference",
85 : "Site:GroundTemperature:BuildingSurface",
86 : "Site:GroundTemperature:Shallow",
87 : "Site:GroundTemperature:Deep",
88 : "Site:GroundTemperature:FCfactorMethod",
89 : "Site:GroundTemperature:Undisturbed:Xing"};
90 :
91 : // Base class
92 : class BaseGroundTempsModel
93 : {
94 : public:
95 : // Public Members
96 : std::string Name;
97 : ModelType modelType = ModelType::Invalid;
98 :
99 506 : BaseGroundTempsModel() = default;
100 414 : virtual ~BaseGroundTempsModel() = default;
101 : BaseGroundTempsModel(const BaseGroundTempsModel &) = delete;
102 : BaseGroundTempsModel(BaseGroundTempsModel &&) = delete;
103 : BaseGroundTempsModel &operator=(const BaseGroundTempsModel &) = delete;
104 : BaseGroundTempsModel &operator=(BaseGroundTempsModel &&) = delete;
105 :
106 : // Virtual method for retrieving the ground temp
107 : virtual Real64 getGroundTemp(EnergyPlusData &state) = 0;
108 :
109 : virtual Real64 getGroundTempAtTimeInSeconds(EnergyPlusData &state, Real64, Real64) = 0; // parameter names, this isn't K&R C
110 :
111 : virtual Real64 getGroundTempAtTimeInMonths(EnergyPlusData &state, Real64, int) = 0; // parameter names, this isn't K&R C
112 :
113 : protected:
114 363 : static void write_ground_temps(InputOutputFile &os, const std::string &name, const Array1D<Real64> &data)
115 : {
116 363 : print<FormatSyntax::FMT>(
117 : os,
118 : "! "
119 : "<Site:GroundTemperature:{}>,Jan{{C}},Feb{{C}},Mar{{C}},Apr{{C}},May{{C}},Jun{{C}},Jul{{C}},Aug{{C}},Sep{{C}},Oct{{"
120 : "C}},Nov{{C}},Dec{{C}}\n",
121 : name);
122 726 : print<FormatSyntax::FMT>(os, " Site:GroundTemperature:{}, {}\n", name, fmt::format("{:6.2F}", fmt::join(data, ", ")));
123 363 : }
124 : };
125 :
126 : BaseGroundTempsModel *GetGroundTempModelAndInit(EnergyPlusData &state, ModelType modelType, std::string const &name);
127 :
128 : } // namespace GroundTemp
129 :
130 : struct GroundTemperatureManagerData final : BaseGlobalStruct
131 : {
132 : // all ground temperature model instances are owned here
133 : // client component models can get pointers to the instances inside this vector, but they don't own them
134 : std::vector<GroundTemp::BaseGroundTempsModel *> groundTempModels;
135 :
136 2126 : void init_constant_state([[maybe_unused]] EnergyPlusData &state) override
137 : {
138 2126 : }
139 :
140 1152 : void init_state([[maybe_unused]] EnergyPlusData &state) override
141 : {
142 1152 : }
143 :
144 2100 : void clear_state() override
145 : {
146 2509 : for (const auto &groundTempModel : groundTempModels) {
147 409 : delete groundTempModel;
148 : }
149 2100 : new (this) GroundTemperatureManagerData();
150 2100 : }
151 :
152 4210 : virtual ~GroundTemperatureManagerData() = default;
153 : };
154 :
155 : } // namespace EnergyPlus
156 :
157 : #endif
|
