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 EMSManager_hh_INCLUDED
49 : #define EMSManager_hh_INCLUDED
50 :
51 : // ObjexxFCL Headers
52 : #include <ObjexxFCL/Optional.hh>
53 :
54 : // EnergyPlus Headers
55 : #include <EnergyPlus/Data/BaseData.hh>
56 : #include <EnergyPlus/DataGlobalConstants.hh>
57 : #include <EnergyPlus/EnergyPlus.hh>
58 : #include <EnergyPlus/OutputProcessor.hh>
59 :
60 : namespace EnergyPlus {
61 :
62 : // Forward declarations
63 : struct EnergyPlusData;
64 :
65 : // note there are routines that lie outside of the Module at the end of this file
66 :
67 : namespace EMSManager {
68 :
69 : enum class SPControlType
70 : {
71 : Invalid = -1,
72 : TemperatureSetPoint, // integer for node setpoint control type
73 : TemperatureMinSetPoint, // integer for node setpoint control type
74 : TemperatureMaxSetPoint, // integer for node setpoint control type
75 : HumidityRatioSetPoint, // integer for node setpoint control type
76 : HumidityRatioMinSetPoint, // integer for node setpoint control type
77 : HumidityRatioMaxSetPoint, // integer for node setpoint control type
78 : MassFlowRateSetPoint, // integer for node setpoint control type
79 : MassFlowRateMinSetPoint, // integer for node setpoint control type
80 : MassFlowRateMaxSetPoint, // integer for node setpoint control type
81 : Num
82 : };
83 :
84 : // Parameters for EMS Calling Points
85 : enum class EMSCallFrom
86 : {
87 : Invalid = -1,
88 : ZoneSizing,
89 : SystemSizing,
90 : BeginNewEnvironment,
91 : BeginNewEnvironmentAfterWarmUp,
92 : BeginTimestepBeforePredictor,
93 : BeforeHVACManagers,
94 : AfterHVACManagers,
95 : HVACIterationLoop,
96 : EndSystemTimestepBeforeHVACReporting,
97 : EndSystemTimestepAfterHVACReporting,
98 : EndZoneTimestepBeforeZoneReporting,
99 : EndZoneTimestepAfterZoneReporting,
100 : SetupSimulation,
101 : ExternalInterface,
102 : ComponentGetInput,
103 : UserDefinedComponentModel,
104 : UnitarySystemSizing,
105 : BeginZoneTimestepBeforeInitHeatBalance,
106 : BeginZoneTimestepAfterInitHeatBalance,
107 : BeginZoneTimestepBeforeSetCurrentWeather,
108 : Num
109 : };
110 :
111 : void CheckIfAnyEMS(EnergyPlusData &state);
112 :
113 : void ManageEMS(EnergyPlusData &state,
114 : EMSCallFrom iCalledFrom, // indicates where subroutine was called from, parameters in DataGlobals.
115 : bool &anyProgramRan, // true if any Erl programs ran for this call
116 : Optional_int_const ProgramManagerToRun = _ // specific program manager to run
117 : );
118 :
119 : void InitEMS(EnergyPlusData &state, EMSCallFrom iCalledFrom); // indicates where subroutine was called from, parameters in DataGlobals.
120 :
121 : void ReportEMS(EnergyPlusData &state);
122 :
123 : void GetEMSInput(EnergyPlusData &state);
124 :
125 : void ProcessEMSInput(EnergyPlusData &state, bool reportErrors); // . If true, then report out errors ,otherwise setup what we can
126 :
127 : void GetVariableTypeAndIndex(
128 : EnergyPlusData &state, std::string const &VarName, std::string const &VarKeyName, OutputProcessor::VariableType &VarType, int &VarIndex);
129 :
130 : void EchoOutActuatorKeyChoices(EnergyPlusData &state);
131 :
132 : void EchoOutInternalVariableChoices(EnergyPlusData &state);
133 :
134 : void SetupNodeSetPointsAsActuators(EnergyPlusData &state);
135 :
136 : void UpdateEMSTrendVariables(EnergyPlusData &state);
137 :
138 : bool CheckIfNodeSetPointManaged(EnergyPlusData &state,
139 : int NodeNum, // index of node being checked.
140 : SPControlType SetPointType,
141 : bool byHandle = false);
142 :
143 : bool CheckIfNodeSetPointManagedByEMS(EnergyPlusData &state,
144 : int NodeNum, // index of node being checked.
145 : SPControlType SetPointType,
146 : bool &ErrorFlag);
147 :
148 : bool CheckIfNodeMoreInfoSensedByEMS(EnergyPlusData &state,
149 : int nodeNum, // index of node being checked.
150 : std::string const &varName);
151 :
152 : void SetupPrimaryAirSystemAvailMgrAsActuators(EnergyPlusData &state);
153 :
154 : void SetupWindowShadingControlActuators(EnergyPlusData &state);
155 :
156 : void SetupThermostatActuators(EnergyPlusData &state);
157 :
158 : void SetupSurfaceConvectionActuators(EnergyPlusData &state);
159 :
160 : void SetupSurfaceConstructionActuators(EnergyPlusData &state);
161 :
162 : void SetupSurfaceOutdoorBoundaryConditionActuators(EnergyPlusData &state);
163 :
164 : void SetupZoneOutdoorBoundaryConditionActuators(EnergyPlusData &state);
165 :
166 : void SetupZoneInfoAsInternalDataAvail(EnergyPlusData &state);
167 :
168 : void checkForUnusedActuatorsAtEnd(EnergyPlusData &state);
169 :
170 : void checkSetpointNodesAtEnd(EnergyPlusData &state);
171 :
172 : } // namespace EMSManager
173 :
174 : // Moved these setup EMS actuator routines out of module to solve circular use problems between
175 : // ScheduleManager and OutputProcessor. Followed pattern used for SetupOutputVariable
176 :
177 : void SetupEMSActuator(EnergyPlusData &state,
178 : std::string_view cComponentTypeName,
179 : std::string_view cUniqueIDName,
180 : std::string_view cControlTypeName,
181 : std::string_view cUnits,
182 : bool &lEMSActuated,
183 : Real64 &rValue);
184 :
185 : void SetupEMSActuator(EnergyPlusData &state,
186 : std::string_view cComponentTypeName,
187 : std::string_view cUniqueIDName,
188 : std::string_view cControlTypeName,
189 : std::string_view cUnits,
190 : bool &lEMSActuated,
191 : int &iValue);
192 :
193 : void SetupEMSActuator(EnergyPlusData &state,
194 : std::string_view cComponentTypeName,
195 : std::string_view cUniqueIDName,
196 : std::string_view cControlTypeName,
197 : std::string_view cUnits,
198 : bool &lEMSActuated,
199 : bool &lValue);
200 :
201 : void SetupEMSInternalVariable(
202 : EnergyPlusData &state, std::string_view cDataTypeName, std::string_view cUniqueIDName, std::string_view cUnits, Real64 &rValue);
203 :
204 : void SetupEMSInternalVariable(
205 : EnergyPlusData &state, std::string_view cDataTypeName, std::string_view cUniqueIDName, std::string_view cUnits, int &iValue);
206 :
207 771 : struct EMSManagerData : BaseGlobalStruct
208 : {
209 :
210 : bool GetEMSUserInput = true; // Flag to prevent input from being read multiple times
211 : bool ZoneThermostatActuatorsHaveBeenSetup = false;
212 : bool FinishProcessingUserInput = true; // Flag to indicate still need to process input
213 : bool lDummy = false; // dummy pointer location
214 : bool lDummy2 = false; // dummy pointer location
215 :
216 0 : void clear_state() override
217 : {
218 0 : GetEMSUserInput = true;
219 0 : ZoneThermostatActuatorsHaveBeenSetup = false;
220 0 : FinishProcessingUserInput = true;
221 0 : this->lDummy = false;
222 0 : this->lDummy2 = false;
223 0 : }
224 : };
225 :
226 : } // namespace EnergyPlus
227 :
228 : #endif
|
