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 PlantCondLoopOperation_hh_INCLUDED
49 : #define PlantCondLoopOperation_hh_INCLUDED
50 :
51 : // EnergyPlus Headers
52 : #include <EnergyPlus/Data/BaseData.hh>
53 : #include <EnergyPlus/EnergyPlus.hh>
54 : #include <EnergyPlus/Plant/DataPlant.hh>
55 :
56 : namespace EnergyPlus {
57 :
58 : namespace PlantCondLoopOperation {
59 :
60 : void ManagePlantLoadDistribution(EnergyPlusData &state,
61 : PlantLocation const &plantLoc, // PlantLoop data structure Location struct
62 : Real64 const LoopDemand,
63 : Real64 &RemLoopDemand,
64 : bool const FirstHVACIteration,
65 : bool &LoopShutDownFlag, // EMS flag to tell loop solver to shut down pumps
66 : bool &LoadDistributionWasPerformed);
67 :
68 : void GetPlantOperationInput(EnergyPlusData &state, bool &GetInputOK);
69 :
70 : void GetOperationSchemeInput(EnergyPlusData &state);
71 :
72 : void FindRangeBasedOrUncontrolledInput(EnergyPlusData &state,
73 : std::string &CurrentModuleObject, // for ease in renaming
74 : int const NumSchemes, // May be set here and passed on
75 : int const LoopNum, // May be set here and passed on
76 : int const SchemeNum, // May be set here and passed on
77 : bool &ErrorsFound // May be set here and passed on
78 : );
79 :
80 : void FindDeltaTempRangeInput(EnergyPlusData &state,
81 : DataLoopNode::ConnectionObjectType const CurrentModuleObject, // for ease in renaming
82 : int const NumSchemes, // May be set here and passed on
83 : int const LoopNum, // May be set here and passed on
84 : int const SchemeNum, // May be set here and passed on
85 : bool &ErrorsFound // May be set here and passed on
86 : );
87 :
88 : void LoadEquipList(EnergyPlusData &state,
89 : int const LoopNum, // May be set here and passed on
90 : int const SchemeNum, // May be set here and passed on
91 : int const ListNum, // May be set here and passed on
92 : bool &ErrorsFound // May be set here and passed on
93 : );
94 :
95 : void FindCompSPInput(EnergyPlusData &state,
96 : std::string &CurrentModuleObject, // for ease in renaming
97 : int const NumSchemes, // May be set here and passed on
98 : int const LoopNum, // May be set here and passed on
99 : int const SchemeNum, // May be set here and passed on
100 : bool &ErrorsFound // May be set here and passed on
101 : );
102 :
103 : void GetChillerHeaterChangeoverOpSchemeInput(EnergyPlusData &state,
104 : std::string &CurrentModuleObject, // for ease in renaming
105 : int const NumSchemes, // may be set here and passed on
106 : bool &ErrorsFound // may be set here and passed on
107 : );
108 :
109 : void GetUserDefinedOpSchemeInput(EnergyPlusData &state,
110 : std::string &CurrentModuleObject, // for ease in renaming
111 : int const NumSchemes, // May be set here and passed on
112 : int const LoopNum, // May be set here and passed on
113 : int const SchemeNum, // May be set here and passed on
114 : bool &ErrorsFound // May be set here and passed on
115 : );
116 :
117 : void InitLoadDistribution(EnergyPlusData &state, bool const FirstHVACIteration);
118 :
119 : void DistributePlantLoad(EnergyPlusData &state,
120 : int const LoopNum,
121 : const DataPlant::LoopSideLocation LoopSideNum,
122 : int const CurSchemePtr, // use as index in PlantLoop()OpScheme() data structure
123 : int const ListPtr, // use as index in PlantLoop()OpScheme() data structure
124 : Real64 const LoopDemand,
125 : Real64 &RemLoopDemand);
126 :
127 : void AdjustChangeInLoadForLastStageUpperRangeLimit(EnergyPlusData &state,
128 : int const LoopNum, // component topology
129 : int const CurOpSchemePtr, // current active operation scheme
130 : int const CurEquipListPtr, // current equipment list
131 : Real64 &ChangeInLoad // positive magnitude of load change
132 : );
133 :
134 : void AdjustChangeInLoadByHowServed(EnergyPlusData &state,
135 : PlantLocation const &plantLoc, // component topology
136 : Real64 &ChangeInLoad // positive magnitude of load change
137 : );
138 :
139 : void FindCompSPLoad(EnergyPlusData &state,
140 : PlantLocation const &plantLoc,
141 : int const OpNum // index for Plant()%LoopSide()%Branch()%Comp()%OpScheme()
142 : );
143 :
144 : void DistributeUserDefinedPlantLoad(EnergyPlusData &state,
145 : PlantLocation const &plantLoc,
146 : int const CurCompLevelOpNum, // index for Plant()%LoopSide()%Branch()%Comp()%OpScheme()
147 : int const CurSchemePtr,
148 : Real64 const LoopDemand,
149 : Real64 &RemLoopDemand);
150 :
151 : Real64 FindRangeVariable(EnergyPlusData &state,
152 : int const LoopNum, // PlantLoop data structure loop counter
153 : int const CurSchemePtr, // set by PL()%LoopSide()%Branch()%Comp()%OpScheme()%OpSchemePtr
154 : DataPlant::OpScheme CurSchemeType // identifier set in PlantData
155 : );
156 :
157 : void TurnOnPlantLoopPipes(EnergyPlusData &state, int const LoopNum, const DataPlant::LoopSideLocation LoopSideNum);
158 :
159 : void TurnOffLoopEquipment(EnergyPlusData &state, int const LoopNum);
160 :
161 : void TurnOffLoopSideEquipment(EnergyPlusData &state, int const LoopNum, const DataPlant::LoopSideLocation LoopSideNum);
162 :
163 : void SetupPlantEMSActuators(EnergyPlusData &state);
164 :
165 : void ActivateEMSControls(EnergyPlusData &state, PlantLocation const &plantLoc, bool &LoopShutDownFlag);
166 :
167 : void AdjustChangeInLoadByEMSControls(EnergyPlusData &state,
168 : PlantLocation const &plantLoc,
169 : Real64 &ChangeInLoad // positive magnitude of load change
170 : );
171 :
172 : } // namespace PlantCondLoopOperation
173 :
174 : struct PlantCondLoopOperationData : BaseGlobalStruct
175 : {
176 :
177 : bool GetPlantOpInput = true;
178 : bool InitLoadDistributionOneTimeFlag = true;
179 : bool LoadEquipListOneTimeFlag = true;
180 : int TotNumLists = 0;
181 : Array1D_string EquipListsNameList;
182 : Array1D<DataPlant::LoopType> EquipListsTypeList;
183 : Array1D_int EquipListsIndexList;
184 : bool lDummy = false; // for User-defined component load dispatch
185 : bool LoadSupervisoryChillerHeaterOpScheme = true;
186 : Array1D<DataPlant::ChillerHeaterSupervisoryOperationData> ChillerHeaterSupervisoryOperationSchemes;
187 :
188 2126 : void init_constant_state([[maybe_unused]] EnergyPlusData &state) override
189 : {
190 2126 : }
191 :
192 1152 : void init_state([[maybe_unused]] EnergyPlusData &state) override
193 : {
194 1152 : }
195 :
196 2100 : void clear_state() override
197 : {
198 2100 : this->GetPlantOpInput = true;
199 2100 : this->InitLoadDistributionOneTimeFlag = true;
200 2100 : this->LoadEquipListOneTimeFlag = true;
201 2100 : this->LoadSupervisoryChillerHeaterOpScheme = true;
202 2100 : this->ChillerHeaterSupervisoryOperationSchemes.clear();
203 2100 : this->TotNumLists = 0;
204 2100 : this->EquipListsNameList.clear();
205 2100 : this->EquipListsTypeList.clear();
206 2100 : this->EquipListsIndexList.clear();
207 2100 : this->lDummy = false;
208 2100 : }
209 : };
210 :
211 : } // namespace EnergyPlus
212 :
213 : #endif
|
