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 GlobalNames_hh_INCLUDED
49 : #define GlobalNames_hh_INCLUDED
50 :
51 : // C++ Headers
52 : #include <unordered_map>
53 : #include <unordered_set>
54 :
55 : // ObjexxFCL Headers
56 : #include <ObjexxFCL/Array1D.hh>
57 :
58 : // EnergyPlus Headers
59 : #include <EnergyPlus/Data/BaseData.hh>
60 : #include <EnergyPlus/DataGlobals.hh>
61 : #include <EnergyPlus/EnergyPlus.hh>
62 :
63 : namespace EnergyPlus {
64 :
65 : // Forward declarations
66 : struct EnergyPlusData;
67 :
68 : namespace GlobalNames {
69 :
70 : struct ComponentNameData
71 : {
72 : // Members
73 : std::string CompType; // Component Type
74 : std::string CompName; // Component Name (user supplied)
75 :
76 : // Default Constructor
77 : ComponentNameData() = default;
78 : };
79 :
80 : void IntraObjUniquenessCheck(EnergyPlusData &state,
81 : std::string const &NameToVerify,
82 : std::string_view const CurrentModuleObject,
83 : std::string_view FieldName,
84 : std::unordered_set<std::string> &UniqueStrings,
85 : bool &ErrorsFound);
86 :
87 : bool VerifyUniqueInterObjectName(EnergyPlusData &state,
88 : std::unordered_map<std::string, std::string> &names,
89 : std::string const &object_name,
90 : std::string_view object_type,
91 : std::string_view field_name,
92 : bool &ErrorsFound);
93 :
94 : bool VerifyUniqueInterObjectName(EnergyPlusData &state,
95 : std::unordered_map<std::string, std::string> &names,
96 : std::string const &object_name,
97 : std::string const &object_type,
98 : bool &ErrorsFound);
99 :
100 : void VerifyUniqueChillerName(EnergyPlusData &state,
101 : std::string_view TypeToVerify,
102 : std::string const &NameToVerify,
103 : bool &ErrorsFound, // returns true if duplicate name found, unchanged otherwise
104 : std::string const &StringToDisplay);
105 :
106 : void VerifyUniqueBaseboardName(EnergyPlusData &state,
107 : std::string_view const &TypeToVerify,
108 : std::string const &NameToVerify,
109 : bool &ErrorsFound, // returns true if duplicate name found, unchanged otherwise
110 : std::string const &StringToDisplay);
111 :
112 : void VerifyUniqueBoilerName(EnergyPlusData &state,
113 : std::string const &TypeToVerify,
114 : std::string const &NameToVerify,
115 : bool &ErrorsFound, // returns true if duplicate name found, unchanged otherwise
116 : std::string const &StringToDisplay);
117 :
118 : void VerifyUniqueCoilName(EnergyPlusData &state,
119 : std::string const &TypeToVerify,
120 : std::string &NameToVerify,
121 : bool &ErrorsFound, // returns true if duplicate name found, unchanged otherwise
122 : std::string const &StringToDisplay);
123 :
124 : void VerifyUniqueADUName(EnergyPlusData &state,
125 : std::string const &TypeToVerify,
126 : std::string const &NameToVerify,
127 : bool &ErrorsFound, // returns true if duplicate name found, unchanged otherwise
128 : std::string const &StringToDisplay);
129 :
130 : } // namespace GlobalNames
131 :
132 : struct GlobalNamesData : BaseGlobalStruct
133 : {
134 :
135 : int NumChillers = 0;
136 : int NumBoilers = 0;
137 : int NumBaseboards = 0;
138 : int NumCoils = 0;
139 : int CurMaxChillers = 0;
140 : int CurMaxCoils = 0;
141 : int numAirDistUnits = 0;
142 : std::unordered_map<std::string, std::string> ChillerNames;
143 : std::unordered_map<std::string, std::string> BoilerNames;
144 : std::unordered_map<std::string, std::string> BaseboardNames;
145 : std::unordered_map<std::string, std::string> CoilNames;
146 : std::unordered_map<std::string, std::string> aDUNames;
147 :
148 2126 : void init_constant_state([[maybe_unused]] EnergyPlusData &state) override
149 : {
150 2126 : }
151 :
152 1152 : void init_state([[maybe_unused]] EnergyPlusData &state) override
153 : {
154 1152 : }
155 :
156 2100 : void clear_state() override
157 : {
158 2100 : this->NumChillers = 0;
159 2100 : this->NumBoilers = 0;
160 2100 : this->NumBaseboards = 0;
161 2100 : this->NumCoils = 0;
162 2100 : this->CurMaxChillers = 0;
163 2100 : this->CurMaxCoils = 0;
164 2100 : this->numAirDistUnits = 0;
165 2100 : this->ChillerNames.clear();
166 2100 : this->BoilerNames.clear();
167 2100 : this->BaseboardNames.clear();
168 2100 : this->CoilNames.clear();
169 2100 : this->aDUNames.clear();
170 2100 : }
171 : };
172 :
173 : } // namespace EnergyPlus
174 :
175 : #endif
|
