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 PlantOperationEquipAndOperations_hh_INCLUDED
49 : #define PlantOperationEquipAndOperations_hh_INCLUDED
50 :
51 : #include <ObjexxFCL/Array1D.hh>
52 :
53 : #include <EnergyPlus/Plant/Enums.hh>
54 : #include <EnergyPlus/PlantComponent.hh>
55 :
56 : namespace EnergyPlus::DataPlant {
57 :
58 : struct EquipListPtrData
59 : {
60 : // Members
61 : int ListPtr; // points to List on OpScheme on plant loop:
62 : int CompPtr; // points to this component on List on OpScheme on plant loop:
63 :
64 : // Default Constructor
65 1601 : EquipListPtrData() : ListPtr(0), CompPtr(0)
66 : {
67 1601 : }
68 : };
69 :
70 52013 : struct OpSchemePtrData
71 : {
72 : // Members
73 : int OpSchemePtr; // points to OpScheme on plant loop:
74 : int NumEquipLists; // ALLOCATABLE to the schedule (for valid schedules)
75 : Array1D<EquipListPtrData> EquipList; // Component list
76 :
77 : // Default Constructor
78 1511 : OpSchemePtrData() : OpSchemePtr(0), NumEquipLists(0)
79 : {
80 1511 : }
81 : };
82 :
83 4584 : struct EquipListCompData
84 : {
85 : // Members
86 : std::string Name; // The name of each item in the list
87 : std::string TypeOf; // The name of each item in the list
88 : DataPlant::CtrlType CtrlType; // CoolingOp, HeatingOp, DualOp
89 : int LoopNumPtr; // pointer to the comp location in the data structure
90 : DataPlant::LoopSideLocation LoopSideNumPtr; // pointer to the comp location in the data structure
91 : int BranchNumPtr; // pointer to the comp location in the data structure
92 : int CompNumPtr; // pointer to the comp location in the data structure
93 : Real64 SetPointFlowRate; // COMP SETPOINT CTRL ONLY--load calculation comp flow rate
94 : std::string DemandNodeName; // COMP SETPOINT CTRL ONLY--The name of each item in the list
95 : int DemandNodeNum; // COMP SETPOINT CTRL ONLY--The 'keyWord' identifying each item in list
96 : std::string SetPointNodeName; // COMP SETPOINT CTRL ONLY--The name of each item in the list
97 : int SetPointNodeNum; // COMP SETPOINT CTRL ONLY--The 'keyWord' identifying each item in list
98 : Real64 EMSIntVarRemainingLoadValue; // EMS internal variable remaining load, neg cooling [W]
99 : Real64 EMSActuatorDispatchedLoadValue; // EMS actuator for dispatched load, neg= cooling [W]
100 :
101 : // Default Constructor
102 1382 : EquipListCompData()
103 1382 : : CtrlType(DataPlant::CtrlType::Invalid), LoopNumPtr(0), LoopSideNumPtr(DataPlant::LoopSideLocation::Invalid), BranchNumPtr(0), CompNumPtr(0),
104 1382 : SetPointFlowRate(0.0), DemandNodeNum(0), SetPointNodeNum(0), EMSIntVarRemainingLoadValue(0.0), EMSActuatorDispatchedLoadValue(0.0)
105 : {
106 1382 : }
107 : };
108 :
109 4000 : struct EquipOpList
110 : {
111 : // Members
112 : std::string Name; // The name of each item in the list
113 : Real64 RangeUpperLimit; // for range based controls
114 : Real64 RangeLowerLimit; // for range based controls
115 : int NumComps; // ALLOCATABLE to the schedule (for valid schedules)
116 : Array1D<EquipListCompData> Comp; // Component type list
117 :
118 : // Default Constructor
119 1228 : EquipOpList() : RangeUpperLimit(0.0), RangeLowerLimit(0.0), NumComps(0)
120 : {
121 1228 : }
122 : };
123 :
124 3563 : struct OperationData
125 : {
126 : // Members
127 : std::string Name; // The name of each item in the list
128 : std::string TypeOf; // The 'keyWord' identifying each item in the list
129 : DataPlant::OpScheme Type; // Op scheme type (from keyword)
130 : std::string Sched; // The name of the schedule associated with the list
131 : int SchedPtr; // ALLOCATABLE to the schedule (for valid schedules)
132 : bool Available; // TRUE = designated component or operation scheme available
133 : int NumEquipLists; // number of equipment lists
134 : int CurListPtr; // points to the current equipment list
135 : Array1D<EquipOpList> EquipList; // Component type list
136 : int EquipListNumForLastStage; // points to the equipment list with the highest upper limit
137 : std::string ReferenceNodeName; // DELTA CTRL ONLY--for calculation of delta Temp
138 : int ReferenceNodeNumber; // DELTA CTRL ONLY--for calculation of delta Temp
139 : int ErlSimProgramMngr; // EMS:ProgramManager to always run when this model is called
140 : int ErlInitProgramMngr; // EMS:ProgramManager to run when this model is initialized and setup
141 : int initPluginLocation; // If Python Plugins are used to init this, this defines the location in the plugin structure
142 : int simPluginLocation; // If Python Plugins are used to simulate this, this defines the location in the plugin structure
143 : Real64 EMSIntVarLoopDemandRate; // EMS internal variable for loop-level demand rate, neg cooling [W]
144 : bool MyEnvrnFlag;
145 :
146 : // Default Constructor
147 1107 : OperationData()
148 1107 : : Type(DataPlant::OpScheme::Invalid), SchedPtr(0), Available(false), NumEquipLists(0), CurListPtr(0), EquipListNumForLastStage(0),
149 : ReferenceNodeNumber(0), ErlSimProgramMngr(0), ErlInitProgramMngr(0), initPluginLocation(-1), simPluginLocation(-1),
150 1107 : EMSIntVarLoopDemandRate(0.0), MyEnvrnFlag(true)
151 : {
152 1107 : }
153 : };
154 : } // namespace EnergyPlus::DataPlant
155 :
156 : #endif
|
