Line data Source code
1 : // EnergyPlus, Copyright (c) 1996-2024, 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 OutputReportTabularAnnual_hh_INCLUDED
49 : #define OutputReportTabularAnnual_hh_INCLUDED
50 :
51 : // C++ Headers
52 : #include <ostream>
53 : #include <string>
54 : #include <vector>
55 :
56 : // ObjexxFCL Headers
57 : #include <ObjexxFCL/Array1D.hh>
58 : #include <ObjexxFCL/Array2D.hh>
59 : #include <ObjexxFCL/Array2S.hh>
60 : #include <ObjexxFCL/Array3D.hh>
61 :
62 : // EnergyPlus Headers
63 : #include <EnergyPlus/Data/BaseData.hh>
64 : #include <EnergyPlus/EnergyPlus.hh>
65 : #include <EnergyPlus/OutputReportData.hh>
66 : #include <EnergyPlus/ScheduleManager.hh>
67 :
68 : namespace EnergyPlus {
69 :
70 : // Forward declarations
71 : struct EnergyPlusData;
72 :
73 : namespace OutputReportTabularAnnual {
74 :
75 : // these functions are not in the class and act as an interface between procedural code and object oriented
76 :
77 : void GetInputTabularAnnual(EnergyPlusData &state);
78 :
79 : void checkAggregationOrderForAnnual(EnergyPlusData &state);
80 :
81 : void GatherAnnualResultsForTimeStep(EnergyPlusData &state, OutputProcessor::TimeStepType kindOfTypeStep);
82 :
83 : void ResetAnnualGathering(EnergyPlusData &state);
84 :
85 : void WriteAnnualTables(EnergyPlusData &state);
86 :
87 : void AddAnnualTableOfContents(EnergyPlusData &state, std::ostream &);
88 :
89 : AnnualFieldSet::AggregationKind stringToAggKind(EnergyPlusData &state, std::string inString);
90 :
91 : class AnnualTable
92 : {
93 : public:
94 : // Default Constructor
95 : AnnualTable() : m_name(""), m_filter(""), m_scheduleName(""), m_scheduleNum(0){};
96 :
97 : // Member Constructor
98 0 : AnnualTable(EnergyPlusData &state, std::string name, std::string filter, std::string scheduleName)
99 0 : {
100 0 : m_name = name;
101 0 : m_filter = filter;
102 0 : m_scheduleName = scheduleName;
103 0 : if (!m_scheduleName.empty()) {
104 0 : m_scheduleNum = ScheduleManager::GetScheduleIndex(state, m_scheduleName); // index to the period schedule
105 : } else {
106 0 : m_scheduleNum = 0;
107 : }
108 0 : };
109 :
110 : void addFieldSet(std::string, AnnualFieldSet::AggregationKind, int);
111 :
112 : void addFieldSet(std::string, std::string, AnnualFieldSet::AggregationKind, int);
113 :
114 : void setupGathering(EnergyPlusData &state);
115 :
116 : bool invalidAggregationOrder(EnergyPlusData &state);
117 :
118 : void gatherForTimestep(EnergyPlusData &state, OutputProcessor::TimeStepType kindOfTypeStep);
119 :
120 : void resetGathering();
121 :
122 : void writeTable(EnergyPlusData &state, OutputReportTabular::UnitsStyle unitsStyle, bool produceTabular_para, bool produceSQLite_para);
123 :
124 : void addTableOfContents(std::ostream &);
125 :
126 : std::vector<std::string> inspectTable();
127 :
128 : std::vector<std::string> inspectTableFieldSets(int);
129 :
130 : void clearTable();
131 :
132 : // this could be private but was made public for unit testing only
133 : void columnHeadersToTitleCase(EnergyPlusData &state);
134 :
135 : private:
136 : // Members
137 :
138 : std::string m_name; // identifier
139 : std::string m_filter;
140 : std::string m_scheduleName;
141 : int m_scheduleNum;
142 : std::vector<std::string> m_objectNames; // for each row of annual table
143 : std::vector<AnnualFieldSet> m_annualFields; // for each column
144 :
145 : Real64 getElapsedTime(EnergyPlusData &state, OutputProcessor::TimeStepType kindOfTimeStep);
146 :
147 : Real64 getSecondsInTimeStep(EnergyPlusData &state, OutputProcessor::TimeStepType kindOfTimeStep);
148 :
149 : void computeBinColumns(EnergyPlusData &state, OutputReportTabular::UnitsStyle unitsStyle_para);
150 :
151 : std::vector<std::string> setupAggString();
152 :
153 : Real64 setEnergyUnitStringAndFactor(OutputReportTabular::UnitsStyle const unitsStyle, std::string &unitString);
154 :
155 : int columnCountForAggregation(AnnualFieldSet::AggregationKind curAgg);
156 :
157 : std::string trim(const std::string &str);
158 :
159 : void fixUnitsPerSecond(std::string &unitString, Real64 &conversionFactor);
160 :
161 : bool allRowsSameSizeDefferedVectors(std::vector<AnnualFieldSet>::iterator fldStIt);
162 :
163 : void convertUnitForDeferredResults(EnergyPlusData &state,
164 : std::vector<AnnualFieldSet>::iterator fldStIt,
165 : OutputReportTabular::UnitsStyle const unitsStyle);
166 :
167 : std::vector<Real64> calculateBins(int const numberOfBins,
168 : std::vector<Real64> const valuesToBin,
169 : std::vector<Real64> const corrElapsedTime,
170 : Real64 const topOfBins,
171 : Real64 const bottomOfBins,
172 : Real64 &timeAboveTopBin,
173 : Real64 &timeBelowBottomBin);
174 :
175 : }; // class AnnualTable
176 :
177 : } // namespace OutputReportTabularAnnual
178 :
179 : struct OutputReportTabularAnnualData : BaseGlobalStruct
180 : {
181 :
182 : std::vector<OutputReportTabularAnnual::AnnualTable> annualTables;
183 :
184 796 : void init_state([[maybe_unused]] EnergyPlusData &state) override
185 : {
186 796 : }
187 :
188 0 : void clear_state() override
189 : {
190 0 : this->annualTables.clear();
191 0 : }
192 : };
193 :
194 : } // namespace EnergyPlus
195 :
196 : #endif
|
