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 : // EnergyPlus Headers
49 : #include <EnergyPlus/Data/EnergyPlusData.hh>
50 : #include <EnergyPlus/DataSurfaceColors.hh>
51 : #include <EnergyPlus/InputProcessing/InputProcessor.hh>
52 : #include <EnergyPlus/UtilityRoutines.hh>
53 :
54 : namespace EnergyPlus::DataSurfaceColors {
55 :
56 : // Module containing the data dealing with the coloring of surfaces for
57 : // various outputs (such as DXF)
58 :
59 : // MODULE INFORMATION:
60 : // AUTHOR Linda Lawrie
61 : // DATE WRITTEN Aug 2007
62 : // MODIFIED na
63 : // RE-ENGINEERED na
64 :
65 : // PURPOSE OF THIS MODULE:
66 : // Contain the data for surface colors and user settings for DXF and possibly
67 : // other surface reporting.
68 :
69 4 : bool MatchAndSetColorTextString(EnergyPlusData &state,
70 : std::string const &String, // string to be matched
71 : int const SetValue, // value to be used for the color
72 : std::string_view const ColorType // for now, must be DXF and probably not a string in the future
73 : )
74 : {
75 :
76 : // FUNCTION INFORMATION:
77 : // AUTHOR Linda Lawrie
78 : // DATE WRITTEN August 2007
79 : // MODIFIED na
80 : // RE-ENGINEERED na
81 :
82 : static constexpr std::array<std::string_view, static_cast<int>(DataSurfaceColors::ColorNo::Num)> colorkeys = {
83 : "TEXT",
84 : "WALLS",
85 : "WINDOWS",
86 : "GLASSDOORS",
87 : "DOORS",
88 : "ROOFS",
89 : "FLOORS",
90 : "DETACHEDBUILDINGSHADES",
91 : "DETACHEDFIXEDSHADES",
92 : "ATTACHEDBUILDINGSHADES",
93 : "PHOTOVOLTAICS",
94 : "TUBULARDAYLIGHTDOMES",
95 : "TUBULARDAYLIGHTDIFFUSERS",
96 : "DAYLIGHTREFERENCEPOINT1",
97 : "DAYLIGHTREFERENCEPOINT2",
98 : };
99 :
100 : // ColorType must be "DXF"
101 4 : if (ColorType != "DXF") return false;
102 :
103 : // try to find enum value
104 4 : int foundIdx = getEnumValue(colorkeys, Util::makeUPPER(String));
105 4 : if (foundIdx == -1) return false;
106 :
107 : // if we've made it here, we found the value
108 3 : state.dataSurfColor->DXFcolorno[foundIdx] = SetValue;
109 3 : return true;
110 : }
111 :
112 1 : void SetUpSchemeColors(EnergyPlusData &state, std::string const &SchemeName, std::string_view const ColorType)
113 : {
114 :
115 : // SUBROUTINE INFORMATION:
116 : // AUTHOR Linda Lawrie
117 : // DATE WRITTEN August 2007
118 : // MODIFIED na
119 : // RE-ENGINEERED na
120 :
121 : // PURPOSE OF THIS SUBROUTINE:
122 : // This routine resets the colorno array(s) with the entered scheme name as
123 : // required for reporting.
124 :
125 : // METHODOLOGY EMPLOYED:
126 : // This routine first sets the color arrays to default. Then, attempts to find the
127 : // scheme name in the Input File. If found, processes that scheme and sets colors.
128 : // Worst case: the colors remain as default. Note -- this allocates and deallocates
129 : // the alphas and numerics required to process the Report:SurfaceColorScheme object.
130 :
131 : // SUBROUTINE PARAMETER DEFINITIONS:
132 1 : constexpr std::string_view CurrentModuleObject("OutputControl:SurfaceColorScheme");
133 :
134 1 : state.dataSurfColor->DXFcolorno = DataSurfaceColors::defaultcolorno;
135 :
136 : // first see if there is a scheme name
137 1 : int numptr = state.dataInputProcessing->inputProcessor->getObjectItemNum(state, CurrentModuleObject, SchemeName);
138 1 : if (numptr > 0) {
139 :
140 : int NumAlphas;
141 : int numNumbers;
142 : int numargs;
143 : int status;
144 1 : Array1D_string cAlphas;
145 1 : Array1D_string cAlphaFields;
146 1 : Array1D_string cNumericFields;
147 1 : Array1D_bool lAlphaBlanks;
148 1 : Array1D_bool lNumericBlanks;
149 1 : Array1D<Real64> rNumerics;
150 1 : state.dataInputProcessing->inputProcessor->getObjectDefMaxArgs(state, CurrentModuleObject, numargs, NumAlphas, numNumbers);
151 :
152 1 : cAlphas.allocate(NumAlphas);
153 1 : cAlphaFields.allocate(NumAlphas);
154 1 : lAlphaBlanks.allocate(NumAlphas);
155 1 : rNumerics.allocate(numNumbers);
156 1 : cNumericFields.allocate(numNumbers);
157 1 : lNumericBlanks.allocate(numNumbers);
158 :
159 1 : cAlphas({1, NumAlphas}) = "";
160 1 : rNumerics({1, numNumbers}) = 0.0;
161 :
162 1 : state.dataInputProcessing->inputProcessor->getObjectItem(state,
163 : CurrentModuleObject,
164 : numptr,
165 : cAlphas,
166 : NumAlphas,
167 : rNumerics,
168 : numNumbers,
169 : status,
170 : lNumericBlanks,
171 : lAlphaBlanks,
172 : cAlphaFields,
173 : cNumericFields);
174 2 : for (numargs = 1; numargs <= numNumbers; ++numargs) {
175 1 : numptr = rNumerics(numargs); // set to integer
176 1 : if (lNumericBlanks(numargs)) {
177 0 : if (!lAlphaBlanks(numargs + 1)) {
178 0 : ShowWarningError(state,
179 0 : format("SetUpSchemeColors: {}={}, {}={}, {} was blank. Default color retained.",
180 : cAlphaFields(1),
181 : SchemeName,
182 : cAlphaFields(numargs + 1),
183 : cAlphas(numargs + 1),
184 : cNumericFields(numargs)));
185 : }
186 0 : continue;
187 : }
188 1 : if (!MatchAndSetColorTextString(state, cAlphas(numargs + 1), numptr, ColorType)) {
189 0 : ShowWarningError(state,
190 0 : format("SetUpSchemeColors: {}={}, {}={}, is invalid. No color set.",
191 : cAlphaFields(1),
192 : SchemeName,
193 : cAlphaFields(numargs + 1),
194 : cAlphas(numargs + 1)));
195 : }
196 : }
197 1 : } else {
198 0 : ShowWarningError(state, format("SetUpSchemeColors: Name={} not on input file. Default colors will be used.", SchemeName));
199 : }
200 1 : }
201 :
202 : } // namespace EnergyPlus::DataSurfaceColors
|
