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