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