GCC Code Coverage Report


Directory: ./
Coverage: low: ≥ 0% medium: ≥ 75.0% high: ≥ 90.0%
Coverage Exec / Excl / Total
Lines: 45.5% 20 / 1 / 45
Functions: 41.5% 17 / 1 / 42
Branches: 48.5% 66 / 1 / 137

src/utilities/filetypes/EpwFile.hpp
Line Branch Exec Source
1 /***********************************************************************************************************************
2 * OpenStudio(R), Copyright (c) Alliance for Energy Innovation, LLC.
3 * See also https://openstudio.net/license
4 ***********************************************************************************************************************/
5
6 #ifndef UTILITIES_FILETYPES_EPWFILE_HPP
7 #define UTILITIES_FILETYPES_EPWFILE_HPP
8
9 #include "../UtilitiesAPI.hpp"
10
11 #include "../core/Path.hpp"
12 #include "../core/Enum.hpp"
13 #include "../core/Logger.hpp"
14 #include "../time/Time.hpp"
15 #include "../time/Date.hpp"
16 #include "../time/DateTime.hpp"
17 #include "../data/TimeSeries.hpp"
18
19 #include <span>
20
21 namespace openstudio {
22
23 // forward declaration
24 class IdfObject;
25 // Added these next four for SWIG
26 class Date;
27 class Time;
28 class DateTime;
29 class TimeSeries;
30
31 /** The AirState object represents a moist air state */
32 class UTILITIES_API AirState
33 {
34 public:
35 /** Create a air state object at 25C, 101325 Pa, 50% RH */
36 AirState();
37
38 // Statics
39 /** Attempt to create a moist air state for dry bulb temperature, dew point temperature, and pressure */
40 static boost::optional<AirState> fromDryBulbDewPointPressure(double drybulb, double dewpoint, double pressure);
41 /** Attempt to create a moist air state for dry bulb temperature, relative, and pressure */
42 static boost::optional<AirState> fromDryBulbRelativeHumidityPressure(double drybulb, double RH, double pressure);
43
44 /** Returns the dry bulb temperature in C*/
45 double drybulb() const;
46 /** Returns the dew point temperature in C*/
47 double dewpoint() const;
48 /** Returns the wet bulb temperature in C*/
49 double wetbulb() const;
50 /** Returns the relative humidity in percent*/
51 double relativeHumidity() const;
52 /** Returns the pressure in Pa*/
53 double pressure() const;
54
55 /** Returns the enthalpy kJ/kg*/
56 double enthalpy() const;
57 /** Returns the saturation pressure in Pa*/
58 double saturationPressure() const;
59 /** Returns the density in kg/m3*/
60 double density() const;
61 /** Returns the specific volume m3/kg*/
62 double specificVolume() const;
63 /** Returns the humidity ratio */
64 double humidityRatio() const;
65
66 /** Returns the air gas constant */
67 static double R();
68
69 private:
70 double m_drybulb; // Dry bulb temperature in C
71 double m_dewpoint; // Dew point temperature in C
72 double m_pressure; // Atmospheric pressure in Pa
73 double m_wetbulb; // Thermodynamic wet bulb temperature in C
74
75 // These are always computed
76 double m_psat;
77 double m_W;
78 double m_h;
79 double m_phi;
80 double m_v;
81 };
82
83 // clang-format off
84
85
14/22
openstudio::EpwDataField::buildStringVec[abi:cxx11](bool):
✓ Branch 0 taken 490 times.
✓ Branch 1 taken 490 times.
✓ Branch 3 taken 490 times.
✓ Branch 6 taken 462 times.
✓ Branch 7 taken 28 times.
✓ Branch 9 taken 462 times.
✓ Branch 12 taken 462 times.
✓ Branch 17 taken 490 times.
✓ Branch 20 taken 490 times.
✓ Branch 23 taken 952 times.
✓ Branch 24 taken 56 times.
✓ Branch 25 taken 28 times.
✓ Branch 26 taken 28 times.
✗ Branch 27 not taken.
✓ Branch 28 taken 28 times.
openstudio::EpwDataField::enumName[abi:cxx11]():
✗ Branch 1 not taken.
openstudio::operator<<(std::ostream&, openstudio::EpwDataField const&):
✗ Branch 1 not taken.
✗ Branch 4 not taken.
✗ Branch 7 not taken.
✗ Branch 10 not taken.
✗ Branch 13 not taken.
✗ Branch 16 not taken.
82376 OPENSTUDIO_ENUM(EpwDataField,
86 ((Year)(Year)(0))
87 ((Month)(Month))
88 ((Day)(Day))
89 ((Hour)(Hour))
90 ((Minute)(Minute))
91 ((DataSourceandUncertaintyFlags)(Data Source and Uncertainty Flags))
92 ((DryBulbTemperature)(Dry Bulb Temperature))
93 ((DewPointTemperature)(Dew Point Temperature))
94 ((RelativeHumidity)(Relative Humidity))
95 ((AtmosphericStationPressure)(Atmospheric Station Pressure))
96 ((ExtraterrestrialHorizontalRadiation)(Extraterrestrial Horizontal Radiation))
97 ((ExtraterrestrialDirectNormalRadiation)(Extraterrestrial Direct Normal Radiation))
98 ((HorizontalInfraredRadiationIntensity)(Horizontal Infrared Radiation Intensity))
99 ((GlobalHorizontalRadiation)(Global Horizontal Radiation))
100 ((DirectNormalRadiation)(Direct Normal Radiation))
101 ((DiffuseHorizontalRadiation)(Diffuse Horizontal Radiation))
102 ((GlobalHorizontalIlluminance)(Global Horizontal Illuminance))
103 ((DirectNormalIlluminance)(Direct Normal Illuminance))
104 ((DiffuseHorizontalIlluminance)(Diffuse Horizontal Illuminance))
105 ((ZenithLuminance)(Zenith Luminance))
106 ((WindDirection)(Wind Direction))
107 ((WindSpeed)(Wind Speed))
108 ((TotalSkyCover)(Total Sky Cover))
109 ((OpaqueSkyCover)(Opaque Sky Cover))
110 ((Visibility))
111 ((CeilingHeight)(Ceiling Height))
112 ((PresentWeatherObservation)(Present Weather Observation))
113 ((PresentWeatherCodes)(Present Weather Codes))
114 ((PrecipitableWater)(Precipitable Water))
115 ((AerosolOpticalDepth)(Aerosol Optical Depth))
116 ((SnowDepth)(Snow Depth))
117 ((DaysSinceLastSnowfall)(Days Since Last Snowfall))
118 ((Albedo))
119 ((LiquidPrecipitationDepth)(Liquid Precipitation Depth))
120 ((LiquidPrecipitationQuantity)(Liquid Precipitation Quantity))
121 );
122
123 ✗ OPENSTUDIO_ENUM(EpwComputedField,
124 ((SaturationPressure)(Saturation Pressure)(0))
125 ((Enthalpy)(Enthalpy))
126 ((HumidityRatio)(Humidity Ratio))
127 ((WetBulbTemperature)(Wet Bulb Temperature))
128 ((Density)(Density))
129 ((SpecificVolume)(Specific Volume))
130 );
131
132 // cppcheck-suppress [unknownMacro, syntaxError]
133
13/22
openstudio::ASHRAEHoFVintage::buildStringVec[abi:cxx11](bool):
✓ Branch 0 taken 15 times.
✓ Branch 1 taken 285 times.
✓ Branch 3 taken 15 times.
✓ Branch 6 taken 15 times.
✗ Branch 7 not taken.
✓ Branch 9 taken 15 times.
✓ Branch 12 taken 15 times.
✓ Branch 17 taken 285 times.
✓ Branch 20 taken 285 times.
✓ Branch 23 taken 240 times.
✓ Branch 24 taken 120 times.
✓ Branch 25 taken 60 times.
✓ Branch 26 taken 60 times.
✗ Branch 27 not taken.
✓ Branch 28 taken 60 times.
openstudio::ASHRAEHoFVintage::enumName[abi:cxx11]():
✗ Branch 1 not taken.
openstudio::operator<<(std::ostream&, openstudio::ASHRAEHoFVintage const&):
✗ Branch 1 not taken.
✗ Branch 4 not taken.
✗ Branch 7 not taken.
✗ Branch 10 not taken.
✗ Branch 13 not taken.
✗ Branch 16 not taken.
569 OPENSTUDIO_ENUM(ASHRAEHoFVintage,
134 ((ASHRAE_2009)(ASHRAE Handbook of Fundamentals 2009))
135 ((ASHRAE_2013)(ASHRAE Handbook of Fundamentals 2013))
136 ((ASHRAE_2017)(ASHRAE Handbook of Fundamentals 2017))
137 ((ASHRAE_2021)(ASHRAE Handbook of Fundamentals 2021))
138 ((ASHRAE_2025)(ASHRAE Handbook of Fundamentals 2025))
139 );
140
141 // cppcheck-suppress [unknownMacro, syntaxError]
142
13/22
openstudio::EpwDesignField::buildStringVec[abi:cxx11](bool):
✓ Branch 0 taken 770 times.
✓ Branch 1 taken 3780 times.
✓ Branch 3 taken 770 times.
✓ Branch 6 taken 770 times.
✗ Branch 7 not taken.
✓ Branch 9 taken 770 times.
✓ Branch 12 taken 770 times.
✓ Branch 17 taken 3780 times.
✓ Branch 20 taken 3780 times.
✓ Branch 23 taken 4485 times.
✓ Branch 24 taken 130 times.
✓ Branch 25 taken 65 times.
✓ Branch 26 taken 65 times.
✗ Branch 27 not taken.
✓ Branch 28 taken 65 times.
openstudio::EpwDesignField::enumName[abi:cxx11]():
✗ Branch 1 not taken.
openstudio::operator<<(std::ostream&, openstudio::EpwDesignField const&):
✗ Branch 1 not taken.
✗ Branch 4 not taken.
✗ Branch 7 not taken.
✗ Branch 10 not taken.
✗ Branch 13 not taken.
✗ Branch 16 not taken.
13384 OPENSTUDIO_ENUM(EpwDesignField,
143 ((TitleOfDesignCondition)(Title of Design Condition)(0))
144 ((Blank)(Blank))
145 ((Heating)(Heating))
146 ((HeatingColdestMonth)(Heating Coldest Month))
147 ((HeatingDryBulb99pt6)(Heating Dry Bulb Temperature 99.6%))
148 ((HeatingDryBulb99)(Heating Dry Bulb Temperature 99%))
149 ((HeatingHumidificationDewPoint99pt6)(Heating Humidification Dew Point Temperature 99.6%))
150 ((HeatingHumidificationHumidityRatio99pt6)(Heating Humidification Humidity Ratio 99.6%))
151 ((HeatingHumidificationMeanCoincidentDryBulb99pt6)(Heating Humidification Mean Coincident Dry Bulb Temperature 99.6%))
152 ((HeatingHumidificationDewPoint99)(Heating Humidification Dew Point Temperature 99%))
153 ((HeatingHumidificationHumidityRatio99)(Heating Humidification Humidity Ratio 99%))
154 ((HeatingHumidificationMeanCoincidentDryBulb99)(Heating Humidification Mean Coincident Dry Bulb 99%))
155 ((HeatingColdestMonthWindSpeed0pt4)(Heating Coldest Month Wind Speed 0.4%))
156 ((HeatingColdestMonthMeanCoincidentDryBulb0pt4)(Heating Coldest Month Mean Coincident Dry Bulb 0.4%))
157 ((HeatingColdestMonthWindSpeed1)(Heating Coldest Month Wind Speed 1%))
158 ((HeatingColdestMonthMeanCoincidentDryBulb1)(Heating Coldest Month Mean Coincident Dry Bulb 1%))
159 ((HeatingMeanCoincidentWindSpeed99pt6)(Heating Mean Coincident Wind Speed))
160 ((HeatingPrevailingCoincidentWindDirection99pt6)(Heating Prevailing Coincident Wind Direction 99.6%))
161 ((HeatingWindShelterFactor)(Heating Wind Shelter Factor)) // ASHRAE HOF, Ch 14, 2021 and 2025 editions
162 ((Cooling)(Cooling))
163 ((CoolingHottestMonth)(Cooling Hottest Month))
164 ((CoolingDryBulbRange)(Cooling Dry Bulb Range))
165 ((CoolingDryBulb0pt4)(Cooling Dry Bulb 0.4%))
166 ((CoolingMeanCoincidentWetBulb0pt4)(Cooling Mean Coincident Wet Bulb 0.4%))
167 ((CoolingDryBulb1)(Cooling Dry Bulb 1%))
168 ((CoolingMeanCoincidentWetBulb1)(Cooling Mean Coincident Wet Bulb 1%))
169 ((CoolingDryBulb2)(Cooling Dry Bulb 2%))
170 ((CoolingMeanCoincidentWetBulb2)(Cooling Mean Coincident Wet Bulb 2%))
171 ((CoolingEvaporationWetBulb0pt4)(Cooling Evaporation Wet Bulb 0.4%))
172 ((CoolingEvaporationMeanCoincidentDryBulb0pt4)(Cooling Evaporation Mean Coincident Dry Bulb 0.4%))
173 ((CoolingEvaporationWetBulb1)(Cooling Evaporation Wet Bulb 1%))
174 ((CoolingEvaporationMeanCoincidentDryBulb1)(Cooling Evaporation Mean Coincident Dry Bulb 1%))
175 ((CoolingEvaporationWetBulb2)(Cooling Evaporation Wet Bulb 2%))
176 ((CoolingEvaporationMeanCoincidentDryBulb2)(Cooling Evaporation Mean Coincident Dry Bulb 2%))
177 ((CoolingMeanCoincidentWindSpeed0pt4)(Cooling Mean Coincident Wind Speed 0.4%))
178 ((CoolingPrevailingCoincidentWindDirection0pt4)(Cooling Prevailing Coincident Wind Direction 0.4%))
179 ((CoolingDehumidificationDewPoint0pt4)(Cooling Dehumidification Dew Point 0.4%))
180 ((CoolingDehumidificationHumidityRatio0pt4)(Cooling Dehumidification Humidity Ratio 0.4%))
181 ((CoolingDehumidificationMeanCoincidentDryBulb0pt4)(Cooling Dehumidification Mean Coincident Dry Bulb 0.4%))
182 ((CoolingDehumidificationDewPoint1)(Cooling Dehumidification Dew Point 1%))
183 ((CoolingDehumidificationHumidityRatio1)(Cooling Dehumidification Humidity Ratio 1%))
184 ((CoolingDehumidificationMeanCoincidentDryBulb1)(Cooling Dehumidification Mean Coincident Dry Bulb 1%))
185 ((CoolingDehumidificationDewPoint2)(Cooling Dehumidification Dew Point 2%))
186 ((CoolingDehumidificationHumidityRatio2)(Cooling Dehumidification Humidity Ratio 2%))
187 ((CoolingDehumidificationMeanCoincidentDryBulb2)(Cooling Dehumidification Mean Coincident Dry Bulb 2%))
188 ((CoolingEnthalpy0pt4)(Cooling Enthalpy 0.4%))
189 ((CoolingEnthalpyMeanCoincidentDryBulb0pt4)(Cooling Enthalpy Mean Coincident Dry Bulb 0.4%))
190 ((CoolingEnthalpy1)(Cooling Enthalpy 1%))
191 ((CoolingEnthalpyMeanCoincidentDryBulb1)(Cooling Enthalpy Mean Coincident Dry Bulb 1%))
192 ((CoolingEnthalpy2)(Cooling Enthalpy 2%))
193 ((CoolingEnthalpyMeanCoincidentDryBulb2)(Cooling Enthalpy Mean Coincident Dry Bulb 2%))
194 ((CoolingHours8To4AndDryBulb12pt8To20pt6)(Cooling Hours 8 to 4 and Dry Bulb 12.8% to 20.6%)) // ASHRAE HOF, Ch 14, up to 2013 (included) editions
195 ((CoolingExtremeMaxWetBulb)(Cooling Extreme Max Wet Bulb)) // ASHRAE HOF, Ch 14, 2017, 2021 and 2025 editions
196 ((Extremes)(Extremes))
197 ((ExtremeWindSpeed1)(Extreme Wind Speed 1%))
198 ((ExtremeWindSpeed2pt5)(Extreme Wind Speed 2.5%))
199 ((ExtremeWindSpeed5)(Extreme Wind Speed 5%))
200 ((ExtremeMaxWetBulb)(Extreme Max Wet Bulb)) // ASHRAE HOF, Ch 14, up to 2013 (included) editions
201 ((ExtremeMeanMinDryBulb)(Extreme Mean Min Dry Bulb))
202 ((ExtremeMeanMaxDryBulb)(Extreme Mean Max Dry Bulb))
203 ((ExtremeStdDevMinDryBulb)(Extreme Std Dev Min Dry Bulb))
204 ((ExtremeStdDevMaxDryBulb)(Extreme Std Dev Max Dry Bulb))
205 ((ExtremeN5YearsMinDryBulb)(Extreme N5 Years Min Dry Bulb))
206 ((ExtremeN5YearsMaxDryBulb)(Extreme N5 Years Max Dry Bulb))
207 ((ExtremeN10YearsMinDryBulb)(Extreme N10 Years Min Dry Bulb))
208 ((ExtremeN10YearsMaxDryBulb)(Extreme N10 Years Max Dry Bulb))
209 ((ExtremeN20YearsMinDryBulb)(Extreme N20 Years Min Dry Bulb))
210 ((ExtremeN20YearsMaxDryBulb)(Extreme N20 Years Max Dry Bulb))
211 ((ExtremeN50YearsMinDryBulb)(Extreme N50 Years Min Dry Bulb))
212 ((ExtremeN50YearsMaxDryBulb)(Extreme N50 Years Max Dry Bulb))
213 );
214 // cppcheck-suppress [unknownMacro, syntaxError]
215 ✗ OPENSTUDIO_ENUM(EpwDepthField,
216 ((GroundTemperatureDepth)(Ground Temperature Depth)(0))
217 ((SoilConductivity)(Soil Conductivity))
218 ((SoilDensity)(Soil Density))
219 ((SoilSpecificHeat)(Soil Specific Heat))
220 ((JanGroundTemperature)(January Ground Temperature))
221 ((FebGroundTemperature)(February Ground Temperature))
222 ((MarGroundTemperature)(March Ground Temperature))
223 ((AprGroundTemperature)(April Ground Temperature))
224 ((MayGroundTemperature)(May Ground Temperature))
225 ((JunGroundTemperature)(June Ground Temperature))
226 ((JulGroundTemperature)(July Ground Temperature))
227 ((AugGroundTemperature)(August Ground Temperature))
228 ((SepGroundTemperature)(September Ground Temperature))
229 ((OctGroundTemperature)(October Ground Temperature))
230 ((NovGroundTemperature)(November Ground Temperature))
231 ((DecGroundTemperature)(December Ground Temperature))
232 );
233
234 // clang-format on
235
236 /** EpwDataPoint is one line from the EPW file. All floating point numbers are stored as strings,
237 * but are checked as numbers.
238 */
239 class UTILITIES_API EpwDataPoint
240 {
241 public:
242 /** Create an empty EpwDataPoint object */
243
25/25
✓ Branch 2 taken 140232 times.
✓ Branch 5 taken 140232 times.
✓ Branch 8 taken 140232 times.
✓ Branch 11 taken 140232 times.
✓ Branch 14 taken 140232 times.
✓ Branch 17 taken 140232 times.
✓ Branch 20 taken 140232 times.
✓ Branch 23 taken 140232 times.
✓ Branch 26 taken 140232 times.
✓ Branch 29 taken 140232 times.
✓ Branch 32 taken 140232 times.
✓ Branch 35 taken 140232 times.
✓ Branch 38 taken 140232 times.
✓ Branch 41 taken 140232 times.
✓ Branch 44 taken 140232 times.
✓ Branch 47 taken 140232 times.
✓ Branch 50 taken 140232 times.
✓ Branch 53 taken 140232 times.
✓ Branch 56 taken 140232 times.
✓ Branch 59 taken 140232 times.
✓ Branch 62 taken 140232 times.
✓ Branch 65 taken 140232 times.
✓ Branch 68 taken 140232 times.
✓ Branch 71 taken 140232 times.
✓ Branch 74 taken 140232 times.
7151832 EpwDataPoint() = default;
244 /** Create an EpwDataPoint object with specified properties */
245 EpwDataPoint(int year, int month, int day, int hour, int minute, const std::string& dataSourceandUncertaintyFlags, double dryBulbTemperature,
246 double dewPointTemperature, double relativeHumidity, double atmosphericStationPressure, double extraterrestrialHorizontalRadiation,
247 double extraterrestrialDirectNormalRadiation, double horizontalInfraredRadiationIntensity, double globalHorizontalRadiation,
248 double directNormalRadiation, double diffuseHorizontalRadiation, double globalHorizontalIlluminance, double directNormalIlluminance,
249 double diffuseHorizontalIlluminance, double zenithLuminance, double windDirection, double windSpeed, int totalSkyCover,
250 int opaqueSkyCover, double visibility, double ceilingHeight, int presentWeatherObservation, int presentWeatherCodes,
251 double precipitableWater, double aerosolOpticalDepth, double snowDepth, double daysSinceLastSnowfall, double albedo,
252 double liquidPrecipitationDepth, double liquidPrecipitationQuantity);
253 // Static
254 /** Returns the units of the named field */
255 static boost::optional<std::string> getUnitsByName(const std::string& name);
256 /** Returns the units of the field specified by enumeration value */
257 static std::string getUnits(EpwDataField field);
258 /** Returns the units of the computed value specified by enumeration value */
259 static std::string getUnits(EpwComputedField field);
260 // Data retrieval
261 /** Returns the double value of the named field if possible */
262 boost::optional<double> getFieldByName(const std::string& name) const;
263 /** Returns the dobule value of the field specified by enumeration value */
264 boost::optional<double> getField(EpwDataField id) const;
265 /** Returns the air state specified by the EPW data. If dry bulb, pressure, and relative humidity are available,
266 then those values will be used to compute the air state. Otherwise, unless dry bulb, pressure, and dew point are
267 available, then an empty optional will be returned. Note that the air state may not be consistend with the EPW
268 data if all 4 parameters are in the EPW data. */
269 boost::optional<AirState> airState() const;
270 // Conversion
271 /** Create an EpwDataPoint from an EPW-formatted string */
272 static boost::optional<EpwDataPoint> fromEpwString(const std::string& line);
273 /** Create an EpwDataPoint from a list of EPW data as strings. The pedantic argument controls how strict the conversion is.
274 If pedantic is true, the list should have 35 elements. If pedantic is false, lists with more or fewer elements may
275 still result in an EpwDataPoint */
276 static boost::optional<EpwDataPoint> fromEpwStrings(const std::vector<std::string>& list, bool pedantic = true);
277 /** Create an EpwDataPoint from a list of EPW data as strings, overriding the date and time with the specified arguments.
278 The pedantic argument controls how strict the conversion is. If pedantic is true, the list should have 35 elements.
279 If pedantic is false, lists with more or fewer elements may still result in an EpwDataPoint */
280 static boost::optional<EpwDataPoint> fromEpwStrings(int year, int month, int day, int hour, int minute, const std::vector<std::string>& list,
281 bool pedantic = true);
282 /** Returns a list of strings containing the EPW data in the EpwDataPoint */
283 std::vector<std::string> toEpwStrings() const;
284 /** Convert the EPW data into CONTAM's WTH format */
285 boost::optional<std::string> toWthString() const;
286 // One billion getters
287 /** Returns the date in a Date object */
288 Date date() const;
289 /** Returns the time in a Time object */
290 Time time() const;
291 /** Returns the date and time in a DateTime object */
292 openstudio::DateTime dateTime() const;
293 /** Returns the year as an integer */
294 int year() const;
295 /** Returns the month as an integer */
296 int month() const;
297 /** Returns the day as an integer */
298 int day() const;
299 /** Returns the hour as an integer */
300 int hour() const;
301 /** Returns the minute as an integer */
302 int minute() const;
303 /** Returns the data source and uncertainty flags */
304 std::string dataSourceandUncertaintyFlags() const;
305 /** If available, return the dry bulb temperature in degrees C */
306 boost::optional<double> dryBulbTemperature() const;
307 /** If available, return the dew point temperature in degrees C */
308 boost::optional<double> dewPointTemperature() const;
309 /** If available, return the relative humidity in % */
310 boost::optional<double> relativeHumidity() const;
311 /** If available, return the atmospheric station pressure in Pa */
312 boost::optional<double> atmosphericStationPressure() const;
313 /** If available, return the extraterrestrial horizontal radiation in Wh/m2*/
314 boost::optional<double> extraterrestrialHorizontalRadiation() const;
315 /** If available, return the extraterrestrial direct normal radiation in Wh/m2 */
316 boost::optional<double> extraterrestrialDirectNormalRadiation() const;
317 /** If available, return the horizontal infrared radiation intensity in Wh/m2*/
318 boost::optional<double> horizontalInfraredRadiationIntensity() const;
319 /** If available, return the global horizontal radiation in Wh/m2 */
320 boost::optional<double> globalHorizontalRadiation() const;
321 /** If available, return direct normal radiation in Wh/m2*/
322 boost::optional<double> directNormalRadiation() const;
323 /** If available, return the diffuse horizontal radiation in Wh/m2*/
324 boost::optional<double> diffuseHorizontalRadiation() const;
325 /** If available, return the global horizontal illuminance in lux*/
326 boost::optional<double> globalHorizontalIlluminance() const;
327 /** If available, return the direct normal illuminance in lux*/
328 boost::optional<double> directNormalIlluminance() const;
329 /** If available, return the diffuse horizontal illuminance in lux*/
330 boost::optional<double> diffuseHorizontalIlluminance() const;
331 /** If available, return the zenith luminances Cd/m2*/
332 boost::optional<double> zenithLuminance() const;
333 /** If available, return the wind direction in degrees*/
334 boost::optional<double> windDirection() const;
335 /** If available, return the wind speed in m/s */
336 boost::optional<double> windSpeed() const;
337 /** Returns the total sky cover */
338 int totalSkyCover() const;
339 /** Returns the opaque sky cover */
340 int opaqueSkyCover() const;
341 /** If available, return the visibility in km */
342 boost::optional<double> visibility() const;
343 /** If available, return the ceiling height in m*/
344 boost::optional<double> ceilingHeight() const;
345 /** Returns the present weather observation */
346 int presentWeatherObservation() const;
347 /** Returns the presetn weather codes */
348 int presentWeatherCodes() const;
349 /** If available, return the precipitable water in mm*/
350 boost::optional<double> precipitableWater() const;
351 /** If available, return the aerosol optical depth in thousandths*/
352 boost::optional<double> aerosolOpticalDepth() const;
353 /** If available, return the snow depth in cm */
354 boost::optional<double> snowDepth() const;
355 /** If available, return the days since last snowfall */
356 boost::optional<double> daysSinceLastSnowfall() const;
357 /** If available, return the albedo */
358 boost::optional<double> albedo() const;
359 /** If available, return the liquid precipitation depth in mm */
360 boost::optional<double> liquidPrecipitationDepth() const;
361 /** If available, return the liquid precipitation quantity in hr */
362 boost::optional<double> liquidPrecipitationQuantity() const;
363
364 // Computed quantities
365 /** If possible, compute and return the saturation pressure in Pa */
366 boost::optional<double> saturationPressure() const;
367 /** If possible, compute and return the enthalpy in kJ/kg */
368 boost::optional<double> enthalpy() const;
369 /** If possible, compute and return the humidity ratio */
370 boost::optional<double> humidityRatio() const;
371 /** If possible, compute and return the density kg/m3 */
372 boost::optional<double> density() const;
373 /** If possible, compute and return the specific volume in m3/kg */
374 boost::optional<double> specificVolume() const;
375 /** If possible, compute and return the wet bulb temperature in C */
376 boost::optional<double> wetbulb() const;
377
378 private:
379 // One billion setters
380 void setDate(Date date);
381 void setTime(Time time);
382 void setDateTime(openstudio::DateTime dateTime);
383 void setYear(int year);
384 bool setYear(const std::string& year);
385 bool setMonth(int month);
386 bool setMonth(const std::string& month);
387 bool setDay(int day);
388 bool setDay(const std::string& day);
389 bool setHour(int hour);
390 bool setHour(const std::string& hour);
391 bool setMinute(int minute);
392 bool setMinute(const std::string& minute);
393 void setDataSourceandUncertaintyFlags(const std::string& dataSourceandUncertaintyFlags);
394 bool setDryBulbTemperature(double dryBulbTemperature);
395 bool setDryBulbTemperature(const std::string& dryBulbTemperature);
396 bool setDewPointTemperature(double dewPointTemperature);
397 bool setDewPointTemperature(const std::string& dewPointTemperature);
398 bool setRelativeHumidity(double relativeHumidity);
399 bool setRelativeHumidity(const std::string& relativeHumidity);
400 bool setAtmosphericStationPressure(double atmosphericStationPressure);
401 bool setAtmosphericStationPressure(const std::string& atmosphericStationPressure);
402 bool setExtraterrestrialHorizontalRadiation(double extraterrestrialHorizontalRadiation);
403 bool setExtraterrestrialHorizontalRadiation(const std::string& extraterrestrialHorizontalRadiation);
404 bool setExtraterrestrialDirectNormalRadiation(double extraterrestrialDirectNormalRadiation);
405 bool setExtraterrestrialDirectNormalRadiation(const std::string& extraterrestrialDirectNormalRadiation);
406 bool setHorizontalInfraredRadiationIntensity(double horizontalInfraredRadiationIntensity);
407 bool setHorizontalInfraredRadiationIntensity(const std::string& horizontalInfraredRadiationIntensity);
408 bool setGlobalHorizontalRadiation(double globalHorizontalRadiation);
409 bool setGlobalHorizontalRadiation(const std::string& globalHorizontalRadiation);
410 bool setDirectNormalRadiation(double directNormalRadiation);
411 bool setDirectNormalRadiation(const std::string& directNormalRadiation);
412 bool setDiffuseHorizontalRadiation(double diffuseHorizontalRadiation);
413 bool setDiffuseHorizontalRadiation(const std::string& diffuseHorizontalRadiation);
414 bool setGlobalHorizontalIlluminance(double globalHorizontalIlluminance);
415 bool setGlobalHorizontalIlluminance(const std::string& globalHorizontalIlluminance);
416 bool setDirectNormalIlluminance(double directNormalIlluminance);
417 bool setDirectNormalIlluminance(const std::string& directNormalIlluminance);
418 bool setDiffuseHorizontalIlluminance(double diffuseHorizontalIlluminance);
419 bool setDiffuseHorizontalIlluminance(const std::string& diffuseHorizontalIlluminance);
420 bool setZenithLuminance(double zenithLuminance);
421 bool setZenithLuminance(const std::string& zenithLuminance);
422 bool setWindDirection(double windDirection);
423 bool setWindDirection(const std::string& windDirection);
424 bool setWindSpeed(double windSpeed);
425 bool setWindSpeed(const std::string& windSpeed);
426 bool setTotalSkyCover(int totalSkyCover);
427 bool setTotalSkyCover(const std::string& totalSkyCover);
428 bool setOpaqueSkyCover(int opaqueSkyCover);
429 bool setOpaqueSkyCover(const std::string& opaqueSkyCover);
430 bool setVisibility(double visibility);
431 bool setVisibility(const std::string& visibility);
432 void setCeilingHeight(double ceilingHeight);
433 bool setCeilingHeight(const std::string& ceilingHeight);
434 void setPresentWeatherObservation(int presentWeatherObservation);
435 bool setPresentWeatherObservation(const std::string& presentWeatherObservation);
436 void setPresentWeatherCodes(int presentWeatherCodes);
437 bool setPresentWeatherCodes(const std::string& presentWeatherCodes);
438 void setPrecipitableWater(double precipitableWater);
439 bool setPrecipitableWater(const std::string& precipitableWater);
440 void setAerosolOpticalDepth(double aerosolOpticalDepth);
441 bool setAerosolOpticalDepth(const std::string& aerosolOpticalDepth);
442 void setSnowDepth(double snowDepth);
443 bool setSnowDepth(const std::string& snowDepth);
444 void setDaysSinceLastSnowfall(double daysSinceLastSnowfall);
445 bool setDaysSinceLastSnowfall(const std::string& daysSinceLastSnowfall);
446 void setAlbedo(double albedo);
447 bool setAlbedo(const std::string& albedo);
448 void setLiquidPrecipitationDepth(double liquidPrecipitationDepth);
449 bool setLiquidPrecipitationDepth(const std::string& liquidPrecipitationDepth);
450 void setLiquidPrecipitationQuantity(double liquidPrecipitationQuantity);
451 bool setLiquidPrecipitationQuantity(const std::string& liquidPrecipitationQuantity);
452
453 int m_year = 1;
454 int m_month = 1;
455 int m_day = 1;
456 int m_hour = 1;
457 int m_minute = 0;
458 std::string m_dataSourceandUncertaintyFlags;
459 // Note: all numeric fields should be stored as optional<T> instead of being string based
460 std::string m_dryBulbTemperature = "99.9"; // units C, minimum> -70, maximum< 70, missing 99.9
461 std::string m_dewPointTemperature = "99.9"; // units C, minimum> -70, maximum< 70, missing 99.9
462 std::string m_relativeHumidity = "999"; // missing 999., minimum 0, maximum 110
463 std::string m_atmosphericStationPressure = "999999"; // units Pa, missing 999999., minimum> 31000, maximum< 120000
464 std::string m_extraterrestrialHorizontalRadiation = "9999"; // units Wh/m2, missing 9999., minimum 0
465 std::string m_extraterrestrialDirectNormalRadiation = "9999"; //units Wh/m2, missing 9999., minimum 0
466 std::string m_horizontalInfraredRadiationIntensity = "9999"; // units Wh/m2, missing 9999., minimum 0
467 std::string m_globalHorizontalRadiation = "9999"; // units Wh/m2, missing 9999., minimum 0
468 std::string m_directNormalRadiation = "9999"; // units Wh/m2, missing 9999., minimum 0
469 std::string m_diffuseHorizontalRadiation = "9999"; // units Wh/m2, missing 9999., minimum 0
470 std::string m_globalHorizontalIlluminance = "999999"; // units lux, missing 999999., will be missing if >= 999900, minimum 0
471 std::string m_directNormalIlluminance = "999999"; // units lux, missing 999999., will be missing if >= 999900, minimum 0
472 std::string m_diffuseHorizontalIlluminance = "999999"; // units lux, missing 999999., will be missing if >= 999900, minimum 0
473 std::string m_zenithLuminance = "9999"; // units Cd/m2, missing 9999., will be missing if >= 9999, minimum 0
474 std::string m_windDirection = "999"; // units degrees, missing 999., minimum 0, maximum 360
475 std::string m_windSpeed = "999"; // units m/s, missing 999., minimum 0, maximum 40
476 int m_totalSkyCover = 99; // missing 99, minimum 0, maximum 10
477 int m_opaqueSkyCover = 99; // used if Horizontal IR Intensity missing, missing 99, minimum 0, maximum 10
478 std::string m_visibility = "9999"; // units km, missing 9999
479 std::string m_ceilingHeight = "99999"; // units m, missing 99999
480 int m_presentWeatherObservation = 0; // TODO: this should be a bool, in EPW 0 = present, 9 = missing
481 int m_presentWeatherCodes = 0; // TODO: this should be a struct, it stores 9 integer fields, only if prev field is 0
482 std::string m_precipitableWater = "999"; // units mm, missing 999
483 std::string m_aerosolOpticalDepth = ".999"; // units thousandths, missing .999
484 std::string m_snowDepth = "999"; // units cm, missing 999
485 std::string m_daysSinceLastSnowfall = "99"; // missing 99
486 std::string m_albedo = "999"; // missing 999
487 std::string m_liquidPrecipitationDepth = "999"; // units mm, missing 999
488 std::string m_liquidPrecipitationQuantity = "99"; // units hr, missing 99
489 };
490
491 class UTILITIES_API EpwHoliday
492 {
493
494 public:
495 9 EpwHoliday(const std::string& holidayName, const std::string& holidayDateString)
496
1/1
✓ Branch 2 taken 9 times.
9 : m_holidayName(holidayName), m_holidayDateString(holidayDateString){};
497
498 9 std::string holidayName() const {
499 9 return m_holidayName;
500 };
501 9 std::string holidayDateString() const {
502 9 return m_holidayDateString;
503 };
504
505 private:
506 std::string m_holidayName;
507 std::string m_holidayDateString;
508 };
509
510 /** EpwDesignCondition is one line from the EPW file. All floating point numbers are stored as strings,
511 * but are checked as numbers.
512 */
513 class UTILITIES_API EpwDesignCondition
514 {
515 public:
516 /** Create an empty EpwDesignCondition object */
517 59 EpwDesignCondition() = default;
518 /** Create an EpwDesignCondition object with specified properties */
519 EpwDesignCondition(
520 const std::string& titleOfDesignCondition, int heatingColdestMonth, double heatingDryBulb99pt6, double heatingDryBulb99,
521 double heatingHumidificationDewPoint99pt6, double heatingHumidificationHumidityRatio99pt6, double heatingHumidificationMeanCoincidentDryBulb99pt6,
522 double heatingHumidificationDewPoint99, double heatingHumidificationHumidityRatio99, double heatingHumidificationMeanCoincidentDryBulb99,
523 double heatingColdestMonthWindSpeed0pt4, double heatingColdestMonthMeanCoincidentDryBulb0pt4, double heatingColdestMonthWindSpeed1,
524 double heatingColdestMonthMeanCoincidentDryBulb1, double heatingMeanCoincidentWindSpeed99pt6, int heatingPrevailingCoincidentWindDirection99pt6,
525 int coolingHottestMonth, double coolingDryBulbRange, double coolingDryBulb0pt4, double coolingMeanCoincidentWetBulb0pt4, double coolingDryBulb1,
526 double coolingMeanCoincidentWetBulb1, double coolingDryBulb2, double coolingMeanCoincidentWetBulb2, double coolingEvaporationWetBulb0pt4,
527 double coolingEvaporationMeanCoincidentDryBulb0pt4, double coolingEvaporationWetBulb1, double coolingEvaporationMeanCoincidentDryBulb1,
528 double coolingEvaporationWetBulb2, double coolingEvaporationMeanCoincidentDryBulb2, double coolingMeanCoincidentWindSpeed0pt4,
529 int coolingPrevailingCoincidentWindDirection0pt4, double coolingDehumidificationDewPoint0pt4, double coolingDehumidificationHumidityRatio0pt4,
530 double coolingDehumidificationMeanCoincidentDryBulb0pt4, double coolingDehumidificationDewPoint1, double coolingDehumidificationHumidityRatio1,
531 double coolingDehumidificationMeanCoincidentDryBulb1, double coolingDehumidificationDewPoint2, double coolingDehumidificationHumidityRatio2,
532 double coolingDehumidificationMeanCoincidentDryBulb2, double coolingEnthalpy0pt4, double coolingEnthalpyMeanCoincidentDryBulb0pt4,
533 double coolingEnthalpy1, double coolingEnthalpyMeanCoincidentDryBulb1, double coolingEnthalpy2, double coolingEnthalpyMeanCoincidentDryBulb2,
534 int coolingHours8To4AndDryBulb12pt8To20pt6, double extremeWindSpeed1, double extremeWindSpeed2pt5, double extremeWindSpeed5,
535 double extremeMaxWetBulb, double extremeMeanMinDryBulb, double extremeMeanMaxDryBulb, double extremeStdDevMinDryBulb,
536 double extremeStdDevMaxDryBulb, double extremeN5YearsMinDryBulb, double extremeN5YearsMaxDryBulb, double extremeN10YearsMinDryBulb,
537 double extremeN10YearsMaxDryBulb, double extremeN20YearsMinDryBulb, double extremeN20YearsMaxDryBulb, double extremeN50YearsMinDryBulb,
538 double extremeN50YearsMaxDryBulb);
539
540 // Static
541 /** Returns the units of the named field */
542 static boost::optional<std::string> getUnitsByName(const std::string& name);
543 /** Returns the units of the field specified by enumeration value */
544 static std::string getUnits(EpwDesignField field);
545 // Data retrieval
546 /** Returns the double value of the named field if possible */
547 boost::optional<double> getFieldByName(const std::string& name) const;
548 /** Returns the dobule value of the field specified by enumeration value */
549 boost::optional<double> getField(EpwDesignField id) const;
550 // Conversion
551 /** Create an EpwDesignCondition from an EPW-formatted string */
552 static boost::optional<EpwDesignCondition> fromDesignConditionsString(const std::string& line);
553 /** Create an EpwDesignCondition from a list of EPW designs as strings */
554 static boost::optional<EpwDesignCondition> fromDesignConditionsStrings(const std::vector<std::string>& strings);
555 // Getters
556 /** Returns the title of design condition */
557 std::string titleOfDesignCondition() const;
558 /** Returns the heating coldest month */
559 boost::optional<int> heatingColdestMonth() const;
560 /** Returns the heating dry bulb temperature 99.6% in degrees C*/
561 boost::optional<double> heatingDryBulb99pt6() const;
562 /** Returns the heating dry bulb temperature 99% in degrees C*/
563 boost::optional<double> heatingDryBulb99() const;
564 /** Returns the heating humidification dew point temperature 99.6% in degrees C*/
565 boost::optional<double> heatingHumidificationDewPoint99pt6() const;
566 /** Returns the heating humidification humidity ratio 99.6% in g of moisture per kg of dry air */
567 boost::optional<double> heatingHumidificationHumidityRatio99pt6() const;
568 /** Returns the heating humidification mean coincident dry bulb temperature 99.6% in degrees C*/
569 boost::optional<double> heatingHumidificationMeanCoincidentDryBulb99pt6() const;
570 /** Returns the heating humidification dew point temperature 99% in degrees C*/
571 boost::optional<double> heatingHumidificationDewPoint99() const;
572 /** Returns the heating humidification humidity ratio 99% in g of moisture per kg of dry air */
573 boost::optional<double> heatingHumidificationHumidityRatio99() const;
574 /** Returns the heating humidification mean coincient dry bulb temperature 99% in degrees C */
575 boost::optional<double> heatingHumidificationMeanCoincidentDryBulb99() const;
576 /** Returns the heating coldest month wind speed 0.4% in m/s */
577 boost::optional<double> heatingColdestMonthWindSpeed0pt4() const;
578 /** Returns the heating coldest month mean coincident dry bulb temperature 0.4% in degrees C*/
579 boost::optional<double> heatingColdestMonthMeanCoincidentDryBulb0pt4() const;
580 /** Returns the heating coldest month wind speed 1% in m/s */
581 boost::optional<double> heatingColdestMonthWindSpeed1() const;
582 /** Returns the heating coldest month mean coincident dry bulb temperature 1% in degrees C */
583 boost::optional<double> heatingColdestMonthMeanCoincidentDryBulb1() const;
584 /** Returns the heating mean coincident wind speed 99.6% in m/s */
585 boost::optional<double> heatingMeanCoincidentWindSpeed99pt6() const;
586 /** Returns the heating prevailing coincident wind direction 99.6% in degrees */
587 boost::optional<int> heatingPrevailingCoincidentWindDirection99pt6() const;
588 /** Returns the heating wind shelter factor.
589 * This is only available for Design Conditions taken from the ASHRAE Handbook of Fundamentals starting at the 2021 edition
590 **/
591 boost::optional<double> heatingWindShelterFactor() const;
592
593 /** Returns the cooling hottest month */
594 boost::optional<int> coolingHottestMonth() const;
595 /** Returns the cooling dry bulb temperature range in degrees C */
596 boost::optional<double> coolingDryBulbRange() const;
597 /** Returns the cooling dry bulb temperature 0.4% in degrees C */
598 boost::optional<double> coolingDryBulb0pt4() const;
599 /** Returns the cooling mean coincident wet bulb temperature in degrees C */
600 boost::optional<double> coolingMeanCoincidentWetBulb0pt4() const;
601 /** Returns the cooling dry bulb temperature 1% in degrees C */
602 boost::optional<double> coolingDryBulb1() const;
603 /** Returns the cooling mean coincident wet bulb temperature 1% in degrees C */
604 boost::optional<double> coolingMeanCoincidentWetBulb1() const;
605 /** Returns the cooling dry bulb temperature 2% in degrees C */
606 boost::optional<double> coolingDryBulb2() const;
607 /** Returns the cooling mean coincident wet bulb temperature 2% in degrees C */
608 boost::optional<double> coolingMeanCoincidentWetBulb2() const;
609 /** Returns the cooling evaporation wet bulb temperature 0.4% in degrees C */
610 boost::optional<double> coolingEvaporationWetBulb0pt4() const;
611 /** Returns the cooling evaporation mean coincident dry bulb temperature 0.4% in degrees C */
612 boost::optional<double> coolingEvaporationMeanCoincidentDryBulb0pt4() const;
613 /** Returns the cooling evaporation wet bulb temperature 1% in degrees C */
614 boost::optional<double> coolingEvaporationWetBulb1() const;
615 /** Returns the cooling evaporation mean coincident dry bulb temperature 1% in degrees C */
616 boost::optional<double> coolingEvaporationMeanCoincidentDryBulb1() const;
617 /** Returns the cooling evaporation wet bulb temperature 2% in degrees C */
618 boost::optional<double> coolingEvaporationWetBulb2() const;
619 /** Returns the cooling evaporation mean coincident dry bulb temperature 2% in degrees C */
620 boost::optional<double> coolingEvaporationMeanCoincidentDryBulb2() const;
621 /** Returns the cooling mean coincident wind speed 0.4% in m/s */
622 boost::optional<double> coolingMeanCoincidentWindSpeed0pt4() const;
623 /** Returns the cooling prevailing coincident wind direction 0.4% in degrees */
624 boost::optional<int> coolingPrevailingCoincidentWindDirection0pt4() const;
625 /** Returns the cooling dehumidification dew point temperature 0.4% in degrees C */
626 boost::optional<double> coolingDehumidificationDewPoint0pt4() const;
627 /** Returns the cooling dehumidification humidity ratio 0.4% in g of moisture per kg of dry air */
628 boost::optional<double> coolingDehumidificationHumidityRatio0pt4() const;
629 /** Returns the cooling dehumidification mean coincident dry bulb temperature 0.4% in degrees C */
630 boost::optional<double> coolingDehumidificationMeanCoincidentDryBulb0pt4() const;
631 /** Returns the cooling dehumidification dew point temperature 1% in degrees C */
632 boost::optional<double> coolingDehumidificationDewPoint1() const;
633 /** Returns the cooling dehumidification humidity ratio 1% in g of moisture per kg of dry air */
634 boost::optional<double> coolingDehumidificationHumidityRatio1() const;
635 /** Returns the cooling dehumidification mean coincident dry bulb temperature 1% in degrees C */
636 boost::optional<double> coolingDehumidificationMeanCoincidentDryBulb1() const;
637 /** Returns the cooling dehumidification dew point temperature 2% in degrees C */
638 boost::optional<double> coolingDehumidificationDewPoint2() const;
639 /** Returns the cooling dehumidification humidity ratio 2% in g of moisture per kg of dry air */
640 boost::optional<double> coolingDehumidificationHumidityRatio2() const;
641 /** Returns the cooling dehumidification mean coincident dry bulb temperature 2% in degrees C */
642 boost::optional<double> coolingDehumidificationMeanCoincidentDryBulb2() const;
643 /** Returns the cooling enthalpy 0.4% in kJ/kg */
644 boost::optional<double> coolingEnthalpy0pt4() const;
645 /** Returns the cooling enthalpy mean coincident dry bulb temperature 0.4% in degrees C */
646 boost::optional<double> coolingEnthalpyMeanCoincidentDryBulb0pt4() const;
647 /** Returns the cooling enthalpy 1% in kJ/kg */
648 boost::optional<double> coolingEnthalpy1() const;
649 /** Returns the cooling enthalpy mean coincident dry bulb temperature 1% in degrees C */
650 boost::optional<double> coolingEnthalpyMeanCoincidentDryBulb1() const;
651 /** Returns the cooling enthalpy 2% in kJ/kg */
652 boost::optional<double> coolingEnthalpy2() const;
653 /** Returns the cooling enthalpy mean coincident dry bulb temperature 2% in degrees C */
654 boost::optional<double> coolingEnthalpyMeanCoincidentDryBulb2() const;
655 /** Returns the number of cooling hours between 8am and 4pm with dry bulb temperature between 12.8 and 20.6 degrees C.
656 * This is only available for Design Conditions taken from the ASHRAE Handbook of Fundamentals up to 2013 (included) editions
657 **/
658 boost::optional<int> coolingHours8To4AndDryBulb12pt8To20pt6() const;
659 /** Returns the cooling maximum wet bulb temperature in degrees C.
660 * Prior to the 2017 edition of the ASHRAE Handbook of Fundamentals, this is stored in the Extreme section, and starting at 2017
661 * it is stored in the Cooling Section. This is an alias for extremeMaxWetBulb() (pre-existing method) for clarity.
662 **/
663 boost::optional<double> coolingExtremeMaxWetBulb() const;
664
665 /** Returns the extreme wind speed 1% in m/s */
666 boost::optional<double> extremeWindSpeed1() const;
667 /** Returns the extreme wind speed 2.5% in m/s */
668 boost::optional<double> extremeWindSpeed2pt5() const;
669 /** Returns the extreme wind speed 5% in m/s */
670 boost::optional<double> extremeWindSpeed5() const;
671 /** Returns the (cooling) extreme maximum wet bulb temperature in degrees C
672 * Prior to the 2017 edition of the ASHRAE Handbook of Fundamentals, this is stored in the Extreme section, and starting at 2017
673 * it is stored in the Cooling Section.
674 **/
675 boost::optional<double> extremeMaxWetBulb() const;
676 /** Returns the extreme mean minimum dry bulb temperature in degrees C */
677 boost::optional<double> extremeMeanMinDryBulb() const;
678 /** Returns the extreme mean maximum dry bulb temperature in degrees C */
679 boost::optional<double> extremeMeanMaxDryBulb() const;
680 /** Returns the extreme standard deviation minimum dry bulb temperature in degrees C */
681 boost::optional<double> extremeStdDevMinDryBulb() const;
682 /** Returns the extreme standard deviation maximum dry bulb temperature in degrees C */
683 boost::optional<double> extremeStdDevMaxDryBulb() const;
684 /** Returns the extreme n=5 years minimum dry bulb temperature in degrees C */
685 boost::optional<double> extremeN5YearsMinDryBulb() const;
686 /** Returns the extreme n=5 years maximum dry bulb temperature in degrees C */
687 boost::optional<double> extremeN5YearsMaxDryBulb() const;
688 /** Returns the extreme n=10 years minimum dry bulb temperature in degrees C */
689 boost::optional<double> extremeN10YearsMinDryBulb() const;
690 /** Returns the extreme n=10 years maximum dry bulb temperature in degrees C */
691 boost::optional<double> extremeN10YearsMaxDryBulb() const;
692 /** Returns the extreme n=20 years minimum dry bulb temperature in degrees C */
693 boost::optional<double> extremeN20YearsMinDryBulb() const;
694 /** Returns the extreme n=20 years maximum dry bulb temperature in degrees C */
695 boost::optional<double> extremeN20YearsMaxDryBulb() const;
696 /** Returns the extreme n=50 years minimum dry bulb temperature in degrees C */
697 boost::optional<double> extremeN50YearsMinDryBulb() const;
698 /** Returns the extreme n=50 years maximum dry bulb temperature in degrees C */
699 boost::optional<double> extremeN50YearsMaxDryBulb() const;
700
701 ASHRAEHoFVintage ashraeHoFVersion() const;
702
703 protected:
704 void assignHeatingData(std::span<const std::string> stringValues);
705 void assignCoolingData(std::span<const std::string> stringValues);
706 void assignExtremesData(std::span<const std::string> stringValues);
707
708 // Setters
709 void setTitleOfDesignCondition(const std::string& titleOfDesignCondition);
710 bool setHeatingColdestMonth(const std::string& heatingColdestMonth);
711 void setHeatingColdestMonth(int heatingColdestMonth);
712 bool setHeatingDryBulb99pt6(const std::string& heatingDryBulb99pt6);
713 void setHeatingDryBulb99pt6(double heatingDryBulb99pt6);
714 bool setHeatingDryBulb99(const std::string& heatingDryBulb99);
715 void setHeatingDryBulb99(double heatingDryBulb99);
716 bool setHeatingHumidificationDewPoint99pt6(const std::string& heatingHumidificationDewPoint99pt6);
717 void setHeatingHumidificationDewPoint99pt6(double heatingHumidificationDewPoint99pt6);
718 bool setHeatingHumidificationHumidityRatio99pt6(const std::string& heatingHumidificationHumidityRatio99pt6);
719 void setHeatingHumidificationHumidityRatio99pt6(double heatingHumidificationHumidityRatio99pt6);
720 bool setHeatingHumidificationMeanCoincidentDryBulb99pt6(const std::string& heatingHumidificationMeanCoincidentDryBulb99pt6);
721 void setHeatingHumidificationMeanCoincidentDryBulb99pt6(double heatingHumidificationMeanCoincidentDryBulb99pt6);
722 bool setHeatingHumidificationDewPoint99(const std::string& heatingHumidificationDewPoint99);
723 void setHeatingHumidificationDewPoint99(double heatingHumidificationDewPoint99);
724 bool setHeatingHumidificationHumidityRatio99(const std::string& heatingHumidificationHumidityRatio99);
725 void setHeatingHumidificationHumidityRatio99(double heatingHumidificationHumidityRatio99);
726 bool setHeatingHumidificationMeanCoincidentDryBulb99(const std::string& heatingHumidificationMeanCoincidentDryBulb99);
727 void setHeatingHumidificationMeanCoincidentDryBulb99(double heatingHumidificationMeanCoincidentDryBulb99);
728 bool setHeatingColdestMonthWindSpeed0pt4(const std::string& heatingColdestMonthWindSpeed0pt4);
729 void setHeatingColdestMonthWindSpeed0pt4(double heatingColdestMonthWindSpeed0pt4);
730 bool setHeatingColdestMonthMeanCoincidentDryBulb0pt4(const std::string& heatingColdestMonthMeanCoincidentDryBulb0pt4);
731 void setHeatingColdestMonthMeanCoincidentDryBulb0pt4(double heatingColdestMonthMeanCoincidentDryBulb0pt4);
732 bool setHeatingColdestMonthWindSpeed1(const std::string& heatingColdestMonthWindSpeed1);
733 void setHeatingColdestMonthWindSpeed1(double heatingColdestMonthWindSpeed1);
734 bool setHeatingColdestMonthMeanCoincidentDryBulb1(const std::string& heatingColdestMonthMeanCoincidentDryBulb1);
735 void setHeatingColdestMonthMeanCoincidentDryBulb1(double heatingColdestMonthMeanCoincidentDryBulb1);
736 bool setHeatingMeanCoincidentWindSpeed99pt6(const std::string& heatingMeanCoincidentWindSpeed99pt6);
737 void setHeatingMeanCoincidentWindSpeed99pt6(double heatingMeanCoincidentWindSpeed99pt6);
738 bool setHeatingPrevailingCoincidentWindDirection99pt6(const std::string& heatingPrevailingCoincidentWindDirection99pt6);
739 void setHeatingPrevailingCoincidentWindDirection99pt6(int heatingPrevailingCoincidentWindDirection99pt6);
740 bool setHeatingWindShelterFactor(const std::string& heatingWindShelterFactor);
741 void setHeatingWindShelterFactor(double heatingWindShelterFactor);
742
743 bool setCoolingHottestMonth(const std::string& coolingHottestMonth);
744 void setCoolingHottestMonth(int coolingHottestMonth);
745 bool setCoolingDryBulbRange(const std::string& coolingDryBulbRange);
746 void setCoolingDryBulbRange(double coolingDryBulbRange);
747 bool setCoolingDryBulb0pt4(const std::string& coolingDryBulb0pt4);
748 void setCoolingDryBulb0pt4(double coolingDryBulb0pt4);
749 bool setCoolingMeanCoincidentWetBulb0pt4(const std::string& coolingMeanCoincidentWetBulb0pt4);
750 void setCoolingMeanCoincidentWetBulb0pt4(double coolingMeanCoincidentWetBulb0pt4);
751 bool setCoolingDryBulb1(const std::string& coolingDryBulb1);
752 void setCoolingDryBulb1(double coolingDryBulb1);
753 bool setCoolingMeanCoincidentWetBulb1(const std::string& coolingMeanCoincidentWetBulb1);
754 void setCoolingMeanCoincidentWetBulb1(double coolingMeanCoincidentWetBulb1);
755 bool setCoolingDryBulb2(const std::string& coolingDryBulb2);
756 void setCoolingDryBulb2(double coolingDryBulb2);
757 bool setCoolingMeanCoincidentWetBulb2(const std::string& coolingMeanCoincidentWetBulb2);
758 void setCoolingMeanCoincidentWetBulb2(double coolingMeanCoincidentWetBulb2);
759 bool setCoolingEvaporationWetBulb0pt4(const std::string& coolingEvaporationWetBulb0pt4);
760 void setCoolingEvaporationWetBulb0pt4(double coolingEvaporationWetBulb0pt4);
761 bool setCoolingEvaporationMeanCoincidentDryBulb0pt4(const std::string& coolingEvaporationMeanCoincidentDryBulb0pt4);
762 void setCoolingEvaporationMeanCoincidentDryBulb0pt4(double coolingEvaporationMeanCoincidentDryBulb0pt4);
763 bool setCoolingEvaporationWetBulb1(const std::string& coolingEvaporationWetBulb1);
764 void setCoolingEvaporationWetBulb1(double coolingEvaporationWetBulb1);
765 bool setCoolingEvaporationMeanCoincidentDryBulb1(const std::string& coolingEvaporationMeanCoincidentDryBulb1);
766 void setCoolingEvaporationMeanCoincidentDryBulb1(double coolingEvaporationMeanCoincidentDryBulb1);
767 bool setCoolingEvaporationWetBulb2(const std::string& coolingEvaporationWetBulb2);
768 void setCoolingEvaporationWetBulb2(double coolingEvaporationWetBulb2);
769 bool setCoolingEvaporationMeanCoincidentDryBulb2(const std::string& coolingEvaporationMeanCoincidentDryBulb2);
770 void setCoolingEvaporationMeanCoincidentDryBulb2(double coolingEvaporationMeanCoincidentDryBulb2);
771 bool setCoolingMeanCoincidentWindSpeed0pt4(const std::string& coolingMeanCoincidentWindSpeed0pt4);
772 void setCoolingMeanCoincidentWindSpeed0pt4(double coolingMeanCoincidentWindSpeed0pt4);
773 bool setCoolingPrevailingCoincidentWindDirection0pt4(const std::string& coolingPrevailingCoincidentWindDirection0pt4);
774 void setCoolingPrevailingCoincidentWindDirection0pt4(int coolingPrevailingCoincidentWindDirection0pt4);
775 bool setCoolingDehumidificationDewPoint0pt4(const std::string& coolingDehumidificationDewPoint0pt4);
776 void setCoolingDehumidificationDewPoint0pt4(double coolingDehumidificationDewPoint0pt4);
777 bool setCoolingDehumidificationHumidityRatio0pt4(const std::string& coolingDehumidificationHumidityRatio0pt4);
778 void setCoolingDehumidificationHumidityRatio0pt4(double coolingDehumidificationHumidityRatio0pt4);
779 bool setCoolingDehumidificationMeanCoincidentDryBulb0pt4(const std::string& coolingDehumidificationMeanCoincidentDryBulb0pt4);
780 void setCoolingDehumidificationMeanCoincidentDryBulb0pt4(double coolingDehumidificationMeanCoincidentDryBulb0pt4);
781 bool setCoolingDehumidificationDewPoint1(const std::string& coolingDehumidificationDewPoint1);
782 void setCoolingDehumidificationDewPoint1(double coolingDehumidificationDewPoint1);
783 bool setCoolingDehumidificationHumidityRatio1(const std::string& coolingDehumidificationHumidityRatio1);
784 void setCoolingDehumidificationHumidityRatio1(double coolingDehumidificationHumidityRatio1);
785 bool setCoolingDehumidificationMeanCoincidentDryBulb1(const std::string& coolingDehumidificationMeanCoincidentDryBulb1);
786 void setCoolingDehumidificationMeanCoincidentDryBulb1(double coolingDehumidificationMeanCoincidentDryBulb1);
787 bool setCoolingDehumidificationDewPoint2(const std::string& coolingDehumidificationDewPoint2);
788 void setCoolingDehumidificationDewPoint2(double coolingDehumidificationDewPoint2);
789 bool setCoolingDehumidificationHumidityRatio2(const std::string& coolingDehumidificationHumidityRatio2);
790 void setCoolingDehumidificationHumidityRatio2(double coolingDehumidificationHumidityRatio2);
791 bool setCoolingDehumidificationMeanCoincidentDryBulb2(const std::string& coolingDehumidificationMeanCoincidentDryBulb2);
792 void setCoolingDehumidificationMeanCoincidentDryBulb2(double coolingDehumidificationMeanCoincidentDryBulb2);
793 bool setCoolingEnthalpy0pt4(const std::string& coolingEnthalpy0pt4);
794 void setCoolingEnthalpy0pt4(double coolingEnthalpy0pt4);
795 bool setCoolingEnthalpyMeanCoincidentDryBulb0pt4(const std::string& coolingEnthalpyMeanCoincidentDryBulb0pt4);
796 void setCoolingEnthalpyMeanCoincidentDryBulb0pt4(double coolingEnthalpyMeanCoincidentDryBulb0pt4);
797 bool setCoolingEnthalpy1(const std::string& coolingEnthalpy1);
798 void setCoolingEnthalpy1(double coolingEnthalpy1);
799 bool setCoolingEnthalpyMeanCoincidentDryBulb1(const std::string& coolingEnthalpyMeanCoincidentDryBulb1);
800 void setCoolingEnthalpyMeanCoincidentDryBulb1(double coolingEnthalpyMeanCoincidentDryBulb1);
801 bool setCoolingEnthalpy2(const std::string& coolingEnthalpy2);
802 void setCoolingEnthalpy2(double coolingEnthalpy2);
803 bool setCoolingEnthalpyMeanCoincidentDryBulb2(const std::string& coolingEnthalpyMeanCoincidentDryBulb2);
804 void setCoolingEnthalpyMeanCoincidentDryBulb2(double coolingEnthalpyMeanCoincidentDryBulb2);
805 bool setCoolingHours8To4AndDryBulb12pt8To20pt6(const std::string& coolingHours8To4AndDryBulb12pt8To20pt6);
806 void setCoolingHours8To4AndDryBulb12pt8To20pt6(int coolingHours8To4AndDryBulb12pt8To20pt6);
807
808 bool setExtremeWindSpeed1(const std::string& extremeWindSpeed1);
809 void setExtremeWindSpeed1(double extremeWindSpeed1);
810 bool setExtremeWindSpeed2pt5(const std::string& extremeWindSpeed2pt5);
811 void setExtremeWindSpeed2pt5(double extremeWindSpeed2pt5);
812 bool setExtremeWindSpeed5(const std::string& extremeWindSpeed5);
813 void setExtremeWindSpeed5(double extremeWindSpeed5);
814 bool setExtremeMaxWetBulb(const std::string& extremeMaxWetBulb);
815 void setExtremeMaxWetBulb(double extremeMaxWetBulb);
816 bool setExtremeMeanMinDryBulb(const std::string& extremeMeanMinDryBulb);
817 void setExtremeMeanMinDryBulb(double extremeMeanMinDryBulb);
818 bool setExtremeMeanMaxDryBulb(const std::string& extremeMeanMaxDryBulb);
819 void setExtremeMeanMaxDryBulb(double extremeMeanMaxDryBulb);
820 bool setExtremeStdDevMinDryBulb(const std::string& extremeStdDevMinDryBulb);
821 void setExtremeStdDevMinDryBulb(double extremeStdDevMinDryBulb);
822 bool setExtremeStdDevMaxDryBulb(const std::string& extremeStdDevMaxDryBulb);
823 void setExtremeStdDevMaxDryBulb(double extremeStdDevMaxDryBulb);
824 bool setExtremeN5YearsMinDryBulb(const std::string& extremeN5YearsMinDryBulb);
825 void setExtremeN5YearsMinDryBulb(double extremeN5YearsMinDryBulb);
826 bool setExtremeN5YearsMaxDryBulb(const std::string& extremeN5YearsMaxDryBulb);
827 void setExtremeN5YearsMaxDryBulb(double extremeN5YearsMaxDryBulb);
828 bool setExtremeN10YearsMinDryBulb(const std::string& extremeN10YearsMinDryBulb);
829 void setExtremeN10YearsMinDryBulb(double extremeN10YearsMinDryBulb);
830 bool setExtremeN10YearsMaxDryBulb(const std::string& extremeN10YearsMaxDryBulb);
831 void setExtremeN10YearsMaxDryBulb(double extremeN10YearsMaxDryBulb);
832 bool setExtremeN20YearsMinDryBulb(const std::string& extremeN20YearsMinDryBulb);
833 void setExtremeN20YearsMinDryBulb(double extremeN20YearsMinDryBulb);
834 bool setExtremeN20YearsMaxDryBulb(const std::string& extremeN20YearsMaxDryBulb);
835 void setExtremeN20YearsMaxDryBulb(double extremeN20YearsMaxDryBulb);
836 bool setExtremeN50YearsMinDryBulb(const std::string& extremeN50YearsMinDryBulb);
837 void setExtremeN50YearsMinDryBulb(double extremeN50YearsMinDryBulb);
838 bool setExtremeN50YearsMaxDryBulb(const std::string& extremeN50YearsMaxDryBulb);
839 void setExtremeN50YearsMaxDryBulb(double extremeN50YearsMaxDryBulb);
840
841 private:
842 ASHRAEHoFVintage m_ashraeHoFVersion = ASHRAEHoFVintage::ASHRAE_2009;
843
844 std::string m_titleOfDesignCondition;
845 boost::optional<int> m_heatingColdestMonth;
846 boost::optional<double> m_heatingDryBulb99pt6;
847 boost::optional<double> m_heatingDryBulb99;
848 boost::optional<double> m_heatingHumidificationDewPoint99pt6;
849 boost::optional<double> m_heatingHumidificationHumidityRatio99pt6;
850 boost::optional<double> m_heatingHumidificationMeanCoincidentDryBulb99pt6;
851 boost::optional<double> m_heatingHumidificationDewPoint99;
852 boost::optional<double> m_heatingHumidificationHumidityRatio99;
853 boost::optional<double> m_heatingHumidificationMeanCoincidentDryBulb99;
854 boost::optional<double> m_heatingColdestMonthWindSpeed0pt4;
855 boost::optional<double> m_heatingColdestMonthMeanCoincidentDryBulb0pt4;
856 boost::optional<double> m_heatingColdestMonthWindSpeed1;
857 boost::optional<double> m_heatingColdestMonthMeanCoincidentDryBulb1;
858 boost::optional<double> m_heatingMeanCoincidentWindSpeed99pt6;
859 boost::optional<int> m_heatingPrevailingCoincidentWindDirection99pt6;
860 boost::optional<double> m_heatingWindShelterFactor;
861
862 boost::optional<int> m_coolingHottestMonth;
863 boost::optional<double> m_coolingDryBulbRange;
864 boost::optional<double> m_coolingDryBulb0pt4;
865 boost::optional<double> m_coolingMeanCoincidentWetBulb0pt4;
866 boost::optional<double> m_coolingDryBulb1;
867 boost::optional<double> m_coolingMeanCoincidentWetBulb1;
868 boost::optional<double> m_coolingDryBulb2;
869 boost::optional<double> m_coolingMeanCoincidentWetBulb2;
870 boost::optional<double> m_coolingEvaporationWetBulb0pt4;
871 boost::optional<double> m_coolingEvaporationMeanCoincidentDryBulb0pt4;
872 boost::optional<double> m_coolingEvaporationWetBulb1;
873 boost::optional<double> m_coolingEvaporationMeanCoincidentDryBulb1;
874 boost::optional<double> m_coolingEvaporationWetBulb2;
875 boost::optional<double> m_coolingEvaporationMeanCoincidentDryBulb2;
876 boost::optional<double> m_coolingMeanCoincidentWindSpeed0pt4;
877 boost::optional<int> m_coolingPrevailingCoincidentWindDirection0pt4;
878 boost::optional<double> m_coolingDehumidificationDewPoint0pt4;
879 boost::optional<double> m_coolingDehumidificationHumidityRatio0pt4;
880 boost::optional<double> m_coolingDehumidificationMeanCoincidentDryBulb0pt4;
881 boost::optional<double> m_coolingDehumidificationDewPoint1;
882 boost::optional<double> m_coolingDehumidificationHumidityRatio1;
883 boost::optional<double> m_coolingDehumidificationMeanCoincidentDryBulb1;
884 boost::optional<double> m_coolingDehumidificationDewPoint2;
885 boost::optional<double> m_coolingDehumidificationHumidityRatio2;
886 boost::optional<double> m_coolingDehumidificationMeanCoincidentDryBulb2;
887 boost::optional<double> m_coolingEnthalpy0pt4;
888 boost::optional<double> m_coolingEnthalpyMeanCoincidentDryBulb0pt4;
889 boost::optional<double> m_coolingEnthalpy1;
890 boost::optional<double> m_coolingEnthalpyMeanCoincidentDryBulb1;
891 boost::optional<double> m_coolingEnthalpy2;
892 boost::optional<double> m_coolingEnthalpyMeanCoincidentDryBulb2;
893 boost::optional<int> m_coolingHours8To4AndDryBulb12pt8To20pt6;
894
895 boost::optional<double> m_extremeWindSpeed1;
896 boost::optional<double> m_extremeWindSpeed2pt5;
897 boost::optional<double> m_extremeWindSpeed5;
898 boost::optional<double> m_extremeMaxWetBulb; // This also stores CoolingExtremeMaxWetBulb for versions starting at 2017
899 boost::optional<double> m_extremeMeanMinDryBulb;
900 boost::optional<double> m_extremeMeanMaxDryBulb;
901 boost::optional<double> m_extremeStdDevMinDryBulb;
902 boost::optional<double> m_extremeStdDevMaxDryBulb;
903 boost::optional<double> m_extremeN5YearsMinDryBulb;
904 boost::optional<double> m_extremeN5YearsMaxDryBulb;
905 boost::optional<double> m_extremeN10YearsMinDryBulb;
906 boost::optional<double> m_extremeN10YearsMaxDryBulb;
907 boost::optional<double> m_extremeN20YearsMinDryBulb;
908 boost::optional<double> m_extremeN20YearsMaxDryBulb;
909 boost::optional<double> m_extremeN50YearsMinDryBulb;
910 boost::optional<double> m_extremeN50YearsMaxDryBulb;
911 };
912
913 /** EpwGroundTemperatureDepth is one line from the EPW file. All floating point numbers are stored as strings,
914 * but are checked as numbers.
915 */
916 class UTILITIES_API EpwGroundTemperatureDepth
917 {
918 public:
919 /** Create an empty EpwGroundTemperatureDepth object */
920 156 EpwGroundTemperatureDepth() = default;
921 /** Create an EpwGroundTemperatureDepth object with specified properties */
922 EpwGroundTemperatureDepth(double groundTemperatureDepth, double janGroundTemperature, double febGroundTemperature, double marGroundTemperature,
923 double aprGroundTemperature, double mayGroundTemperature, double junGroundTemperature, double julGroundTemperature,
924 double augGroundTemperature, double sepGroundTemperature, double octGroundTemperature, double novGroundTemperature,
925 double decGroundTemperature,
926 // Optional parameters
927 boost::optional<double> soilConductivity_ = boost::none, boost::optional<double> soilDensity_ = boost::none,
928 boost::optional<double> soilSpecificHeat_ = boost::none);
929 // Static
930 /** Returns the units of the named field */
931 static boost::optional<std::string> getUnitsByName(const std::string& name);
932 /** Returns the units of the field specified by enumeration value */
933 static std::string getUnits(EpwDepthField field);
934 // Data retrieval
935 /** Returns the double value of the named field if possible */
936 boost::optional<double> getFieldByName(const std::string& name) const;
937 /** Returns the dobule value of the field specified by enumeration value */
938 boost::optional<double> getField(EpwDepthField id) const;
939 // Conversion
940 /** Create an EpwGroundTemperatureDepth from an EPW-formatted string */
941 static boost::optional<EpwGroundTemperatureDepth> fromGroundTemperatureDepthsString(const std::string& line);
942 /** Create an EpwGroundTemperatureDepth from a list of EPW depths as strings */
943 static boost::optional<EpwGroundTemperatureDepth> fromGroundTemperatureDepthsStrings(const std::vector<std::string>& strings);
944 // Getters
945 /** Returns the depth of ground temperature in m*/
946 double groundTemperatureDepth() const;
947 /** Returns the soil conductivity in W/m-K*/
948 boost::optional<double> soilConductivity() const;
949 /** Returns the soil density in kg/m3*/
950 boost::optional<double> soilDensity() const;
951 /** Returns the soil specific heat in J/kg-K*/
952 boost::optional<double> soilSpecificHeat() const;
953 /** Returns the Jan undisturbed ground temperature in degrees C*/
954 double janGroundTemperature() const;
955 /** Returns the Feb undisturbed ground temperature in degrees C*/
956 double febGroundTemperature() const;
957 /** Returns the Mar undisturbed ground temperature in degrees C*/
958 double marGroundTemperature() const;
959 /** Returns the Apr undisturbed ground temperature in degrees C*/
960 double aprGroundTemperature() const;
961 /** Returns the May undisturbed ground temperature in degrees C*/
962 double mayGroundTemperature() const;
963 /** Returns the Jun undisturbed ground temperature in degrees C*/
964 double junGroundTemperature() const;
965 /** Returns the Jul undisturbed ground temperature in degrees C*/
966 double julGroundTemperature() const;
967 /** Returns the Aug undisturbed ground temperature in degrees C*/
968 double augGroundTemperature() const;
969 /** Returns the Sep undisturbed ground temperature in degrees C*/
970 double sepGroundTemperature() const;
971 /** Returns the Oct undisturbed ground temperature in degrees C*/
972 double octGroundTemperature() const;
973 /** Returns the Nov undisturbed ground temperature in degrees C*/
974 double novGroundTemperature() const;
975 /** Returns the Dec undisturbed ground temperature in degrees C*/
976 double decGroundTemperature() const;
977
978 private:
979 // Setters
980 void setGroundTemperatureDepth(double groundTemperatureDepth);
981 void setSoilConductivity(double soilConductivity);
982 void setSoilDensity(double soilDensity);
983 void setSoilSpecificHeat(double soilSpecificHeat);
984 void setJanGroundTemperature(double janGroundTemperature);
985 void setFebGroundTemperature(double febGroundTemperature);
986 void setMarGroundTemperature(double marGroundTemperature);
987 void setAprGroundTemperature(double aprGroundTemperature);
988 void setMayGroundTemperature(double mayGroundTemperature);
989 void setJunGroundTemperature(double junGroundTemperature);
990 void setJulGroundTemperature(double julGroundTemperature);
991 void setAugGroundTemperature(double augGroundTemperature);
992 void setSepGroundTemperature(double sepGroundTemperature);
993 void setOctGroundTemperature(double octGroundTemperature);
994 void setNovGroundTemperature(double novGroundTemperature);
995 void setDecGroundTemperature(double decGroundTemperature);
996 bool setGroundTemperatureDepth(const std::string& groundTemperatureDepth);
997 bool setSoilConductivity(const std::string& soilConductivity);
998 bool setSoilDensity(const std::string& soilDensity);
999 bool setSoilSpecificHeat(const std::string& soilSpecificHeat);
1000 bool setJanGroundTemperature(const std::string& janGroundTemperature);
1001 bool setFebGroundTemperature(const std::string& febGroundTemperature);
1002 bool setMarGroundTemperature(const std::string& marGroundTemperature);
1003 bool setAprGroundTemperature(const std::string& aprGroundTemperature);
1004 bool setMayGroundTemperature(const std::string& mayGroundTemperature);
1005 bool setJunGroundTemperature(const std::string& junGroundTemperature);
1006 bool setJulGroundTemperature(const std::string& julGroundTemperature);
1007 bool setAugGroundTemperature(const std::string& augGroundTemperature);
1008 bool setSepGroundTemperature(const std::string& sepGroundTemperature);
1009 bool setOctGroundTemperature(const std::string& octGroundTemperature);
1010 bool setNovGroundTemperature(const std::string& novGroundTemperature);
1011 bool setDecGroundTemperature(const std::string& decGroundTemperature);
1012
1013 double m_groundTemperatureDepth = -9999;
1014 boost::optional<double> m_soilConductivity_;
1015 boost::optional<double> m_soilDensity_;
1016 boost::optional<double> m_soilSpecificHeat_;
1017 double m_janGroundTemperature = -9999;
1018 double m_febGroundTemperature = -9999;
1019 double m_marGroundTemperature = -9999;
1020 double m_aprGroundTemperature = -9999;
1021 double m_mayGroundTemperature = -9999;
1022 double m_junGroundTemperature = -9999;
1023 double m_julGroundTemperature = -9999;
1024 double m_augGroundTemperature = -9999;
1025 double m_sepGroundTemperature = -9999;
1026 double m_octGroundTemperature = -9999;
1027 double m_novGroundTemperature = -9999;
1028 double m_decGroundTemperature = -9999;
1029 };
1030
1031 /** EpwFile parses a weather file in EPW format. Later it may provide
1032 * methods for writing and converting other weather files to EPW format.
1033 */
1034 class UTILITIES_API EpwFile
1035 {
1036 public:
1037 /// constructor with path
1038 /// will throw if path does not exist or file is incorrect
1039 EpwFile(const openstudio::path& p, bool storeData = false);
1040
1041 /// static load method
1042 static boost::optional<EpwFile> load(const openstudio::path& p, bool storeData = false);
1043
1044 /// static load method
1045 static boost::optional<EpwFile> loadFromString(const std::string& str, bool storeData = false);
1046
1047 /// get the path
1048 openstudio::path path() const;
1049
1050 /// get the file's checksum
1051 std::string checksum() const;
1052
1053 /// get the city
1054 std::string city() const;
1055
1056 /// get the state, province, or region
1057 std::string stateProvinceRegion() const;
1058
1059 /// get the country
1060 std::string country() const;
1061
1062 /// get the data source
1063 std::string dataSource() const;
1064
1065 /// get the WMO number
1066 std::string wmoNumber() const;
1067
1068 /// get the latitude in degrees
1069 double latitude() const;
1070
1071 /// get the longitude in degrees
1072 double longitude() const;
1073
1074 /// get the time zone relative to GMT
1075 double timeZone() const;
1076
1077 /// get the elevation
1078 double elevation() const;
1079
1080 /// get the time step
1081 Time timeStep() const;
1082
1083 /// get the records per hour
1084 int recordsPerHour() const;
1085
1086 /// get the start day of the week
1087 DayOfWeek startDayOfWeek() const;
1088
1089 /// get the start date
1090 Date startDate() const;
1091
1092 /// get the end date
1093 Date endDate() const;
1094
1095 /// get the actual year of the start date if there is one
1096 boost::optional<int> startDateActualYear() const;
1097
1098 /// get the actual year of the end date if there is one
1099 boost::optional<int> endDateActualYear() const;
1100
1101 /// get the weather data
1102 std::vector<EpwDataPoint> data();
1103
1104 /// get the design conditions
1105 std::vector<EpwDesignCondition> designConditions();
1106
1107 /// get the ground temperature depths
1108 std::vector<EpwGroundTemperatureDepth> groundTemperatureDepths();
1109
1110 /// get a time series of a particular weather field
1111 // This will probably need to include the period at some point, but for now just dump everything into a time series
1112 boost::optional<TimeSeries> getTimeSeries(const std::string& field);
1113 /// get a time series of a computed quantity
1114 boost::optional<TimeSeries> getComputedTimeSeries(const std::string& field);
1115
1116 /// export to CONTAM WTH file
1117 bool translateToWth(openstudio::path path, std::string description = std::string());
1118 /// export to Modelica (.mos) weather file
1119 bool translateToMos(const openstudio::path& path);
1120
1121 // Data status (?) functions
1122 /// Returns true if the file appears to be AMY (as opposed to TMY)
1123 bool isActual() const;
1124 /// Returns true if the data period "records per hour" input matches the data point values
1125 bool minutesMatch() const;
1126
1127 boost::optional<Date> daylightSavingStartDate() const;
1128 boost::optional<Date> daylightSavingEndDate() const;
1129 std::vector<EpwHoliday> holidays() const;
1130
1131 protected:
1132 EpwFile();
1133 bool parse(std::istream& is, bool storeData = false);
1134 bool parseLocation(const std::string& line);
1135 bool parseDesignConditions(const std::string& line);
1136 bool parseDataPeriod(const std::string& line);
1137 bool parseHolidaysDaylightSavings(const std::string& line);
1138 bool parseGroundTemperatures(const std::string& line);
1139
1140 private:
1141 // configure logging
1142 − REGISTER_LOGGER("openstudio.EpwFile");
1143
1144 openstudio::path m_path;
1145 std::string m_checksum;
1146 std::string m_city;
1147 std::string m_stateProvinceRegion;
1148 std::string m_country;
1149 std::string m_dataSource;
1150 std::string m_wmoNumber;
1151 double m_latitude;
1152 double m_longitude;
1153 double m_timeZone;
1154 double m_elevation;
1155 int m_recordsPerHour;
1156 DayOfWeek m_startDayOfWeek;
1157 Date m_startDate;
1158 Date m_endDate;
1159 boost::optional<int> m_startDateActualYear;
1160 boost::optional<int> m_endDateActualYear;
1161 std::vector<EpwDataPoint> m_data;
1162 std::vector<EpwDesignCondition> m_designs;
1163 std::vector<EpwGroundTemperatureDepth> m_depths;
1164
1165 bool m_leapYearObserved;
1166 boost::optional<Date> m_daylightSavingStartDate;
1167 boost::optional<Date> m_daylightSavingEndDate;
1168 std::vector<EpwHoliday> m_holidays;
1169
1170 bool m_isActual;
1171
1172 // Error/warning flags to store how well the input matches what we think it should
1173 bool m_minutesMatch; // No disagreement between the data period and the minutes field
1174 };
1175
1176 UTILITIES_API IdfObject toIdfObject(const EpwFile& epwFile);
1177
1178 } // namespace openstudio
1179
1180 #endif //UTILITIES_FILETYPES_EPWFILE_HPP
1181