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 PVWatts_hh_INCLUDED
49 : #define PVWatts_hh_INCLUDED
50 :
51 : // C++ Headers
52 : #include <map>
53 : #include <memory>
54 : #include <string>
55 :
56 : // ObjexxFCL Headers
57 :
58 : // EnergyPlus Headers
59 : #include <EnergyPlus/Data/BaseData.hh>
60 : #include <EnergyPlus/DataSurfaces.hh>
61 : #include <EnergyPlus/EnergyPlus.hh>
62 :
63 : // SAM Headers
64 : //#include <../third_party/ssc/shared/lib_irradproc.h>
65 : //#include <../third_party/ssc/shared/lib_pvwatts.h>
66 : //#include <../third_party/ssc/shared/lib_pvshade.h>
67 : //#include <../third_party/ssc/shared/lib_pv_incidence_modifier.h>
68 : #include <../third_party/ssc/ssc/sscapi.h>
69 :
70 : namespace EnergyPlus {
71 :
72 : // Forward declarations
73 : struct EnergyPlusData;
74 :
75 : namespace PVWatts {
76 :
77 : enum class ModuleType
78 : {
79 : Invalid = -1,
80 : STANDARD,
81 : PREMIUM,
82 : THIN_FILM,
83 : Num
84 : };
85 :
86 : enum class ArrayType
87 : {
88 : Invalid = -1,
89 : FIXED_OPEN_RACK,
90 : FIXED_ROOF_MOUNTED,
91 : ONE_AXIS,
92 : ONE_AXIS_BACKTRACKING,
93 : TWO_AXIS,
94 : Num
95 : };
96 :
97 : enum class GeometryType
98 : {
99 : Invalid = -1,
100 : TILT_AZIMUTH,
101 : SURFACE,
102 : Num
103 : };
104 :
105 : struct DCPowerOutput
106 : {
107 : Real64 poa; // Plane of array irradiance
108 : Real64 tpoa; // Transmitted plane of array irradiance
109 : Real64 pvt; // PV Cell temperature
110 : Real64 dc; // DC power output
111 : };
112 :
113 : struct IrradianceOutput
114 : {
115 : Real64 solazi;
116 : Real64 solzen;
117 : Real64 solalt;
118 : Real64 aoi;
119 : Real64 stilt;
120 : Real64 sazi;
121 : Real64 rot;
122 : Real64 btd;
123 : Real64 ibeam;
124 : Real64 iskydiff;
125 : Real64 ignddiff;
126 : int sunup;
127 : };
128 :
129 3 : class PVWattsGenerator
130 : {
131 : private:
132 : enum AlphaFields
133 : {
134 : NAME = 1,
135 : VERSION = 2,
136 : MODULE_TYPE = 3,
137 : ARRAY_TYPE = 4,
138 : GEOMETRY_TYPE = 5,
139 : SURFACE_NAME = 6,
140 : };
141 :
142 : enum NumFields
143 : {
144 : DC_SYSTEM_CAPACITY = 1,
145 : SYSTEM_LOSSES = 2,
146 : TILT_ANGLE = 3,
147 : AZIMUTH_ANGLE = 4,
148 : GROUND_COVERAGE_RATIO = 5,
149 : };
150 :
151 : // User inputs
152 : std::string name_;
153 : Real64 dcSystemCapacity_;
154 : ModuleType moduleType_;
155 : ArrayType arrayType_;
156 : Real64 systemLosses_;
157 : GeometryType geometryType_;
158 : Real64 tilt_;
159 : Real64 azimuth_;
160 : int surfaceNum_;
161 : Real64 groundCoverageRatio_;
162 : Real64 DCtoACRatio_;
163 : Real64 inverterEfficiency_;
164 :
165 : // Output variables
166 : Real64 outputDCPower_;
167 : Real64 outputDCEnergy_;
168 : Real64 outputACPower_;
169 : Real64 outputACEnergy_;
170 : Real64 cellTemperature_;
171 : Real64 planeOfArrayIrradiance_;
172 : Real64 shadedPercent_;
173 :
174 : ssc_module_t pvwattsModule_;
175 : ssc_data_t pvwattsData_;
176 : Real64 NumTimeStepsToday_;
177 :
178 : public:
179 : static std::unique_ptr<PVWattsGenerator> createFromIdfObj(EnergyPlusData &state, int objNum);
180 :
181 : PVWattsGenerator(EnergyPlusData &state,
182 : const std::string &name,
183 : const Real64 dcSystemCapacity,
184 : ModuleType moduleType,
185 : ArrayType arrayType,
186 : Real64 systemLosses = 0.14,
187 : GeometryType geometryType = GeometryType::TILT_AZIMUTH,
188 : Real64 tilt = 20.0,
189 : Real64 azimuth = 180.0,
190 : size_t surfaceNum = 0,
191 : Real64 groundCoverageRatio = 0.4);
192 :
193 : void setupOutputVariables(EnergyPlusData &state);
194 :
195 : Real64 getDCSystemCapacity();
196 : ModuleType getModuleType();
197 : ArrayType getArrayType();
198 : Real64 getSystemLosses();
199 : GeometryType getGeometryType();
200 : Real64 getTilt();
201 : Real64 getAzimuth();
202 : DataSurfaces::SurfaceData &getSurface(EnergyPlusData &state);
203 : Real64 getGroundCoverageRatio();
204 :
205 : Real64 getCellTemperature();
206 : Real64 getPlaneOfArrayIrradiance();
207 : void setCellTemperature(Real64 cellTemp);
208 : void setPlaneOfArrayIrradiance(Real64 poa);
209 :
210 : // Setters so we can store properties of the attached inverter.
211 : void setDCtoACRatio(Real64 dc2ac);
212 : void setInverterEfficiency(Real64 inverterEfficiency);
213 :
214 : void calc(EnergyPlusData &state);
215 : void getResults(Real64 &GeneratorPower, Real64 &GeneratorEnergy, Real64 &ThermalPower, Real64 &ThermalEnergy);
216 : };
217 :
218 : } // namespace PVWatts
219 :
220 : } // namespace EnergyPlus
221 :
222 : #endif
|
