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 PlantComponentTemperatureSources_hh_INCLUDED
49 : #define PlantComponentTemperatureSources_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/DataPlant.hh>
59 : #include <EnergyPlus/Plant/PlantLocation.hh>
60 : #include <EnergyPlus/PlantComponent.hh>
61 :
62 : namespace EnergyPlus {
63 :
64 : // Forward declarations
65 : struct EnergyPlusData;
66 :
67 : namespace PlantComponentTemperatureSources {
68 :
69 : // MODULE PARAMETER DEFINITIONS:
70 : enum class TempSpecType
71 : {
72 : Invalid = -1,
73 : Constant,
74 : Schedule,
75 : Num
76 : };
77 :
78 : struct WaterSourceSpecs : PlantComponent
79 : {
80 : // Members
81 : std::string Name; // user identifier
82 : int InletNodeNum; // Node number on the inlet side of the plant
83 : int OutletNodeNum; // Node number on the outlet side of the plant
84 : Real64 DesVolFlowRate; // m**3/s - design nominal volumetric flow rate
85 : bool DesVolFlowRateWasAutoSized; // true if design flow rate was autosized on input
86 : Real64 MassFlowRateMax; // kg/s - design mass flow rate
87 : bool EMSOverrideOnMassFlowRateMax; // if true EMS is calling to override maximum mass flow
88 : Real64 EMSOverrideValueMassFlowRateMax; // value to use if EMS is overriding max mass flow
89 : Real64 MassFlowRate;
90 : TempSpecType tempSpecType; // temperature specification type
91 : Sched::Schedule *tempSpecSched = nullptr;
92 : Real64 BoundaryTemp;
93 : Real64 OutletTemp; // may be different if the flow is off
94 : Real64 InletTemp;
95 : Real64 HeatRate;
96 : Real64 HeatEnergy;
97 : PlantLocation plantLoc;
98 : Real64 SizFac; // sizing factor
99 : bool CheckEquipName;
100 : bool MyFlag;
101 : bool MyEnvironFlag;
102 : bool IsThisSized; // TRUE if sizing is done
103 :
104 : // Default Constructor
105 2 : WaterSourceSpecs()
106 4 : : InletNodeNum(0), OutletNodeNum(0), DesVolFlowRate(0.0), DesVolFlowRateWasAutoSized(false), MassFlowRateMax(0.0),
107 2 : EMSOverrideOnMassFlowRateMax(false), EMSOverrideValueMassFlowRateMax(0.0), MassFlowRate(0.0), tempSpecType(TempSpecType::Invalid),
108 4 : BoundaryTemp(0.0), OutletTemp(0.0), InletTemp(0.0), HeatRate(0.0), HeatEnergy(0.0), plantLoc{}, SizFac(0.0), CheckEquipName(true),
109 2 : MyFlag(true), MyEnvironFlag(true), IsThisSized(false)
110 : {
111 2 : }
112 :
113 : // Destructor
114 2 : ~WaterSourceSpecs() = default;
115 :
116 : void initialize(EnergyPlusData &state, Real64 &MyLoad);
117 :
118 : void setupOutputVars(EnergyPlusData &state);
119 :
120 : void autosize(EnergyPlusData &state);
121 :
122 : void calculate(EnergyPlusData &state);
123 :
124 : void update(EnergyPlusData &state);
125 :
126 : void
127 : simulate(EnergyPlusData &state, const PlantLocation &calledFromLocation, bool FirstHVACIteration, Real64 &CurLoad, bool RunFlag) override;
128 :
129 : void getDesignCapacities(EnergyPlusData &state,
130 : [[maybe_unused]] const PlantLocation &calledFromLocation,
131 : Real64 &MaxLoad,
132 : Real64 &MinLoad,
133 : Real64 &OptLoad) override;
134 :
135 : void getSizingFactor(Real64 &_SizFac) override;
136 :
137 : void onInitLoopEquip(EnergyPlusData &state, const PlantLocation &calledFromLocation) override;
138 :
139 : static PlantComponent *factory(EnergyPlusData &state, std::string const &objectName);
140 :
141 : void oneTimeInit(EnergyPlusData &state) override;
142 : };
143 :
144 : void GetWaterSourceInput(EnergyPlusData &state);
145 :
146 : } // namespace PlantComponentTemperatureSources
147 :
148 : struct PlantCompTempSrcData : BaseGlobalStruct
149 : {
150 :
151 : int NumSources = 0;
152 : bool getWaterSourceInput = true;
153 : EPVector<PlantComponentTemperatureSources::WaterSourceSpecs> WaterSource;
154 :
155 2126 : void init_constant_state([[maybe_unused]] EnergyPlusData &state) override
156 : {
157 2126 : }
158 :
159 1152 : void init_state([[maybe_unused]] EnergyPlusData &state) override
160 : {
161 1152 : }
162 :
163 2100 : void clear_state() override
164 : {
165 2100 : this->NumSources = 0;
166 2100 : this->getWaterSourceInput = true;
167 2100 : this->WaterSource.deallocate();
168 2100 : }
169 : };
170 :
171 : } // namespace EnergyPlus
172 :
173 : #endif
|
