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