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 BoilerSteam_hh_INCLUDED
49 : #define BoilerSteam_hh_INCLUDED
50 :
51 : // ObjexxFCL Headers
52 : #include <ObjexxFCL/Array1D.hh>
53 :
54 : // EnergyPlus Headers
55 : #include <EnergyPlus/Data/BaseData.hh>
56 : #include <EnergyPlus/DataBranchAirLoopPlant.hh>
57 : #include <EnergyPlus/DataGlobalConstants.hh>
58 : #include <EnergyPlus/DataGlobals.hh>
59 : #include <EnergyPlus/EnergyPlus.hh>
60 : #include <EnergyPlus/FluidProperties.hh>
61 : #include <EnergyPlus/Plant/Enums.hh>
62 : #include <EnergyPlus/Plant/PlantLocation.hh>
63 : #include <EnergyPlus/PlantComponent.hh>
64 : #include <EnergyPlus/UtilityRoutines.hh>
65 :
66 : namespace EnergyPlus {
67 :
68 : // Forward declarations
69 : struct EnergyPlusData;
70 :
71 : namespace BoilerSteam {
72 :
73 : struct BoilerSpecs : PlantComponent
74 : {
75 : // Members
76 : std::string Name; // user identifier
77 : Constant::eFuel FuelType = Constant::eFuel::Invalid; // resource type
78 : bool Available = false; // TRUE if machine available in current time step
79 : bool ON = false; // TRUE: simulate the machine at it's operating part load ratio
80 : bool MissingSetPointErrDone = false; // Missing outlet node setpoint message flag
81 : bool UseLoopSetPoint = false; // Flag to use setpoint from loop
82 : Real64 DesMassFlowRate = 0.0; // kg/s - Boiler water design mass flow rate
83 : Real64 MassFlowRate = 0.0; // kg/s - Boiler water mass flow rate
84 : Real64 NomCap = 0.0; // W - design nominal capacity of Boiler
85 : bool NomCapWasAutoSized = false; // true if Nominal capacity was autosize on input
86 : Real64 NomEffic = 0.0; // boiler efficiency at design conditions
87 : Real64 MinPartLoadRat = 0.0; // Minimum allowed operating part load ratio
88 : Real64 MaxPartLoadRat = 0.0; // Maximum allowed operating part load ratio
89 : Real64 OptPartLoadRat = 0.0; // Optimal operating part load ratio
90 : Real64 OperPartLoadRat = 0.0; // Actual operating part load ratio
91 : Real64 TempUpLimitBoilerOut = 0.0; // C - Boiler outlet maximum temperature limit
92 : Real64 BoilerMaxOperPress = 0.0; // Max Boiler Pressure
93 : Real64 BoilerPressCheck = 0.0; // Boiler Operating Pressure at Saturation Temperature
94 : Real64 SizFac = 0.0; // sizing factor
95 : int BoilerInletNodeNum = 0; // Node number at the boiler inlet
96 : int BoilerOutletNodeNum = 0; // Node number at the boiler outlet
97 : std::array<Real64, 3> FullLoadCoef = {0.0}; // Coefficients of the fuel consumption/part load ratio curve
98 : int TypeNum = 0; // Plant loop type identifier
99 : PlantLocation plantLoc;
100 : int PressErrIndex = 0; // index pointer for recurring errors
101 : Fluid::RefrigProps *fluid = nullptr; // Steam fluid properties
102 : std::string EndUseSubcategory; // identifier use for the end use subcategory
103 : bool myFlag = true;
104 : bool myEnvrnFlag = true;
105 :
106 : Real64 FuelUsed = 0.0; // W - Boiler fuel used
107 : Real64 BoilerLoad = 0.0; // W - Boiler Load
108 : Real64 BoilerEff = 0.0; // Boiler efficiency
109 : Real64 BoilerMassFlowRate = 0.0; // kg/s - Boiler mass flow rate
110 : Real64 BoilerOutletTemp = 0.0; // W - Boiler outlet temperature
111 :
112 : Real64 BoilerEnergy = 0.0; // J - Boiler energy integrated over time
113 : Real64 FuelConsumed = 0.0; // J - Boiler Fuel consumed integrated over time
114 : Real64 BoilerInletTemp = 0.0; // C - Boiler inlet temperature
115 :
116 : void initialize(EnergyPlusData &state);
117 :
118 : void setupOutputVars(EnergyPlusData &state);
119 :
120 : void autosize(EnergyPlusData &state);
121 :
122 : void calculate(EnergyPlusData &state,
123 : Real64 &MyLoad, // W - hot water demand to be met by boiler
124 : bool RunFlag, // TRUE if boiler operating
125 : DataBranchAirLoopPlant::ControlType EquipFlowCtrl // Flow control mode for the equipment
126 : );
127 :
128 : void update(EnergyPlusData &state,
129 : Real64 MyLoad, // boiler operating load
130 : bool RunFlag, // boiler on when TRUE
131 : bool FirstHVACIteration // TRUE if First iteration of simulation
132 : );
133 :
134 : void simulate([[maybe_unused]] EnergyPlusData &state,
135 : const PlantLocation &calledFromLocation,
136 : bool FirstHVACIteration,
137 : Real64 &CurLoad,
138 : bool RunFlag) override;
139 :
140 : void getDesignCapacities(EnergyPlusData &state,
141 : [[maybe_unused]] const PlantLocation &calledFromLocation,
142 : Real64 &MaxLoad,
143 : Real64 &MinLoad,
144 : Real64 &OptLoad) override;
145 :
146 : void getSizingFactor(Real64 &sizFac) override;
147 :
148 : void oneTimeInit(EnergyPlusData &state) override;
149 :
150 : void initEachEnvironment(EnergyPlusData &state);
151 :
152 : void onInitLoopEquip([[maybe_unused]] EnergyPlusData &state, [[maybe_unused]] const PlantLocation &calledFromLocation) override;
153 :
154 : static BoilerSpecs *factory(EnergyPlusData &state, std::string const &objectName);
155 : };
156 :
157 : void GetBoilerInput(EnergyPlusData &state);
158 :
159 : } // namespace BoilerSteam
160 :
161 : struct BoilerSteamData : BaseGlobalStruct
162 : {
163 : bool getSteamBoilerInput = true;
164 : Array1D<BoilerSteam::BoilerSpecs> Boiler;
165 :
166 2126 : void init_constant_state([[maybe_unused]] EnergyPlusData &state) override
167 : {
168 2126 : }
169 :
170 1152 : void init_state([[maybe_unused]] EnergyPlusData &state) override
171 : {
172 1152 : }
173 :
174 2100 : void clear_state() override
175 : {
176 2100 : new (this) BoilerSteamData();
177 2100 : }
178 : };
179 :
180 : } // namespace EnergyPlus
181 :
182 : #endif
|
