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 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 : #include <EnergyPlus/ZoneTempPredictorCorrector.hh>
58 :
59 : namespace EnergyPlus {
60 :
61 : // Forward declarations
62 : struct EnergyPlusData;
63 :
64 : namespace HVACManager {
65 :
66 : // SUBROUTINE SPECIFICATIONS FOR MODULE PrimaryPlantLoops
67 : // and zone equipment simulations
68 :
69 : enum class ConvErrorCallType
70 : {
71 : Invalid = -1,
72 : MassFlow,
73 : HumidityRatio,
74 : Temperature,
75 : Energy,
76 : CO2,
77 : Generic,
78 : Num
79 : };
80 :
81 : // Functions
82 : void ManageHVAC(EnergyPlusData &state);
83 :
84 : void SimHVAC(EnergyPlusData &state);
85 :
86 : void SimSelectedEquipment(EnergyPlusData &state,
87 : bool &SimAirLoops, // True when the air loops need to be (re)simulated
88 : bool &SimZoneEquipment, // True when zone equipment components need to be (re)simulated
89 : bool &SimNonZoneEquipment, // True when non-zone equipment components need to be (re)simulated
90 : bool &SimPlantLoops, // True when the main plant loops need to be (re)simulated
91 : bool &SimElecCircuits, // True when electric circuits need to be (re)simulated
92 : bool &FirstHVACIteration, // True when solution technique on first iteration
93 : bool LockPlantFlows);
94 :
95 : void ResetTerminalUnitFlowLimits(EnergyPlusData &state);
96 :
97 : void ResolveAirLoopFlowLimits(EnergyPlusData &state);
98 :
99 : void ResolveLockoutFlags(EnergyPlusData &state, bool &SimAir); // TRUE means air loops must be (re)simulated
100 :
101 : void ResetHVACControl(EnergyPlusData const &state);
102 :
103 : void ResetNodeData(EnergyPlusData &state);
104 :
105 : void UpdateZoneListAndGroupLoads(EnergyPlusData &state);
106 :
107 : void ReportAirHeatBalance(EnergyPlusData &state);
108 :
109 : void reportAirHeatBal1(EnergyPlusData &state,
110 : DataHeatBalance::AirReportVars &szAirRpt,
111 : DataZoneEquipment::EquipConfiguration const &szEquipConfig,
112 : int const zoneNum,
113 : int const spaceNum = 0);
114 :
115 : void reportAirHeatBal2(EnergyPlusData &state,
116 : DataHeatBalance::AirReportVars &szAirRpt,
117 : DataZoneEquipment::EquipConfiguration const &szEquipConfig,
118 : ZoneTempPredictorCorrector::ZoneSpaceHeatBalanceData const &szHeatBal,
119 : int const zoneNum,
120 : int const spaceNum = 0);
121 :
122 : void SetHeatToReturnAirFlag(EnergyPlusData &state);
123 :
124 : void UpdateZoneInletConvergenceLog(EnergyPlusData &state);
125 :
126 : void CheckAirLoopFlowBalance(EnergyPlusData &state);
127 :
128 : void ConvergenceErrors(EnergyPlusData &state,
129 : std::array<bool, 3> &HVACNotConverged,
130 : std::array<Real64, 10> &DemandToSupply,
131 : std::array<Real64, 10> &SupplyDeck1ToDemand,
132 : std::array<Real64, 10> &SupplyDeck2ToDemand,
133 : int AirSysNum,
134 : ConvErrorCallType index);
135 :
136 : } // namespace HVACManager
137 :
138 : struct HVACManagerData : BaseGlobalStruct
139 : {
140 :
141 : int HVACManageIteration = 0; // counts iterations to enforce maximum iteration limit
142 : int RepIterAir = 0;
143 : bool SimHVACIterSetup = false;
144 : bool TriggerGetAFN = true;
145 : bool MyOneTimeFlag = true;
146 : bool PrintedWarmup = false;
147 : bool MyEnvrnFlag = true;
148 : bool DebugNamesReported = false;
149 : bool MySetPointInit = true;
150 : bool MyEnvrnFlag2 = true;
151 : bool FlowMaxAvailAlreadyReset = false;
152 : bool FlowResolutionNeeded = false;
153 : int ErrCount = 0; // Number of times that the maximum iterations was exceeded
154 : int MaxErrCount = 0;
155 : std::string ErrEnvironmentName;
156 :
157 2126 : void init_constant_state([[maybe_unused]] EnergyPlusData &state) override
158 : {
159 2126 : }
160 :
161 1152 : void init_state([[maybe_unused]] EnergyPlusData &state) override
162 : {
163 1152 : }
164 :
165 2100 : void clear_state() override
166 : {
167 2100 : new (this) HVACManagerData();
168 2100 : }
169 : };
170 :
171 : } // namespace EnergyPlus
172 :
173 : #endif
|
