GCC Code Coverage Report


Directory: ./
Coverage: low: ≥ 0% medium: ≥ 75.0% high: ≥ 90.0%
Coverage Exec / Excl / Total
Lines: 60.0% 3 / 0 / 5
Functions: 60.0% 3 / 0 / 5
Branches: -% 0 / 0 / 0

src/model/Facility.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 MODEL_FACILITY_HPP
7 #define MODEL_FACILITY_HPP
8
9 #include "ModelAPI.hpp"
10 #include "ParentObject.hpp"
11
12 #include "../utilities/data/DataEnums.hpp"
13 #include "../utilities/core/Deprecated.hpp"
14
15 namespace openstudio {
16
17 class CalibrationResult;
18 class EndUses;
19
20 namespace model {
21
22 class Building;
23 class OutputMeter;
24 class ExteriorLights;
25 class ExteriorFuelEquipment;
26 class ExteriorWaterEquipment;
27
28 namespace detail {
29
30 class Facility_Impl;
31
32 } // namespace detail
33
34 /** Facility derives from ParentObject and is an interface to the OpenStudio IDD object named "OS:Facility".
35 *
36 * Facility is a unique object which parents the Building in the model. Conceptually,
37 * the Facility object includes the Building as well as exterior equipment,
38 * parking lot lighting, water systems for grounds, etc. The Facility object currently does not
39 * have any fields, it is simply used to access \link OutputMeter OutputMeters \endlink and high level results
40 * which include exterior end uses. Facility does not have a public constructor because it is a unique ModelObject.
41 * To get the Facility object for a Model or create one if it does not yet exist use model.getUniqueObject<Facility>().
42 * To get the Facility object for a Model but not create one if it does not yet exist use model.getOptionalUniqueObject<Facility>().
43 */
44 class MODEL_API Facility : public ParentObject
45 {
46
47 public:
48 479 virtual ~Facility() override = default;
49 // Default the copy and move operators because the virtual dtor is explicit
50 45 Facility(const Facility& other) = default;
51 54 Facility(Facility&& other) = default;
52 ✗ Facility& operator=(const Facility&) = default;
53 ✗ Facility& operator=(Facility&&) = default;
54
55 static IddObjectType iddObjectType();
56
57 /// Returns all FuelTypes which are fossil fuels.
58 static std::vector<FuelType> fossilFuels();
59
60 /** @name Getters */
61 //@{
62
63 //@}
64 /** @name Setters */
65 //@{
66
67 //@}
68 /** @name Children */
69 //@{
70
71 /// Returns the child Building.
72 boost::optional<Building> building() const;
73
74 /// Returns all \link OutputMeter OutputMeters \endlink at the Facility level.
75 std::vector<OutputMeter> meters() const;
76
77 boost::optional<OutputMeter> getMeterByFuelType(const FuelType& fuelType, const std::string& reportingFrequency = "Hourly",
78 const boost::optional<EndUseType>& endUseType = boost::none,
79 const boost::optional<std::string>& specificEndUse = boost::none) const;
80
81 /// Returns all ExteriorLights.
82 std::vector<ExteriorLights> exteriorLights() const;
83
84 /// Returns all ExteriorFuelEquipment.
85 std::vector<ExteriorFuelEquipment> exteriorFuelEquipments() const;
86
87 /// Returns all ExteriorWaterEquipment.
88 std::vector<ExteriorWaterEquipment> exteriorWaterEquipments() const;
89
90 //@}
91 /** @name Other */
92 //@{
93
94 /// Returns the total site energy in gigajoules. Requires EnergyPlus simulation output to calculate.
95 boost::optional<double> totalSiteEnergy() const;
96
97 /// Returns the net site energy in gigajoules. Requires EnergyPlus simulation output to calculate.
98 boost::optional<double> netSiteEnergy() const;
99
100 /// Returns the total source energy in gigajoules. Requires EnergyPlus simulation output to calculate.
101 boost::optional<double> totalSourceEnergy() const;
102
103 /// Returns the net source energy in gigajoules. Requires EnergyPlus simulation output to calculate.
104 boost::optional<double> netSourceEnergy() const;
105
106 /// Returns the annual total cost associated with the given fuel type in dollars.
107 /// Requires EnergyPlus simulation output to calculate.
108 boost::optional<double> annualTotalCost(const FuelType& fuel) const;
109
110 /// Returns the annual total cost per total building area associated with the given fuel type in dollars per square meter.
111 /// Requires EnergyPlus simulation output to calculate.
112 boost::optional<double> annualTotalCostPerBldgArea(const FuelType& fuel) const;
113
114 /// Returns the annual total cost per net conditioned building area associated with the given fuel type in dollars per square meter.
115 /// Requires EnergyPlus simulation output to calculate.
116 boost::optional<double> annualTotalCostPerNetConditionedBldgArea(const FuelType& fuel) const;
117
118 /// Returns the annual total cost for all fuel types in dollars. Requires EnergyPlus simulation output to calculate.
119 boost::optional<double> annualTotalUtilityCost() const;
120
121 /// Returns the annual electric total cost in dollars. Requires EnergyPlus simulation output to calculate.
122 boost::optional<double> annualElectricTotalCost() const;
123
124 /// Returns the annual gas total cost in dollars. Requires EnergyPlus simulation output to calculate.
125 boost::optional<double> annualGasTotalCost() const;
126
127 /// Returns the annual district cooling total cost in dollars. Requires EnergyPlus simulation output to calculate.
128 boost::optional<double> annualDistrictCoolingTotalCost() const;
129
130 /// Returns the annual district heating total cost in dollars. Requires EnergyPlus simulation output to calculate.
131 boost::optional<double> annualDistrictHeatingTotalCost() const;
132
133 /// Returns the annual water total cost in dollars. Requires EnergyPlus simulation output to calculate.
134 boost::optional<double> annualWaterTotalCost() const;
135
136 /// Returns the total capital cost associated with the building in dollars by summing all costs from all
137 /// ComponentCost_LineItem objects. Requires EnergyPlus simulation output and LifeCycleCost_Parameters input object to calculate.
138 /// \todo: only ComponentCost_LineItem of line item type "Construction" are currently handled
139 /// \todo: this should not require life cycle parameters to calculate
140 boost::optional<double> economicsCapitalCost() const;
141
142 /// Returns the total energy cost over the analysis period in dollars according to the discounting convention.
143 /// Requires EnergyPlus simulation output and LifeCycleCost_Parameters input object to calculate.
144 boost::optional<double> economicsEnergyCost() const;
145
146 /// Returns the total life cycle cost over the analysis period in dollars according to the discounting convention.
147 /// Requires EnergyPlus simulation output and LifeCycleCost_Parameters input object to calculate.
148 boost::optional<double> economicsTLCC() const;
149
150 /// Returns the virtual rate of gas energy in dollars per gigajoule.
151 /// Requires EnergyPlus simulation output and LifeCycleCost_Parameters input object to calculate.
152 boost::optional<double> economicsVirtualRateGas() const;
153
154 /// Returns the virtual rate of electric energy in dollars per gigajoule.
155 /// Requires EnergyPlus simulation output and LifeCycleCost_Parameters input object to calculate.
156 boost::optional<double> economicsVirtualRateElec() const;
157
158 /// Returns the virtual rate of all energy in dollars per gigajoule.
159 /// Requires EnergyPlus simulation output and LifeCycleCost_Parameters input object to calculate.
160 boost::optional<double> economicsVirtualRateCombined() const;
161
162 /// Returns the simple payback period in years.
163 /// Requires EnergyPlus simulation output and LifeCycleCost_Parameters input object to calculate.
164 boost::optional<double> economicsSPB() const;
165
166 /// Returns the discounted payback period in years.
167 /// Requires EnergyPlus simulation output and LifeCycleCost_Parameters input object to calculate.
168 boost::optional<double> economicsDPB() const;
169
170 /// Returns the net present value in dollars.
171 /// Requires EnergyPlus simulation output and LifeCycleCost_Parameters input object to calculate.
172 boost::optional<double> economicsNPV() const;
173
174 /// Returns the internal rate of return as a fractional rate (e.g. 5% = 0.05).
175 /// Requires EnergyPlus simulation output and LifeCycleCost_Parameters input object to calculate.
176 boost::optional<double> economicsIRR() const;
177
178 /// Returns the electric energy used for heating in gigajoules.
179 /// Requires EnergyPlus simulation output to calculate.
180 boost::optional<double> electricityHeating() const;
181
182 /// Returns the electric energy used for cooling in gigajoules.
183 /// Requires EnergyPlus simulation output to calculate.
184 boost::optional<double> electricityCooling() const;
185
186 /// Returns the electric energy used for interior lighting in gigajoules.
187 /// Requires EnergyPlus simulation output to calculate.
188 boost::optional<double> electricityInteriorLighting() const;
189
190 /// Returns the electric energy used for exterior lighting in gigajoules.
191 /// Requires EnergyPlus simulation output to calculate.
192 boost::optional<double> electricityExteriorLighting() const;
193
194 /// Returns the electric energy used for interior equipment in gigajoules.
195 /// Requires EnergyPlus simulation output to calculate.
196 boost::optional<double> electricityInteriorEquipment() const;
197
198 /// Returns the electric energy used for exterior equipment in gigajoules.
199 /// Requires EnergyPlus simulation output to calculate.
200 boost::optional<double> electricityExteriorEquipment() const;
201
202 /// Returns the electric energy used for fans in gigajoules.
203 /// Requires EnergyPlus simulation output to calculate.
204 boost::optional<double> electricityFans() const;
205
206 /// Returns the electric energy used for pumps in gigajoules.
207 /// Requires EnergyPlus simulation output to calculate.
208 boost::optional<double> electricityPumps() const;
209
210 /// Returns the electric energy used for heat rejection in gigajoules.
211 /// Requires EnergyPlus simulation output to calculate.
212 boost::optional<double> electricityHeatRejection() const;
213
214 /// Returns the electric energy used for humidification in gigajoules.
215 /// Requires EnergyPlus simulation output to calculate.
216 boost::optional<double> electricityHumidification() const;
217
218 /// Returns the electric energy used for heat recovery in gigajoules.
219 /// Requires EnergyPlus simulation output to calculate.
220 boost::optional<double> electricityHeatRecovery() const;
221
222 /// Returns the electric energy used for water systems in gigajoules.
223 /// Requires EnergyPlus simulation output to calculate.
224 boost::optional<double> electricityWaterSystems() const;
225
226 /// Returns the electric energy used for refrigeration in gigajoules.
227 /// Requires EnergyPlus simulation output to calculate.
228 boost::optional<double> electricityRefrigeration() const;
229
230 /// Returns the electric energy used for generators in gigajoules.
231 /// Requires EnergyPlus simulation output to calculate.
232 boost::optional<double> electricityGenerators() const;
233
234 /// Returns the electric energy used for all uses in gigajoules.
235 /// Requires EnergyPlus simulation output to calculate.
236 boost::optional<double> electricityTotalEndUses() const;
237
238 /// Returns the natural gas energy used for heating in gigajoules.
239 /// Requires EnergyPlus simulation output to calculate.
240 boost::optional<double> naturalGasHeating() const;
241
242 /// Returns the natural gas energy used for cooling in gigajoules.
243 /// Requires EnergyPlus simulation output to calculate.
244 boost::optional<double> naturalGasCooling() const;
245
246 /// Returns the natural gas energy used for interior lighting in gigajoules.
247 /// Requires EnergyPlus simulation output to calculate.
248 boost::optional<double> naturalGasInteriorLighting() const;
249
250 /// Returns the natural gas energy used for exterior lighting in gigajoules.
251 /// Requires EnergyPlus simulation output to calculate.
252 boost::optional<double> naturalGasExteriorLighting() const;
253
254 /// Returns the natural gas energy used for interior equipment in gigajoules.
255 /// Requires EnergyPlus simulation output to calculate.
256 boost::optional<double> naturalGasInteriorEquipment() const;
257
258 /// Returns the natural gas energy used for exterior equipment in gigajoules.
259 /// Requires EnergyPlus simulation output to calculate.
260 boost::optional<double> naturalGasExteriorEquipment() const;
261
262 /// Returns the natural gas energy used for fans in gigajoules.
263 /// Requires EnergyPlus simulation output to calculate.
264 boost::optional<double> naturalGasFans() const;
265
266 /// Returns the natural gas energy used for pumps in gigajoules.
267 /// Requires EnergyPlus simulation output to calculate.
268 boost::optional<double> naturalGasPumps() const;
269
270 /// Returns the natural gas energy used for heat rejection in gigajoules.
271 /// Requires EnergyPlus simulation output to calculate.
272 boost::optional<double> naturalGasHeatRejection() const;
273
274 /// Returns the natural gas energy used for humidification in gigajoules.
275 /// Requires EnergyPlus simulation output to calculate.
276 boost::optional<double> naturalGasHumidification() const;
277
278 /// Returns the natural gas energy used for heat recovery in gigajoules.
279 /// Requires EnergyPlus simulation output to calculate.
280 boost::optional<double> naturalGasHeatRecovery() const;
281
282 /// Returns the natural gas energy used for water systems in gigajoules.
283 /// Requires EnergyPlus simulation output to calculate.
284 boost::optional<double> naturalGasWaterSystems() const;
285
286 /// Returns the natural gas energy used for refrigeration in gigajoules.
287 /// Requires EnergyPlus simulation output to calculate.
288 boost::optional<double> naturalGasRefrigeration() const;
289
290 /// Returns the natural gas energy used for generators in gigajoules.
291 /// Requires EnergyPlus simulation output to calculate.
292 boost::optional<double> naturalGasGenerators() const;
293
294 /// Returns the natural gas energy used for all end uses in gigajoules.
295 /// Requires EnergyPlus simulation output to calculate.
296 boost::optional<double> naturalGasTotalEndUses() const;
297
298 /// Gasoline
299 /// Returns the energy used for heating from gasoline in gigajoules.
300 /// Requires EnergyPlus simulation output to calculate.
301 boost::optional<double> gasolineHeating() const;
302
303 /// Returns the energy used for cooling from gasoline in gigajoules.
304 /// Requires EnergyPlus simulation output to calculate.
305 boost::optional<double> gasolineCooling() const;
306
307 /// Returns the energy used for interior lighting from gasoline in gigajoules.
308 /// Requires EnergyPlus simulation output to calculate.
309 boost::optional<double> gasolineInteriorLighting() const;
310
311 /// Returns the energy used for exterior lighting from gasoline in gigajoules.
312 /// Requires EnergyPlus simulation output to calculate.
313 boost::optional<double> gasolineExteriorLighting() const;
314
315 /// Returns the energy used for interior equipment from gasoline in gigajoules.
316 /// Requires EnergyPlus simulation output to calculate.
317 boost::optional<double> gasolineInteriorEquipment() const;
318
319 /// Returns the energy used for exterior equipment from gasoline in gigajoules.
320 /// Requires EnergyPlus simulation output to calculate.
321 boost::optional<double> gasolineExteriorEquipment() const;
322
323 /// Returns the energy used for fans from gasoline in gigajoules.
324 /// Requires EnergyPlus simulation output to calculate.
325 boost::optional<double> gasolineFans() const;
326
327 /// Returns the energy used for pumps from gasoline in gigajoules.
328 /// Requires EnergyPlus simulation output to calculate.
329 boost::optional<double> gasolinePumps() const;
330
331 /// Returns the energy used for heat rejection from gasoline in gigajoules.
332 /// Requires EnergyPlus simulation output to calculate.
333 boost::optional<double> gasolineHeatRejection() const;
334
335 /// Returns the energy used for humidification from gasoline in gigajoules.
336 /// Requires EnergyPlus simulation output to calculate.
337 boost::optional<double> gasolineHumidification() const;
338
339 /// Returns the energy used for heat recovery from gasoline in gigajoules.
340 /// Requires EnergyPlus simulation output to calculate.
341 boost::optional<double> gasolineHeatRecovery() const;
342
343 /// Returns the energy used for water systems from gasoline in gigajoules.
344 /// Requires EnergyPlus simulation output to calculate.
345 boost::optional<double> gasolineWaterSystems() const;
346
347 /// Returns the energy used for refrigeration from gasoline in gigajoules.
348 /// Requires EnergyPlus simulation output to calculate.
349 boost::optional<double> gasolineRefrigeration() const;
350
351 /// Returns the energy used for generators from gasoline in gigajoules.
352 /// Requires EnergyPlus simulation output to calculate.
353 boost::optional<double> gasolineGenerators() const;
354
355 /// Returns the energy used for all end uses from gasoline in gigajoules.
356 /// Requires EnergyPlus simulation output to calculate.
357 boost::optional<double> gasolineTotalEndUses() const;
358
359 /// Diesel
360 /// Returns the energy used for heating from diesel in gigajoules.
361 /// Requires EnergyPlus simulation output to calculate.
362 boost::optional<double> dieselHeating() const;
363
364 /// Returns the energy used for cooling from diesel in gigajoules.
365 /// Requires EnergyPlus simulation output to calculate.
366 boost::optional<double> dieselCooling() const;
367
368 /// Returns the energy used for interior lighting from diesel in gigajoules.
369 /// Requires EnergyPlus simulation output to calculate.
370 boost::optional<double> dieselInteriorLighting() const;
371
372 /// Returns the energy used for exterior lighting from diesel in gigajoules.
373 /// Requires EnergyPlus simulation output to calculate.
374 boost::optional<double> dieselExteriorLighting() const;
375
376 /// Returns the energy used for interior equipment from diesel in gigajoules.
377 /// Requires EnergyPlus simulation output to calculate.
378 boost::optional<double> dieselInteriorEquipment() const;
379
380 /// Returns the energy used for exterior equipment from diesel in gigajoules.
381 /// Requires EnergyPlus simulation output to calculate.
382 boost::optional<double> dieselExteriorEquipment() const;
383
384 /// Returns the energy used for fans from diesel in gigajoules.
385 /// Requires EnergyPlus simulation output to calculate.
386 boost::optional<double> dieselFans() const;
387
388 /// Returns the energy used for pumps from diesel in gigajoules.
389 /// Requires EnergyPlus simulation output to calculate.
390 boost::optional<double> dieselPumps() const;
391
392 /// Returns the energy used for heat rejection from diesel in gigajoules.
393 /// Requires EnergyPlus simulation output to calculate.
394 boost::optional<double> dieselHeatRejection() const;
395
396 /// Returns the energy used for humidification from diesel in gigajoules.
397 /// Requires EnergyPlus simulation output to calculate.
398 boost::optional<double> dieselHumidification() const;
399
400 /// Returns the energy used for heat recovery from diesel in gigajoules.
401 /// Requires EnergyPlus simulation output to calculate.
402 boost::optional<double> dieselHeatRecovery() const;
403
404 /// Returns the energy used for water systems from diesel in gigajoules.
405 /// Requires EnergyPlus simulation output to calculate.
406 boost::optional<double> dieselWaterSystems() const;
407
408 /// Returns the energy used for refrigeration from diesel in gigajoules.
409 /// Requires EnergyPlus simulation output to calculate.
410 boost::optional<double> dieselRefrigeration() const;
411
412 /// Returns the energy used for generators from diesel in gigajoules.
413 /// Requires EnergyPlus simulation output to calculate.
414 boost::optional<double> dieselGenerators() const;
415
416 /// Returns the energy used for all end uses from diesel in gigajoules.
417 /// Requires EnergyPlus simulation output to calculate.
418 boost::optional<double> dieselTotalEndUses() const;
419
420 /// Coal
421 /// Returns the energy used for heating from coal in gigajoules.
422 /// Requires EnergyPlus simulation output to calculate.
423 boost::optional<double> coalHeating() const;
424
425 /// Returns the energy used for cooling from coal in gigajoules.
426 /// Requires EnergyPlus simulation output to calculate.
427 boost::optional<double> coalCooling() const;
428
429 /// Returns the energy used for interior lighting from coal in gigajoules.
430 /// Requires EnergyPlus simulation output to calculate.
431 boost::optional<double> coalInteriorLighting() const;
432
433 /// Returns the energy used for exterior lighting from coal in gigajoules.
434 /// Requires EnergyPlus simulation output to calculate.
435 boost::optional<double> coalExteriorLighting() const;
436
437 /// Returns the energy used for interior equipment from coal in gigajoules.
438 /// Requires EnergyPlus simulation output to calculate.
439 boost::optional<double> coalInteriorEquipment() const;
440
441 /// Returns the energy used for exterior equipment from coal in gigajoules.
442 /// Requires EnergyPlus simulation output to calculate.
443 boost::optional<double> coalExteriorEquipment() const;
444
445 /// Returns the energy used for fans from coal in gigajoules.
446 /// Requires EnergyPlus simulation output to calculate.
447 boost::optional<double> coalFans() const;
448
449 /// Returns the energy used for pumps from coal in gigajoules.
450 /// Requires EnergyPlus simulation output to calculate.
451 boost::optional<double> coalPumps() const;
452
453 /// Returns the energy used for heat rejection from coal in gigajoules.
454 /// Requires EnergyPlus simulation output to calculate.
455 boost::optional<double> coalHeatRejection() const;
456
457 /// Returns the energy used for humidification from coal in gigajoules.
458 /// Requires EnergyPlus simulation output to calculate.
459 boost::optional<double> coalHumidification() const;
460
461 /// Returns the energy used for heat recovery from coal in gigajoules.
462 /// Requires EnergyPlus simulation output to calculate.
463 boost::optional<double> coalHeatRecovery() const;
464
465 /// Returns the energy used for water systems from coal in gigajoules.
466 /// Requires EnergyPlus simulation output to calculate.
467 boost::optional<double> coalWaterSystems() const;
468
469 /// Returns the energy used for refrigeration from coal in gigajoules.
470 /// Requires EnergyPlus simulation output to calculate.
471 boost::optional<double> coalRefrigeration() const;
472
473 /// Returns the energy used for generators from coal in gigajoules.
474 /// Requires EnergyPlus simulation output to calculate.
475 boost::optional<double> coalGenerators() const;
476
477 /// Returns the energy used for all end uses from coal in gigajoules.
478 /// Requires EnergyPlus simulation output to calculate.
479 boost::optional<double> coalTotalEndUses() const;
480
481 /// Fuel Oil No 1
482 /// Returns the energy used for heating from fuelOilNo1 in gigajoules.
483 /// Requires EnergyPlus simulation output to calculate.
484 boost::optional<double> fuelOilNo1Heating() const;
485
486 /// Returns the energy used for cooling from fuelOilNo1 in gigajoules.
487 /// Requires EnergyPlus simulation output to calculate.
488 boost::optional<double> fuelOilNo1Cooling() const;
489
490 /// Returns the energy used for interior lighting from fuelOilNo1 in gigajoules.
491 /// Requires EnergyPlus simulation output to calculate.
492 boost::optional<double> fuelOilNo1InteriorLighting() const;
493
494 /// Returns the energy used for exterior lighting from fuelOilNo1 in gigajoules.
495 /// Requires EnergyPlus simulation output to calculate.
496 boost::optional<double> fuelOilNo1ExteriorLighting() const;
497
498 /// Returns the energy used for interior equipment from fuelOilNo1 in gigajoules.
499 /// Requires EnergyPlus simulation output to calculate.
500 boost::optional<double> fuelOilNo1InteriorEquipment() const;
501
502 /// Returns the energy used for exterior equipment from fuelOilNo1 in gigajoules.
503 /// Requires EnergyPlus simulation output to calculate.
504 boost::optional<double> fuelOilNo1ExteriorEquipment() const;
505
506 /// Returns the energy used for fans from fuelOilNo1 in gigajoules.
507 /// Requires EnergyPlus simulation output to calculate.
508 boost::optional<double> fuelOilNo1Fans() const;
509
510 /// Returns the energy used for pumps from fuelOilNo1 in gigajoules.
511 /// Requires EnergyPlus simulation output to calculate.
512 boost::optional<double> fuelOilNo1Pumps() const;
513
514 /// Returns the energy used for heat rejection from fuelOilNo1 in gigajoules.
515 /// Requires EnergyPlus simulation output to calculate.
516 boost::optional<double> fuelOilNo1HeatRejection() const;
517
518 /// Returns the energy used for humidification from fuelOilNo1 in gigajoules.
519 /// Requires EnergyPlus simulation output to calculate.
520 boost::optional<double> fuelOilNo1Humidification() const;
521
522 /// Returns the energy used for heat recovery from fuelOilNo1 in gigajoules.
523 /// Requires EnergyPlus simulation output to calculate.
524 boost::optional<double> fuelOilNo1HeatRecovery() const;
525
526 /// Returns the energy used for water systems from fuelOilNo1 in gigajoules.
527 /// Requires EnergyPlus simulation output to calculate.
528 boost::optional<double> fuelOilNo1WaterSystems() const;
529
530 /// Returns the energy used for refrigeration from fuelOilNo1 in gigajoules.
531 /// Requires EnergyPlus simulation output to calculate.
532 boost::optional<double> fuelOilNo1Refrigeration() const;
533
534 /// Returns the energy used for generators from fuelOilNo1 in gigajoules.
535 /// Requires EnergyPlus simulation output to calculate.
536 boost::optional<double> fuelOilNo1Generators() const;
537
538 /// Returns the energy used for all end uses from fuelOilNo1 in gigajoules.
539 /// Requires EnergyPlus simulation output to calculate.
540 boost::optional<double> fuelOilNo1TotalEndUses() const;
541
542 /// Fuel Oil No 2
543 /// Returns the energy used for heating from fuelOilNo2 in gigajoules.
544 /// Requires EnergyPlus simulation output to calculate.
545 boost::optional<double> fuelOilNo2Heating() const;
546
547 /// Returns the energy used for cooling from fuelOilNo2 in gigajoules.
548 /// Requires EnergyPlus simulation output to calculate.
549 boost::optional<double> fuelOilNo2Cooling() const;
550
551 /// Returns the energy used for interior lighting from fuelOilNo2 in gigajoules.
552 /// Requires EnergyPlus simulation output to calculate.
553 boost::optional<double> fuelOilNo2InteriorLighting() const;
554
555 /// Returns the energy used for exterior lighting from fuelOilNo2 in gigajoules.
556 /// Requires EnergyPlus simulation output to calculate.
557 boost::optional<double> fuelOilNo2ExteriorLighting() const;
558
559 /// Returns the energy used for interior equipment from fuelOilNo2 in gigajoules.
560 /// Requires EnergyPlus simulation output to calculate.
561 boost::optional<double> fuelOilNo2InteriorEquipment() const;
562
563 /// Returns the energy used for exterior equipment from fuelOilNo2 in gigajoules.
564 /// Requires EnergyPlus simulation output to calculate.
565 boost::optional<double> fuelOilNo2ExteriorEquipment() const;
566
567 /// Returns the energy used for fans from fuelOilNo2 in gigajoules.
568 /// Requires EnergyPlus simulation output to calculate.
569 boost::optional<double> fuelOilNo2Fans() const;
570
571 /// Returns the energy used for pumps from fuelOilNo2 in gigajoules.
572 /// Requires EnergyPlus simulation output to calculate.
573 boost::optional<double> fuelOilNo2Pumps() const;
574
575 /// Returns the energy used for heat rejection from fuelOilNo2 in gigajoules.
576 /// Requires EnergyPlus simulation output to calculate.
577 boost::optional<double> fuelOilNo2HeatRejection() const;
578
579 /// Returns the energy used for humidification from fuelOilNo2 in gigajoules.
580 /// Requires EnergyPlus simulation output to calculate.
581 boost::optional<double> fuelOilNo2Humidification() const;
582
583 /// Returns the energy used for heat recovery from fuelOilNo2 in gigajoules.
584 /// Requires EnergyPlus simulation output to calculate.
585 boost::optional<double> fuelOilNo2HeatRecovery() const;
586
587 /// Returns the energy used for water systems from fuelOilNo2 in gigajoules.
588 /// Requires EnergyPlus simulation output to calculate.
589 boost::optional<double> fuelOilNo2WaterSystems() const;
590
591 /// Returns the energy used for refrigeration from fuelOilNo2 in gigajoules.
592 /// Requires EnergyPlus simulation output to calculate.
593 boost::optional<double> fuelOilNo2Refrigeration() const;
594
595 /// Returns the energy used for generators from fuelOilNo2 in gigajoules.
596 /// Requires EnergyPlus simulation output to calculate.
597 boost::optional<double> fuelOilNo2Generators() const;
598
599 /// Returns the energy used for all end uses from fuelOilNo2 in gigajoules.
600 /// Requires EnergyPlus simulation output to calculate.
601 boost::optional<double> fuelOilNo2TotalEndUses() const;
602
603 /// Propane
604 /// Returns the energy used for heating from propane in gigajoules.
605 /// Requires EnergyPlus simulation output to calculate.
606 boost::optional<double> propaneHeating() const;
607
608 /// Returns the energy used for cooling from propane in gigajoules.
609 /// Requires EnergyPlus simulation output to calculate.
610 boost::optional<double> propaneCooling() const;
611
612 /// Returns the energy used for interior lighting from propane in gigajoules.
613 /// Requires EnergyPlus simulation output to calculate.
614 boost::optional<double> propaneInteriorLighting() const;
615
616 /// Returns the energy used for exterior lighting from propane in gigajoules.
617 /// Requires EnergyPlus simulation output to calculate.
618 boost::optional<double> propaneExteriorLighting() const;
619
620 /// Returns the energy used for interior equipment from propane in gigajoules.
621 /// Requires EnergyPlus simulation output to calculate.
622 boost::optional<double> propaneInteriorEquipment() const;
623
624 /// Returns the energy used for exterior equipment from propane in gigajoules.
625 /// Requires EnergyPlus simulation output to calculate.
626 boost::optional<double> propaneExteriorEquipment() const;
627
628 /// Returns the energy used for fans from propane in gigajoules.
629 /// Requires EnergyPlus simulation output to calculate.
630 boost::optional<double> propaneFans() const;
631
632 /// Returns the energy used for pumps from propane in gigajoules.
633 /// Requires EnergyPlus simulation output to calculate.
634 boost::optional<double> propanePumps() const;
635
636 /// Returns the energy used for heat rejection from propane in gigajoules.
637 /// Requires EnergyPlus simulation output to calculate.
638 boost::optional<double> propaneHeatRejection() const;
639
640 /// Returns the energy used for humidification from propane in gigajoules.
641 /// Requires EnergyPlus simulation output to calculate.
642 boost::optional<double> propaneHumidification() const;
643
644 /// Returns the energy used for heat recovery from propane in gigajoules.
645 /// Requires EnergyPlus simulation output to calculate.
646 boost::optional<double> propaneHeatRecovery() const;
647
648 /// Returns the energy used for water systems from propane in gigajoules.
649 /// Requires EnergyPlus simulation output to calculate.
650 boost::optional<double> propaneWaterSystems() const;
651
652 /// Returns the energy used for refrigeration from propane in gigajoules.
653 /// Requires EnergyPlus simulation output to calculate.
654 boost::optional<double> propaneRefrigeration() const;
655
656 /// Returns the energy used for generators from propane in gigajoules.
657 /// Requires EnergyPlus simulation output to calculate.
658 boost::optional<double> propaneGenerators() const;
659
660 /// Returns the energy used for all end uses from propane in gigajoules.
661 /// Requires EnergyPlus simulation output to calculate.
662 boost::optional<double> propaneTotalEndUses() const;
663
664 /// Other Fuel 1
665 /// Returns the energy used for heating from otherFuel1 in gigajoules.
666 /// Requires EnergyPlus simulation output to calculate.
667 boost::optional<double> otherFuel1Heating() const;
668
669 /// Returns the energy used for cooling from otherFuel1 in gigajoules.
670 /// Requires EnergyPlus simulation output to calculate.
671 boost::optional<double> otherFuel1Cooling() const;
672
673 /// Returns the energy used for interior lighting from otherFuel1 in gigajoules.
674 /// Requires EnergyPlus simulation output to calculate.
675 boost::optional<double> otherFuel1InteriorLighting() const;
676
677 /// Returns the energy used for exterior lighting from otherFuel1 in gigajoules.
678 /// Requires EnergyPlus simulation output to calculate.
679 boost::optional<double> otherFuel1ExteriorLighting() const;
680
681 /// Returns the energy used for interior equipment from otherFuel1 in gigajoules.
682 /// Requires EnergyPlus simulation output to calculate.
683 boost::optional<double> otherFuel1InteriorEquipment() const;
684
685 /// Returns the energy used for exterior equipment from otherFuel1 in gigajoules.
686 /// Requires EnergyPlus simulation output to calculate.
687 boost::optional<double> otherFuel1ExteriorEquipment() const;
688
689 /// Returns the energy used for fans from otherFuel1 in gigajoules.
690 /// Requires EnergyPlus simulation output to calculate.
691 boost::optional<double> otherFuel1Fans() const;
692
693 /// Returns the energy used for pumps from otherFuel1 in gigajoules.
694 /// Requires EnergyPlus simulation output to calculate.
695 boost::optional<double> otherFuel1Pumps() const;
696
697 /// Returns the energy used for heat rejection from otherFuel1 in gigajoules.
698 /// Requires EnergyPlus simulation output to calculate.
699 boost::optional<double> otherFuel1HeatRejection() const;
700
701 /// Returns the energy used for humidification from otherFuel1 in gigajoules.
702 /// Requires EnergyPlus simulation output to calculate.
703 boost::optional<double> otherFuel1Humidification() const;
704
705 /// Returns the energy used for heat recovery from otherFuel1 in gigajoules.
706 /// Requires EnergyPlus simulation output to calculate.
707 boost::optional<double> otherFuel1HeatRecovery() const;
708
709 /// Returns the energy used for water systems from otherFuel1 in gigajoules.
710 /// Requires EnergyPlus simulation output to calculate.
711 boost::optional<double> otherFuel1WaterSystems() const;
712
713 /// Returns the energy used for refrigeration from otherFuel1 in gigajoules.
714 /// Requires EnergyPlus simulation output to calculate.
715 boost::optional<double> otherFuel1Refrigeration() const;
716
717 /// Returns the energy used for generators from otherFuel1 in gigajoules.
718 /// Requires EnergyPlus simulation output to calculate.
719 boost::optional<double> otherFuel1Generators() const;
720
721 /// Returns the energy used for all end uses from otherFuel1 in gigajoules.
722 /// Requires EnergyPlus simulation output to calculate.
723 boost::optional<double> otherFuel1TotalEndUses() const;
724
725 /// Other Fuel 2
726 /// Returns the energy used for heating from otherFuel2 in gigajoules.
727 /// Requires EnergyPlus simulation output to calculate.
728 boost::optional<double> otherFuel2Heating() const;
729
730 /// Returns the energy used for cooling from otherFuel2 in gigajoules.
731 /// Requires EnergyPlus simulation output to calculate.
732 boost::optional<double> otherFuel2Cooling() const;
733
734 /// Returns the energy used for interior lighting from otherFuel2 in gigajoules.
735 /// Requires EnergyPlus simulation output to calculate.
736 boost::optional<double> otherFuel2InteriorLighting() const;
737
738 /// Returns the energy used for exterior lighting from otherFuel2 in gigajoules.
739 /// Requires EnergyPlus simulation output to calculate.
740 boost::optional<double> otherFuel2ExteriorLighting() const;
741
742 /// Returns the energy used for interior equipment from otherFuel2 in gigajoules.
743 /// Requires EnergyPlus simulation output to calculate.
744 boost::optional<double> otherFuel2InteriorEquipment() const;
745
746 /// Returns the energy used for exterior equipment from otherFuel2 in gigajoules.
747 /// Requires EnergyPlus simulation output to calculate.
748 boost::optional<double> otherFuel2ExteriorEquipment() const;
749
750 /// Returns the energy used for fans from otherFuel2 in gigajoules.
751 /// Requires EnergyPlus simulation output to calculate.
752 boost::optional<double> otherFuel2Fans() const;
753
754 /// Returns the energy used for pumps from otherFuel2 in gigajoules.
755 /// Requires EnergyPlus simulation output to calculate.
756 boost::optional<double> otherFuel2Pumps() const;
757
758 /// Returns the energy used for heat rejection from otherFuel2 in gigajoules.
759 /// Requires EnergyPlus simulation output to calculate.
760 boost::optional<double> otherFuel2HeatRejection() const;
761
762 /// Returns the energy used for humidification from otherFuel2 in gigajoules.
763 /// Requires EnergyPlus simulation output to calculate.
764 boost::optional<double> otherFuel2Humidification() const;
765
766 /// Returns the energy used for heat recovery from otherFuel2 in gigajoules.
767 /// Requires EnergyPlus simulation output to calculate.
768 boost::optional<double> otherFuel2HeatRecovery() const;
769
770 /// Returns the energy used for water systems from otherFuel2 in gigajoules.
771 /// Requires EnergyPlus simulation output to calculate.
772 boost::optional<double> otherFuel2WaterSystems() const;
773
774 /// Returns the energy used for refrigeration from otherFuel2 in gigajoules.
775 /// Requires EnergyPlus simulation output to calculate.
776 boost::optional<double> otherFuel2Refrigeration() const;
777
778 /// Returns the energy used for generators from otherFuel2 in gigajoules.
779 /// Requires EnergyPlus simulation output to calculate.
780 boost::optional<double> otherFuel2Generators() const;
781
782 /// Returns the energy used for all end uses from otherFuel2 in gigajoules.
783 /// Requires EnergyPlus simulation output to calculate.
784 boost::optional<double> otherFuel2TotalEndUses() const;
785
786 /// Returns the district cooling energy used for heating in gigajoules.
787 /// Requires EnergyPlus simulation output to calculate.
788 boost::optional<double> districtCoolingHeating() const;
789
790 /// Returns the district cooling energy used for cooling in gigajoules.
791 /// Requires EnergyPlus simulation output to calculate.
792 boost::optional<double> districtCoolingCooling() const;
793
794 /// Returns the district cooling energy used for interior lighting in gigajoules.
795 /// Requires EnergyPlus simulation output to calculate.
796 boost::optional<double> districtCoolingInteriorLighting() const;
797
798 /// Returns the district cooling energy used for exterior lighting in gigajoules.
799 /// Requires EnergyPlus simulation output to calculate.
800 boost::optional<double> districtCoolingExteriorLighting() const;
801
802 /// Returns the district cooling energy used for interior equipment in gigajoules.
803 /// Requires EnergyPlus simulation output to calculate.
804 boost::optional<double> districtCoolingInteriorEquipment() const;
805
806 /// Returns the district cooling energy used for exterior equipment in gigajoules.
807 /// Requires EnergyPlus simulation output to calculate.
808 boost::optional<double> districtCoolingExteriorEquipment() const;
809
810 /// Returns the district cooling energy used for fans in gigajoules.
811 /// Requires EnergyPlus simulation output to calculate.
812 boost::optional<double> districtCoolingFans() const;
813
814 /// Returns the district cooling energy used for pumps in gigajoules.
815 /// Requires EnergyPlus simulation output to calculate.
816 boost::optional<double> districtCoolingPumps() const;
817
818 /// Returns the district cooling energy used for heat rejection in gigajoules.
819 /// Requires EnergyPlus simulation output to calculate.
820 boost::optional<double> districtCoolingHeatRejection() const;
821
822 /// Returns the district cooling energy used for humidification in gigajoules.
823 /// Requires EnergyPlus simulation output to calculate.
824 boost::optional<double> districtCoolingHumidification() const;
825
826 /// Returns the district cooling energy used for heat recovery in gigajoules.
827 /// Requires EnergyPlus simulation output to calculate.
828 boost::optional<double> districtCoolingHeatRecovery() const;
829
830 /// Returns the district cooling energy used for water systems in gigajoules.
831 /// Requires EnergyPlus simulation output to calculate.
832 boost::optional<double> districtCoolingWaterSystems() const;
833
834 /// Returns the district cooling energy used for refrigeration in gigajoules.
835 /// Requires EnergyPlus simulation output to calculate.
836 boost::optional<double> districtCoolingRefrigeration() const;
837
838 /// Returns the district cooling energy used for generators in gigajoules.
839 /// Requires EnergyPlus simulation output to calculate.
840 boost::optional<double> districtCoolingGenerators() const;
841
842 /// Returns the district cooling energy used for all end uses in gigajoules.
843 /// Requires EnergyPlus simulation output to calculate.
844 boost::optional<double> districtCoolingTotalEndUses() const;
845
846 /// Returns the district heating energy used for heating in gigajoules.
847 /// Requires EnergyPlus simulation output to calculate.
848 boost::optional<double> districtHeatingHeating() const;
849
850 /// Returns the district heating energy used for cooling in gigajoules.
851 /// Requires EnergyPlus simulation output to calculate.
852 boost::optional<double> districtHeatingCooling() const;
853
854 /// Returns the district heating energy used for interior lighting in gigajoules.
855 /// Requires EnergyPlus simulation output to calculate.
856 boost::optional<double> districtHeatingInteriorLighting() const;
857
858 /// Returns the district heating energy used for exterior lighting in gigajoules.
859 /// Requires EnergyPlus simulation output to calculate.
860 boost::optional<double> districtHeatingExteriorLighting() const;
861
862 /// Returns the district heating energy used for interior equipment in gigajoules.
863 /// Requires EnergyPlus simulation output to calculate.
864 boost::optional<double> districtHeatingInteriorEquipment() const;
865
866 /// Returns the district heating energy used for exterior equipment in gigajoules.
867 /// Requires EnergyPlus simulation output to calculate.
868 boost::optional<double> districtHeatingExteriorEquipment() const;
869
870 /// Returns the district heating energy used for fans in gigajoules.
871 /// Requires EnergyPlus simulation output to calculate.
872 boost::optional<double> districtHeatingFans() const;
873
874 /// Returns the district heating energy used for pumps in gigajoules.
875 /// Requires EnergyPlus simulation output to calculate.
876 boost::optional<double> districtHeatingPumps() const;
877
878 /// Returns the district heating energy used for heat rejection in gigajoules.
879 /// Requires EnergyPlus simulation output to calculate.
880 boost::optional<double> districtHeatingHeatRejection() const;
881
882 /// Returns the district heating energy used for humidification in gigajoules.
883 /// Requires EnergyPlus simulation output to calculate.
884 boost::optional<double> districtHeatingHumidification() const;
885
886 /// Returns the district heating energy used for heat recovery in gigajoules.
887 /// Requires EnergyPlus simulation output to calculate.
888 boost::optional<double> districtHeatingHeatRecovery() const;
889
890 /// Returns the district heating energy used for water systems in gigajoules.
891 /// Requires EnergyPlus simulation output to calculate.
892 boost::optional<double> districtHeatingWaterSystems() const;
893
894 /// Returns the district heating energy used for refrigeration in gigajoules.
895 /// Requires EnergyPlus simulation output to calculate.
896 boost::optional<double> districtHeatingRefrigeration() const;
897
898 /// Returns the district heating energy used for generators in gigajoules.
899 /// Requires EnergyPlus simulation output to calculate.
900 boost::optional<double> districtHeatingGenerators() const;
901
902 /// Returns the district heating energy used for all end uses in gigajoules.
903 /// Requires EnergyPlus simulation output to calculate.
904 boost::optional<double> districtHeatingTotalEndUses() const;
905
906 /// Returns the water used for heating in cubic meters.
907 /// Requires EnergyPlus simulation output to calculate.
908 boost::optional<double> waterHeating() const;
909
910 /// Returns the water used for cooling in cubic meters.
911 /// Requires EnergyPlus simulation output to calculate.
912 boost::optional<double> waterCooling() const;
913
914 /// Returns the water used for interior lighting in cubic meters.
915 /// Requires EnergyPlus simulation output to calculate.
916 boost::optional<double> waterInteriorLighting() const;
917
918 /// Returns the water used for exterior lighting in cubic meters.
919 /// Requires EnergyPlus simulation output to calculate.
920 boost::optional<double> waterExteriorLighting() const;
921
922 /// Returns the water used for interior equipment in cubic meters.
923 /// Requires EnergyPlus simulation output to calculate.
924 boost::optional<double> waterInteriorEquipment() const;
925
926 /// Returns the water used for exterior equipment in cubic meters.
927 /// Requires EnergyPlus simulation output to calculate.
928 boost::optional<double> waterExteriorEquipment() const;
929
930 /// Returns the water used for fans in cubic meters.
931 /// Requires EnergyPlus simulation output to calculate.
932 boost::optional<double> waterFans() const;
933
934 /// Returns the water used for pumps in cubic meters.
935 /// Requires EnergyPlus simulation output to calculate.
936 boost::optional<double> waterPumps() const;
937
938 /// Returns the water used for heat rejection in cubic meters.
939 /// Requires EnergyPlus simulation output to calculate.
940 boost::optional<double> waterHeatRejection() const;
941
942 /// Returns the water used for humidification in cubic meters.
943 /// Requires EnergyPlus simulation output to calculate.
944 boost::optional<double> waterHumidification() const;
945
946 /// Returns the water used for heat recovery in cubic meters.
947 /// Requires EnergyPlus simulation output to calculate.
948 boost::optional<double> waterHeatRecovery() const;
949
950 /// Returns the water used for water systems in cubic meters.
951 /// Requires EnergyPlus simulation output to calculate.
952 boost::optional<double> waterWaterSystems() const;
953
954 /// Returns the water used for refrigeration in cubic meters.
955 /// Requires EnergyPlus simulation output to calculate.
956 boost::optional<double> waterRefrigeration() const;
957
958 /// Returns the water used for generators in cubic meters.
959 /// Requires EnergyPlus simulation output to calculate.class EndUseType;
960 boost::optional<double> waterGenerators() const;
961
962 /// Returns the water used for all uses in cubic meters.
963 /// Requires EnergyPlus simulation output to calculate.
964 boost::optional<double> waterTotalEndUses() const;
965
966 /// Returns the total number of hours the heating setpoint is not met.
967 /// Requires EnergyPlus simulation output to calculate.
968 boost::optional<double> hoursHeatingSetpointNotMet() const;
969
970 /// Returns the total number of hours the cooling setpoint is not met.
971 /// Requires EnergyPlus simulation output to calculate.
972 boost::optional<double> hoursCoolingSetpointNotMet() const;
973
974 /// Returns an EndUse object containing all end uses for the simulation.
975 boost::optional<EndUses> endUses() const;
976
977 /// Returns a CalibrationResult object containing data related to model calibration.
978 boost::optional<CalibrationResult> calibrationResult() const;
979
980 //@}
981
982 protected:
983 /** @name Constructors and Destructors */
984 //@{
985
986 explicit Facility(Model& model);
987
988 //@}
989
990 /// @cond
991 using ImplType = detail::Facility_Impl;
992
993 friend class Model;
994 friend class openstudio::IdfObject;
995
996 explicit Facility(std::shared_ptr<detail::Facility_Impl> impl);
997
998 /// @endcond
999 private:
1000 REGISTER_LOGGER("openstudio.model.Facility");
1001 };
1002
1003 /** \relates Facility*/
1004 using OptionalFacility = boost::optional<Facility>;
1005
1006 } // namespace model
1007 } // namespace openstudio
1008
1009 #endif // MODEL_FACILITY_HPP
1010