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 ZoneContaminantPredictorCorrector_hh_INCLUDED
49 : #define ZoneContaminantPredictorCorrector_hh_INCLUDED
50 :
51 : // EnergyPlus Headers
52 : #include <EnergyPlus/Data/BaseData.hh>
53 : #include <EnergyPlus/DataContaminantBalance.hh>
54 : #include <EnergyPlus/DataHeatBalFanSys.hh>
55 : #include <EnergyPlus/EnergyPlus.hh>
56 :
57 : namespace EnergyPlus {
58 :
59 : // Forward declarations
60 : struct EnergyPlusData;
61 :
62 : namespace ZoneContaminantPredictorCorrector {
63 :
64 : void ManageZoneContaminanUpdates(EnergyPlusData &state,
65 : DataHeatBalFanSys::PredictorCorrectorCtrl UpdateType, // Can be iGetZoneSetPoints, iPredictStep, iCorrectStep
66 : bool ShortenTimeStepSys,
67 : bool UseZoneTimeStepHistory, // if true then use zone timestep history, if false use system time step
68 : Real64 PriorTimeStep // the old value for timestep length is passed for possible use in interpolating
69 : );
70 :
71 : void GetZoneContaminanInputs(EnergyPlusData &state);
72 :
73 : void GetZoneContaminanSetPoints(EnergyPlusData &state);
74 :
75 : void InitZoneContSetPoints(EnergyPlusData &state);
76 :
77 : void PredictZoneContaminants(EnergyPlusData &state,
78 : bool ShortenTimeStepSys,
79 : bool UseZoneTimeStepHistory, // if true then use zone timestep history, if false use system time step
80 : Real64 PriorTimeStep // the old value for timestep length is passed for possible use in interpolating
81 : );
82 :
83 : void PushZoneTimestepHistories(EnergyPlusData &state);
84 :
85 : void PushSystemTimestepHistories(EnergyPlusData &state);
86 :
87 : void RevertZoneTimestepHistories(EnergyPlusData &state);
88 :
89 : void InverseModelCO2(EnergyPlusData &state,
90 : int ZoneNum, // Zone number
91 : Real64 &CO2Gain, // Zone total CO2 gain
92 : Real64 &CO2GainExceptPeople, // ZOne total CO2 gain from sources except for people
93 : Real64 &ZoneMassFlowRate, // Zone air mass flow rate
94 : Real64 &CO2MassFlowRate, // Zone air CO2 mass flow rate
95 : Real64 &RhoAir // Air density
96 : );
97 :
98 : void CorrectZoneContaminants(EnergyPlusData &state,
99 : bool UseZoneTimeStepHistory // if true then use zone timestep history, if false use system time step history
100 : );
101 :
102 : } // namespace ZoneContaminantPredictorCorrector
103 :
104 771 : struct ZoneContaminantPredictorCorrectorData : BaseGlobalStruct
105 : {
106 : bool GetZoneAirContamInputFlag = true; // True when need to get input
107 : bool MyOneTimeFlag = true;
108 : bool MyEnvrnFlag = true;
109 : bool MyConfigOneTimeFlag = true;
110 :
111 0 : void clear_state() override
112 : {
113 0 : *this = ZoneContaminantPredictorCorrectorData();
114 0 : }
115 : };
116 :
117 : } // namespace EnergyPlus
118 :
119 : #endif
|