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 HVACManager_hh_INCLUDED
49 : #define HVACManager_hh_INCLUDED
50 :
51 : // ObjexxFCL Headers
52 : #include <ObjexxFCL/Array1D.hh>
53 :
54 : // EnergyPlus Headers
55 : #include <EnergyPlus/Data/BaseData.hh>
56 : #include <EnergyPlus/EnergyPlus.hh>
57 :
58 : namespace EnergyPlus {
59 :
60 : // Forward declarations
61 : struct EnergyPlusData;
62 :
63 : namespace HVACManager {
64 :
65 : // SUBROUTINE SPECIFICATIONS FOR MODULE PrimaryPlantLoops
66 : // and zone equipment simulations
67 :
68 : // Functions
69 : void ManageHVAC(EnergyPlusData &state);
70 :
71 : void SimHVAC(EnergyPlusData &state);
72 :
73 : void SimSelectedEquipment(EnergyPlusData &state,
74 : bool &SimAirLoops, // True when the air loops need to be (re)simulated
75 : bool &SimZoneEquipment, // True when zone equipment components need to be (re)simulated
76 : bool &SimNonZoneEquipment, // True when non-zone equipment components need to be (re)simulated
77 : bool &SimPlantLoops, // True when the main plant loops need to be (re)simulated
78 : bool &SimElecCircuits, // True when electic circuits need to be (re)simulated
79 : bool &FirstHVACIteration, // True when solution technique on first iteration
80 : bool const LockPlantFlows);
81 :
82 : void ResetTerminalUnitFlowLimits(EnergyPlusData &state);
83 :
84 : void ResolveAirLoopFlowLimits(EnergyPlusData &state);
85 :
86 : void ResolveLockoutFlags(EnergyPlusData &state, bool &SimAir); // TRUE means air loops must be (re)simulated
87 :
88 : void ResetHVACControl(EnergyPlusData &state);
89 :
90 : void ResetNodeData(EnergyPlusData &state);
91 :
92 : void UpdateZoneListAndGroupLoads(EnergyPlusData &state);
93 :
94 : void ReportAirHeatBalance(EnergyPlusData &state);
95 :
96 : void SetHeatToReturnAirFlag(EnergyPlusData &state);
97 :
98 : void UpdateZoneInletConvergenceLog(EnergyPlusData &state);
99 :
100 : void CheckAirLoopFlowBalance(EnergyPlusData &state);
101 :
102 : } // namespace HVACManager
103 :
104 1542 : struct HVACManagerData : BaseGlobalStruct
105 : {
106 :
107 : int HVACManageIteration = 0; // counts iterations to enforce maximum iteration limit
108 : int RepIterAir = 0;
109 : bool SimHVACIterSetup = false;
110 : bool TriggerGetAFN = true;
111 : bool ReportAirHeatBalanceFirstTimeFlag = true;
112 : bool MyOneTimeFlag = true;
113 : bool PrintedWarmup = false;
114 : bool MyEnvrnFlag = true;
115 : bool DebugNamesReported = false;
116 : bool MySetPointInit = true;
117 : bool MyEnvrnFlag2 = true;
118 : bool FlowMaxAvailAlreadyReset = false;
119 : bool FlowResolutionNeeded = false;
120 : int ErrCount = 0; // Number of times that the maximum iterations was exceeded
121 : int MaxErrCount = 0;
122 : std::string ErrEnvironmentName;
123 : Array1D<Real64> MixSenLoad; // Mixing sensible loss or gain
124 : Array1D<Real64> MixLatLoad; // Mixing latent loss or gain
125 :
126 0 : void clear_state() override
127 : {
128 0 : HVACManageIteration = 0;
129 0 : RepIterAir = 0;
130 0 : SimHVACIterSetup = false;
131 0 : TriggerGetAFN = true;
132 0 : ReportAirHeatBalanceFirstTimeFlag = true;
133 0 : MyOneTimeFlag = true;
134 0 : PrintedWarmup = false;
135 0 : MyEnvrnFlag = true;
136 0 : DebugNamesReported = false;
137 0 : MySetPointInit = true;
138 0 : MyEnvrnFlag2 = true;
139 0 : FlowMaxAvailAlreadyReset = false;
140 0 : FlowResolutionNeeded = false;
141 0 : this->ErrCount = 0;
142 0 : this->MaxErrCount = 0;
143 0 : this->MixSenLoad.clear();
144 0 : this->MixLatLoad.clear();
145 0 : }
146 : };
147 :
148 : } // namespace EnergyPlus
149 :
150 : #endif
|