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 OutputReportData_hh_INCLUDED
49 : #define OutputReportData_hh_INCLUDED
50 :
51 : // C++ Headers
52 : #include <string>
53 : #include <vector>
54 :
55 : // ObjexxFCL Headers
56 : #include <ObjexxFCL/Array1D.hh>
57 : #include <ObjexxFCL/Array2D.hh>
58 : #include <ObjexxFCL/Array2S.hh>
59 : #include <ObjexxFCL/Array3D.hh>
60 : #include <ObjexxFCL/Optional.hh>
61 :
62 : // EnergyPlus Headers
63 : #include <EnergyPlus/EnergyPlus.hh>
64 : #include <EnergyPlus/OutputProcessor.hh>
65 :
66 : namespace EnergyPlus {
67 :
68 0 : class AnnualFieldSet
69 : {
70 : public:
71 : enum AggregationKind
72 : {
73 : sumOrAvg,
74 : maximum,
75 : minimum,
76 : hoursNonZero,
77 : hoursZero,
78 : hoursPositive,
79 : hoursNonPositive,
80 : hoursNegative,
81 : hoursNonNegative,
82 : hoursInTenPercentBins,
83 : hoursInTenBinsMinToMax,
84 : hoursInTenBinsZeroToMax,
85 : hoursInTenBinsMinToZero,
86 : hoursInTenBinsPlusMinusTwoStdDev,
87 : hoursInTenBinsPlusMinusThreeStdDev,
88 : noAggregation,
89 : valueWhenMaxMin,
90 : sumOrAverageHoursShown,
91 : maximumDuringHoursShown,
92 : minimumDuringHoursShown,
93 : };
94 :
95 : // default constructor
96 0 : AnnualFieldSet()
97 0 : : m_variMeter(""), m_colHead(""), m_aggregate(sumOrAvg), m_varUnits(OutputProcessor::Unit::None),
98 : m_typeOfVar(OutputProcessor::VariableType::NotFound), m_keyCount(0), m_varAvgSum(OutputProcessor::StoreType::Averaged), m_bottomBinValue(0),
99 0 : m_topBinValue(0)
100 : {
101 0 : }
102 :
103 : // constructor
104 : AnnualFieldSet(std::string varName, AnnualFieldSet::AggregationKind kindOfAggregation, int numDigitsShown);
105 :
106 0 : struct AnnualCell
107 : {
108 : int indexesForKeyVar; // keyVarIndexes for each namesOfKeys
109 : Real64 result; // annual results
110 : Real64 duration; // the time during which results are summed for use in averages
111 : int timeStamp; // encoded timestamp of max or min
112 : std::vector<Real64> deferredResults; // used for the binned cases when size of bins is being calculated later
113 : std::vector<Real64> deferredElapsed; // the elapsed time for each result
114 : Real64 m_timeAboveTopBin;
115 : Real64 m_timeBelowBottomBin;
116 : std::vector<Real64> m_timeInBin; // amount of time in each bin (usually 10 bins)
117 : };
118 :
119 : int getVariableKeyCountandTypeFromFldSt(EnergyPlusData &state,
120 : OutputProcessor::VariableType &typeVar,
121 : OutputProcessor::StoreType &avgSumVar,
122 : OutputProcessor::TimeStepType &stepTypeVar,
123 : OutputProcessor::Unit &unitsVar);
124 :
125 : void getVariableKeysFromFldSt(EnergyPlusData &state,
126 : OutputProcessor::VariableType &typeVar,
127 : int keyCount,
128 : std::vector<std::string> &namesOfKeys,
129 : std::vector<int> &indexesForKeyVar);
130 :
131 : std::string m_variMeter; // the name of the variable or meter
132 : std::string m_colHead; // the column header to use instead of the variable name (only for predefined)
133 : AggregationKind m_aggregate; // the type of aggregation for the variable (see aggType parameters)
134 : int m_showDigits; // the number of digits to be shown
135 : OutputProcessor::Unit m_varUnits; // Units sting, may be blank
136 : OutputProcessor::VariableType m_typeOfVar; // 0=not found, 1=integer, 2=real, 3=meter
137 : int m_keyCount;
138 : OutputProcessor::StoreType m_varAvgSum; // Variable is Averaged=1 or Summed=2
139 : OutputProcessor::TimeStepType m_varStepType; // Variable time step is Zone=1 or HVAC=2
140 : std::vector<std::string> m_namesOfKeys; // stored version of name of keys from getVariableKeys
141 : std::vector<int> m_indexesForKeyVar; // stored version of name of keys from getVariableKeys
142 : std::vector<AnnualCell> m_cell; // for each row contains the results and details for one cell of the table
143 : Real64 m_bottomBinValue; // the bottom of the binning for a column
144 : Real64 m_topBinValue; // the top of the binning for a column
145 : Real64 m_timeAboveTopBinTotal;
146 : Real64 m_timeBelowBottomBinTotal;
147 : std::vector<Real64> m_timeInBinTotal; // amount of time in each bin (usually 10 bins)
148 : };
149 :
150 : } // namespace EnergyPlus
151 :
152 : #endif
|
