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 DataHVACControllers_hh_INCLUDED
49 : #define DataHVACControllers_hh_INCLUDED
50 :
51 : // ObjexxFCL Headers
52 : #include <EnergyPlus/Data/BaseData.hh>
53 : #include <ObjexxFCL/Array1D.hh>
54 :
55 : // EnergyPlus Headers
56 : #include <EnergyPlus/Data/BaseData.hh>
57 : #include <EnergyPlus/EnergyPlus.hh>
58 :
59 : namespace EnergyPlus {
60 :
61 : namespace DataHVACControllers {
62 :
63 : int constexpr ControllerSimple_Type(1);
64 :
65 : enum class ControllerAction // Controller action used in modules HVACControllers and ZoneControllers
66 : {
67 : Invalid = -1,
68 : NoAction,
69 : Reverse,
70 : NormalAction,
71 : Num
72 : };
73 :
74 : enum class ControllerMode // Controller mode used in modules HVACControllers and ZoneControllers
75 : {
76 : Invalid = -1, // Controller error. E.g., bad action
77 : None, // Controller mode not yet determined
78 : Off, // Controller off (no air flow in loop)
79 : Inactive, // Controller inactive (equip not available for current step)
80 : Active, // Controller active (schedule>0 and min<actuated<max)
81 : MinActive, // Controller active and min-constrained (equip available and actuated=min)
82 : MaxActive, // Controller active and max-constrained (equip available and actuated=max)
83 : Num
84 : };
85 :
86 : int constexpr iFirstMode(static_cast<int>(ControllerMode::Invalid)); // First operating mode in range
87 : int constexpr iLastMode(static_cast<int>(ControllerMode::MaxActive)); // Last operating mode in range
88 :
89 : enum class ControllerOperation // Controller operation used in module HVACControllers
90 : {
91 : Invalid = -1,
92 : ColdStart, // Reset for cold start
93 : WarmRestart, // Reset for warm restart with previous solution
94 : Iterate, // Check convergence and estimate next guess if needed
95 : End, // Check convergence only and trace
96 : Num
97 : };
98 :
99 : enum class ControllerWarmRestart // Controller restart flag used in module HVACControllers
100 : {
101 : Invalid = -1,
102 : None, // Indicates that warm restart was not attempted
103 : Fail, // Indicates that warm restart failed
104 : Success, // Indicates that warm restart was successful
105 : Num
106 : };
107 :
108 : } // namespace DataHVACControllers
109 :
110 : struct HVACCtrlData : BaseGlobalStruct
111 : {
112 : Array1D_string const ControllerTypes = Array1D_string(1, std::string("Controller:WaterCoil"));
113 : static constexpr std::array<std::string_view, 5> ActionTypes = {"No action", "Reverse action", "Normal action"};
114 : Array1D_string const ControllerModeTypes = Array1D_string({-1, 5},
115 : {"Wrong action mode",
116 : "No controller mode",
117 : "Off controller mode",
118 : "Inactive controller mode",
119 : "Active unconstrained controller mode",
120 : "Active min-constrained controller mode",
121 : "Active max-constrained controller mode"});
122 :
123 2126 : void init_constant_state([[maybe_unused]] EnergyPlusData &state) override
124 : {
125 2126 : }
126 :
127 1152 : void init_state([[maybe_unused]] EnergyPlusData &state) override
128 : {
129 1152 : }
130 :
131 2100 : void clear_state() override
132 : {
133 : // nothing to clear, it's all constant
134 2100 : }
135 : };
136 :
137 : } // namespace EnergyPlus
138 :
139 : #endif
|
