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 PlantLoadProfile_hh_INCLUDED
49 : #define PlantLoadProfile_hh_INCLUDED
50 :
51 : // ObjexxFCL Headers
52 : #include <ObjexxFCL/Array1D.hh>
53 :
54 : // EnergyPlus Headers
55 : #include <EnergyPlus/Data/BaseData.hh>
56 : #include <EnergyPlus/DataGlobals.hh>
57 : #include <EnergyPlus/EnergyPlus.hh>
58 : #include <EnergyPlus/Plant/Enums.hh>
59 : #include <EnergyPlus/PlantComponent.hh>
60 :
61 : namespace EnergyPlus {
62 :
63 : // Forward declarations
64 : struct EnergyPlusData;
65 :
66 : namespace PlantLoadProfile {
67 :
68 : enum class PlantLoopFluidType
69 : {
70 : Invalid = -1,
71 : Water,
72 : Steam,
73 : Num
74 : };
75 :
76 : struct PlantProfileData : public PlantComponent
77 : {
78 21 : virtual ~PlantProfileData() = default;
79 :
80 : // Members
81 : std::string Name; // Name of Plant Load Profile object
82 : DataPlant::PlantEquipmentType Type; // Plant Side Connection: 'Type' assigned in DataPlant
83 : PlantLocation plantLoc; // plant loop component location object
84 : PlantLoopFluidType FluidType = PlantLoopFluidType::Invalid; // plant loop fluid type: water or steam
85 : bool Init; // Flag for initialization: TRUE means do the init
86 : bool InitSizing; // Flag for initialization of plant sizing
87 : int InletNode;
88 : Real64 InletTemp; // Inlet temperature (C)
89 : int OutletNode;
90 : Real64 OutletTemp; // Outlet temperature (C)
91 : Sched::Schedule *loadSched = nullptr; // load schedule
92 : bool EMSOverridePower; // if true, then EMS is calling to override power level
93 : Real64 EMSPowerValue; // value EMS is directing to use for power [W]
94 : Real64 PeakVolFlowRate; // Peak volumetric flow rate, also water consumption rate (m3/s)
95 : Sched::Schedule *flowRateFracSched = nullptr; // flow rate fraction schedule
96 : Real64 VolFlowRate; // Volumetric flow rate (m3/s)
97 : Real64 MassFlowRate; // Mass flow rate (kg/s)
98 : Real64 DegOfSubcooling = 0.0; // Degree of subcooling in steam outlet
99 : Real64 LoopSubcoolReturn = 0.0; // Loop subcooling for steam return
100 : bool EMSOverrideMassFlow;
101 : Real64 EMSMassFlowValue;
102 : // Report variables
103 : Real64 Power; // Power required to meet the load (W)
104 : Real64 Energy; // Energy required to meet the load (J)
105 : Real64 HeatingEnergy; // Heating Energy required to meet the load (J)
106 : Real64 CoolingEnergy; // Cooling Energy required to meet the load (J)
107 :
108 : // Default Constructor
109 21 : PlantProfileData()
110 21 : : Type(DataPlant::PlantEquipmentType::Invalid), plantLoc{}, Init(true), InitSizing(true), InletNode(0), InletTemp(0.0), OutletNode(0),
111 21 : OutletTemp(0.0), EMSOverridePower(false), EMSPowerValue(0.0), PeakVolFlowRate(0.0), VolFlowRate(0.0), MassFlowRate(0.0),
112 21 : EMSOverrideMassFlow(false), EMSMassFlowValue(0.0), Power(0.0), Energy(0.0), HeatingEnergy(0.0), CoolingEnergy(0.0)
113 : {
114 21 : }
115 :
116 : // Functions
117 : static PlantComponent *factory(EnergyPlusData &state, std::string const &objectName);
118 :
119 : void simulate([[maybe_unused]] EnergyPlusData &state,
120 : const PlantLocation &calledFromLocation,
121 : bool FirstHVACIteration,
122 : Real64 &CurLoad,
123 : bool RunFlag) override;
124 :
125 : void onInitLoopEquip([[maybe_unused]] EnergyPlusData &state, const PlantLocation &calledFromLocation) override;
126 :
127 : void InitPlantProfile(EnergyPlusData &state);
128 :
129 : void UpdatePlantProfile(EnergyPlusData &state) const;
130 :
131 : void ReportPlantProfile(EnergyPlusData &state);
132 :
133 : void oneTimeInit(EnergyPlusData &state) override;
134 :
135 : void oneTimeInit_new(EnergyPlusData &state) override;
136 :
137 : void getCurrentPower(EnergyPlusData &state, Real64 &power) override;
138 : };
139 :
140 : // This could be static inside the class
141 : void GetPlantProfileInput(EnergyPlusData &state);
142 :
143 : } // namespace PlantLoadProfile
144 :
145 : struct PlantLoadProfileData : BaseGlobalStruct
146 : {
147 :
148 : bool GetPlantLoadProfileInputFlag = true;
149 : int NumOfPlantProfile = 0;
150 : Array1D<PlantLoadProfile::PlantProfileData> PlantProfile;
151 :
152 2126 : void init_constant_state([[maybe_unused]] EnergyPlusData &state) override
153 : {
154 2126 : }
155 :
156 1152 : void init_state([[maybe_unused]] EnergyPlusData &state) override
157 : {
158 1152 : }
159 :
160 2100 : void clear_state() override
161 : {
162 2100 : this->GetPlantLoadProfileInputFlag = true;
163 2100 : this->NumOfPlantProfile = 0;
164 2100 : this->PlantProfile.deallocate();
165 2100 : }
166 : };
167 :
168 : } // namespace EnergyPlus
169 :
170 : #endif
|
