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 : #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 : enum class GroundTempObjType
61 : {
62 : Invalid = -1,
63 : KusudaGroundTemp,
64 : FiniteDiffGroundTemp,
65 : SiteBuildingSurfaceGroundTemp,
66 : SiteShallowGroundTemp,
67 : SiteDeepGroundTemp,
68 : SiteFCFactorMethodGroundTemp,
69 : XingGroundTemp,
70 : Num
71 : };
72 :
73 : // Base class
74 : class BaseGroundTempsModel
75 : {
76 : public:
77 : // Public Members
78 : GroundTempObjType objectType;
79 : std::string objectName;
80 :
81 3120 : virtual ~BaseGroundTempsModel() = default;
82 : BaseGroundTempsModel(const BaseGroundTempsModel &) = delete;
83 : BaseGroundTempsModel(BaseGroundTempsModel &&) = delete;
84 : BaseGroundTempsModel &operator=(const BaseGroundTempsModel &) = delete;
85 : BaseGroundTempsModel &operator=(BaseGroundTempsModel &&) = delete;
86 :
87 : // Default Constructor
88 3120 : BaseGroundTempsModel() : objectType(GroundTempObjType::Invalid)
89 : {
90 3120 : }
91 :
92 : // Virtual method for retrieving the ground temp
93 : virtual Real64 getGroundTemp(EnergyPlusData &state) = 0;
94 :
95 : virtual Real64 getGroundTempAtTimeInSeconds(EnergyPlusData &state, Real64 const, Real64 const) = 0;
96 :
97 : virtual Real64 getGroundTempAtTimeInMonths(EnergyPlusData &state, Real64 const, int const) = 0;
98 :
99 : protected:
100 3075 : static void write_ground_temps(InputOutputFile &os, const std::string &name, const Array1D<Real64> &data)
101 : {
102 3075 : print<FormatSyntax::FMT>(os,
103 : "! "
104 : "<Site:GroundTemperature:{}>,Jan{{C}},Feb{{C}},Mar{{C}},Apr{{C}},May{{C}},Jun{{C}},Jul{{C}},Aug{{C}},Sep{{C}},Oct{{"
105 : "C}},Nov{{C}},Dec{{C}}\n",
106 3075 : name);
107 6150 : print<FormatSyntax::FMT>(os, " Site:GroundTemperature:{}, {}\n", name, fmt::format("{:6.2F}", fmt::join(data, ", ")));
108 3075 : }
109 : };
110 :
111 : } // namespace EnergyPlus
112 :
113 : #endif
|
