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 ExteriorEnergyUse_hh_INCLUDED
49 : #define ExteriorEnergyUse_hh_INCLUDED
50 :
51 : #include <unordered_map>
52 :
53 : // ObjexxFCL Headers
54 : #include <ObjexxFCL/Array1D.hh>
55 :
56 : // EnergyPlus Headers
57 : #include <EnergyPlus/Data/BaseData.hh>
58 : #include <EnergyPlus/DataGlobalConstants.hh>
59 : #include <EnergyPlus/DataGlobals.hh>
60 : #include <EnergyPlus/EnergyPlus.hh>
61 :
62 : namespace EnergyPlus {
63 :
64 : // Forward declarations
65 : struct EnergyPlusData;
66 :
67 : namespace ExteriorEnergyUse {
68 :
69 : enum class LightControlType
70 : {
71 : Invalid = -1,
72 : ScheduleOnly = 1, // exterior lights only on schedule
73 : AstroClockOverride = 2, // exterior lights controlled to turn off during day.
74 : Num
75 : };
76 :
77 : struct ExteriorLightUsage
78 : {
79 : // Members
80 : std::string Name; // Descriptive name -- will show on reporting
81 : int SchedPtr; // Can be scheduled
82 : Real64 DesignLevel; // Consumption in Watts
83 : Real64 Power; // Power = DesignLevel * ScheduleValue
84 : Real64 CurrentUse; // Use for this time step
85 : LightControlType ControlMode; // Control mode Schedule Only or Astronomical Clock plus schedule
86 : bool ManageDemand; // Flag to indicate whether to use demand limiting
87 : Real64 DemandLimit; // Demand limit set by demand manager [W]
88 : bool PowerActuatorOn; // EMS flag
89 : Real64 PowerActuatorValue; // EMS value
90 : Real64 SumConsumption; // sum of electric consumption [J] for reporting
91 : Real64 SumTimeNotZeroCons; // sum of time of positive electric consumption [hr]
92 :
93 : // Default Constructor
94 795 : ExteriorLightUsage()
95 1590 : : SchedPtr(0), DesignLevel(0.0), Power(0.0), CurrentUse(0.0), ControlMode(LightControlType::ScheduleOnly), ManageDemand(false),
96 795 : DemandLimit(0.0), PowerActuatorOn(false), PowerActuatorValue(0.0), SumConsumption(0.0), SumTimeNotZeroCons(0.0)
97 : {
98 795 : }
99 : };
100 :
101 : struct ExteriorEquipmentUsage
102 : {
103 : // Members
104 : std::string Name; // Descriptive name -- will show on reporting
105 : Constant::eFuel FuelType;
106 : int SchedPtr; // Can be scheduled
107 : Real64 DesignLevel; // Design Consumption (Watts, except for Water Equipment)
108 : Real64 Power; // Power = DesignLevel * ScheduleValue
109 : Real64 CurrentUse; // Use for this time step
110 : bool ManageDemand; // Flag to indicate whether to use demand limiting
111 : Real64 DemandLimit; // Demand limit set by demand manager [W]
112 :
113 : // Default Constructor
114 795 : ExteriorEquipmentUsage()
115 795 : : FuelType(Constant::eFuel::Invalid), SchedPtr(0), DesignLevel(0.0), Power(0.0), CurrentUse(0.0), ManageDemand(false), DemandLimit(0.0)
116 : {
117 795 : }
118 : };
119 :
120 : void ManageExteriorEnergyUse(EnergyPlusData &state);
121 :
122 : void GetExteriorEnergyUseInput(EnergyPlusData &state);
123 :
124 : void ReportExteriorEnergyUse(EnergyPlusData &state);
125 :
126 : } // namespace ExteriorEnergyUse
127 :
128 : struct ExteriorEnergyUseData : BaseGlobalStruct
129 : {
130 :
131 : int NumExteriorLights = 0; // Number of Exterior Light Inputs
132 : int NumExteriorEqs = 0; // Number of Exterior Equipment Inputs
133 : Array1D<ExteriorEnergyUse::ExteriorLightUsage> ExteriorLights; // Structure for Exterior Light reporting
134 : Array1D<ExteriorEnergyUse::ExteriorEquipmentUsage> ExteriorEquipment; // Structure for Exterior Equipment Reporting
135 : std::unordered_map<std::string, std::string> UniqueExteriorEquipNames;
136 : bool GetExteriorEnergyInputFlag = true; // First time, input is "gotten"
137 : Real64 sumDesignLevel = 0.0; // for predefined report of design level total
138 :
139 796 : void init_state([[maybe_unused]] EnergyPlusData &state) override
140 : {
141 796 : }
142 :
143 0 : void clear_state() override
144 : {
145 0 : this->NumExteriorLights = 0;
146 0 : this->NumExteriorEqs = 0;
147 0 : this->ExteriorLights.deallocate();
148 0 : this->ExteriorEquipment.deallocate();
149 0 : this->UniqueExteriorEquipNames.clear();
150 0 : this->GetExteriorEnergyInputFlag = true;
151 0 : this->sumDesignLevel = 0.0;
152 0 : }
153 : };
154 :
155 : } // namespace EnergyPlus
156 :
157 : #endif
|
