Line data Source code
1 : // EnergyPlus, Copyright (c) 1996-2024, 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 OutsideEnergySources_hh_INCLUDED
49 : #define OutsideEnergySources_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/PlantComponent.hh>
60 :
61 : namespace EnergyPlus {
62 :
63 : // Forward declarations
64 : struct EnergyPlusData;
65 :
66 : namespace OutsideEnergySources {
67 :
68 : struct OutsideEnergySourceSpecs : public PlantComponent
69 : {
70 :
71 : // Members
72 : std::string Name; // user identifier
73 : Real64 NomCap = 0.0; // design nominal capacity of district service
74 : bool NomCapWasAutoSized = false; // ture if Nominal Capacity was autosize on input
75 : int CapFractionSchedNum = 0; // capacity modifier schedule number
76 : int InletNodeNum = 0; // Node number on the inlet side of the plant
77 : int OutletNodeNum = 0; // Node number on the inlet side of the plant
78 : Real64 EnergyTransfer = 0.0; // cooling energy provided in time step
79 : Real64 EnergyRate = 0.0; // cooling power
80 : DataPlant::PlantEquipmentType EnergyType{DataPlant::PlantEquipmentType::Invalid}; // flag for district heating OR cooling
81 : // loop topology variables
82 : PlantLocation plantLoc{};
83 : // flags
84 : bool BeginEnvrnInitFlag = true;
85 : bool CheckEquipName = true;
86 : Real64 MassFlowRate = 0.0;
87 : Real64 InletTemp = 0.0;
88 : Real64 OutletTemp = 0.0;
89 : Real64 OutletSteamQuality = 0.0;
90 :
91 159 : OutsideEnergySourceSpecs() = default;
92 :
93 437 : virtual ~OutsideEnergySourceSpecs() = default;
94 :
95 : static PlantComponent *factory(EnergyPlusData &state, DataPlant::PlantEquipmentType objectType, std::string_view objectName);
96 :
97 : void simulate([[maybe_unused]] EnergyPlusData &state,
98 : const PlantLocation &calledFromLocation,
99 : bool FirstHVACIteration,
100 : Real64 &CurLoad,
101 : bool RunFlag) override;
102 :
103 : void onInitLoopEquip([[maybe_unused]] EnergyPlusData &state, const PlantLocation &calledFromLocation) override;
104 :
105 : void getDesignCapacities(
106 : EnergyPlusData &state, const PlantLocation &calledFromLocation, Real64 &MaxLoad, Real64 &MinLoad, Real64 &OptLoad) override;
107 :
108 : void initialize(EnergyPlusData &state, Real64 curLoad);
109 :
110 : void calculate(EnergyPlusData &state, bool runFlag, Real64 curLoad);
111 :
112 : void size(EnergyPlusData &state);
113 :
114 : void oneTimeInit(EnergyPlusData &state) override;
115 :
116 : void oneTimeInit_new(EnergyPlusData &state) override;
117 : };
118 :
119 : void GetOutsideEnergySourcesInput(EnergyPlusData &state);
120 :
121 : void InitSimVars(int EnergySourceNum, Real64 MyLoad);
122 :
123 : } // namespace OutsideEnergySources
124 :
125 : struct OutsideEnergySourcesData : BaseGlobalStruct
126 : {
127 :
128 : int NumDistrictUnits = 0;
129 : bool SimOutsideEnergyGetInputFlag = true;
130 : Array1D<OutsideEnergySources::OutsideEnergySourceSpecs> EnergySource;
131 : std::unordered_map<std::string, std::string> EnergySourceUniqueNames;
132 :
133 796 : void init_state([[maybe_unused]] EnergyPlusData &state) override
134 : {
135 796 : }
136 :
137 0 : void clear_state() override
138 : {
139 0 : this->NumDistrictUnits = 0;
140 0 : this->SimOutsideEnergyGetInputFlag = true;
141 0 : this->EnergySource.deallocate();
142 0 : this->EnergySourceUniqueNames.clear();
143 0 : }
144 : };
145 :
146 : } // namespace EnergyPlus
147 :
148 : #endif
|
