GCC Code Coverage Report


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

src/energyplus/ForwardTranslator.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 ENERGYPLUS_FORWARDTRANSLATOR_HPP
7 #define ENERGYPLUS_FORWARDTRANSLATOR_HPP
8
9 #include "EnergyPlusAPI.hpp"
10 #include "../model/Model.hpp"
11 #include "../model/ConstructionBase.hpp"
12 #include "../model/HVACComponent.hpp"
13 #include "../utilities/idf/Workspace.hpp"
14 #include "../utilities/core/Logger.hpp"
15 #include "../utilities/core/StringStreamLogSink.hpp"
16 #include "../utilities/filetypes/ForwardTranslatorOptions.hpp"
17 #include "../utilities/time/Time.hpp"
18
19 #include "../utilities/core/Deprecated.hpp"
20
21 #include <iostream>
22
23 namespace openstudio {
24
25 class ProgressBar;
26 class Transformation;
27
28 namespace model {
29
30 class AirConditionerVariableRefrigerantFlow;
31 class AirConditionerVariableRefrigerantFlowFluidTemperatureControl;
32 class AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR;
33 class AirflowNetworkSimulationControl;
34 class AirflowNetworkZone;
35 class AirflowNetworkSurface;
36 class AirflowNetworkReferenceCrackConditions;
37 class AirflowNetworkCrack;
38 class AirflowNetworkEffectiveLeakageArea;
39 class AirflowNetworkDetailedOpening;
40 class AirflowNetworkSimpleOpening;
41 class AirflowNetworkHorizontalOpening;
42 class AirflowNetworkSpecifiedFlowRate;
43 class AirflowNetworkZoneExhaustFan;
44 class AirflowNetworkExternalNode;
45 class AirflowNetworkDistributionNode;
46 class AirflowNetworkLeakageRatio;
47 class AirflowNetworkDuct;
48 class AirflowNetworkFan;
49 class AirflowNetworkEquivalentDuct;
50 class AirflowNetworkConstantPressureDrop;
51 class AirflowNetworkOutdoorAirflow;
52 class AirflowNetworkDistributionLinkage;
53 class AirflowNetworkDuctViewFactors;
54 class AirflowNetworkOccupantVentilationControl;
55 class AirGap;
56 class AirLoopHVAC;
57 class AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass;
58 class AirLoopHVACUnitaryHeatPumpAirToAir;
59 class AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed;
60 class AirLoopHVACUnitarySystem;
61 class AirLoopHVACReturnPlenum;
62 class AirLoopHVACSupplyPlenum;
63 class AirLoopHVACZoneSplitter;
64 class AirTerminalDualDuctConstantVolume;
65 class AirTerminalDualDuctVAV;
66 class AirTerminalDualDuctVAVOutdoorAir;
67 class AirTerminalSingleDuctConstantVolumeCooledBeam;
68 class AirTerminalSingleDuctConstantVolumeFourPipeInduction;
69 class AirTerminalSingleDuctConstantVolumeFourPipeBeam;
70 class AirTerminalSingleDuctConstantVolumeReheat;
71 class AirTerminalSingleDuctParallelPIUReheat;
72 class AirTerminalSingleDuctSeriesPIUReheat;
73 class AirTerminalSingleDuctConstantVolumeNoReheat;
74 class AirTerminalSingleDuctVAVNoReheat;
75 class AirTerminalSingleDuctVAVReheat;
76 class AirTerminalSingleDuctInletSideMixer;
77 class AirTerminalSingleDuctVAVHeatAndCoolNoReheat;
78 class AirTerminalSingleDuctVAVHeatAndCoolReheat;
79 class AirLoopHVACZoneMixer;
80 class AirLoopHVACOutdoorAirSystem;
81 class AirLoopHVACDedicatedOutdoorAirSystem;
82 class AvailabilityManagerAssignmentList;
83 class AvailabilityManagerHybridVentilation;
84 class AvailabilityManagerOptimumStart;
85 class AvailabilityManagerDifferentialThermostat;
86 class AvailabilityManagerNightVentilation;
87 class AvailabilityManagerNightCycle;
88 class AvailabilityManagerHighTemperatureTurnOn;
89 class AvailabilityManagerHighTemperatureTurnOff;
90 class AvailabilityManagerLowTemperatureTurnOn;
91 class AvailabilityManagerLowTemperatureTurnOff;
92 class AvailabilityManagerScheduled;
93 class AvailabilityManagerScheduledOn;
94 class AvailabilityManagerScheduledOff;
95 class Blind;
96 class Building;
97 class BoilerHotWater;
98 class BoilerSteam;
99 class CentralHeatPumpSystem;
100 class CFactorUndergroundWallConstruction;
101 class ChillerAbsorption;
102 class ChillerAbsorptionIndirect;
103 class ChillerElectricASHRAE205;
104 class ChillerElectricEIR;
105 class ChillerElectricReformulatedEIR;
106 class ChillerHeaterPerformanceElectricEIR;
107 class CoilCoolingDX;
108 class CoilCoolingDXCurveFitPerformance;
109 class CoilCoolingDXCurveFitOperatingMode;
110 class CoilCoolingDXCurveFitSpeed;
111 class CoilCoolingDXMultiSpeed;
112 class CoilCoolingDXSingleSpeed;
113 class CoilCoolingDXSingleSpeedThermalStorage;
114 class CoilCoolingDXTwoSpeed;
115 class CoilCoolingDXTwoStageWithHumidityControlMode;
116 class CoilCoolingDXVariableRefrigerantFlow;
117 class CoilCoolingDXVariableRefrigerantFlowFluidTemperatureControl;
118 class CoilCoolingDXVariableSpeed;
119 class CoilCoolingWater;
120 class CoilCoolingWaterToAirHeatPumpEquationFit;
121 class CoilCoolingWaterToAirHeatPumpVariableSpeedEquationFit;
122 class CoilHeatingDesuperheater;
123 class CoilHeatingDXMultiSpeed;
124 class CoilHeatingDXSingleSpeed;
125 class CoilHeatingDXVariableRefrigerantFlow;
126 class CoilHeatingDXVariableRefrigerantFlowFluidTemperatureControl;
127 class CoilHeatingDXVariableSpeed;
128 class CoilHeatingElectric;
129 class CoilHeatingElectricMultiStage;
130 class CoilHeatingGas;
131 class CoilHeatingGasMultiStage;
132 class CoilHeatingWater;
133 class CoilHeatingWaterToAirHeatPumpEquationFit;
134 class CoilHeatingWaterToAirHeatPumpVariableSpeedEquationFit;
135 class CoilPerformanceDXCooling;
136 class CoilSystemCoolingDXHeatExchangerAssisted;
137 class CoilSystemCoolingWater;
138 class CoilSystemCoolingWaterHeatExchangerAssisted;
139 class CoilSystemIntegratedHeatPumpAirSource;
140 class CoilUserDefined;
141 class CoilWaterHeatingDesuperheater;
142 class CoilWaterHeatingAirToWaterHeatPump;
143 class CoilWaterHeatingAirToWaterHeatPumpVariableSpeed;
144 class CoilWaterHeatingAirToWaterHeatPumpWrapped;
145 class Construction;
146 class ConstructionAirBoundary;
147 class ConstructionWithInternalSource;
148 class ControllerOutdoorAir;
149 class ControllerMechanicalVentilation;
150 class ControllerWaterCoil;
151 class ConvergenceLimits;
152 class CoolingTowerPerformanceCoolTools;
153 class CoolingTowerPerformanceYorkCalc;
154 class CoolingTowerSingleSpeed;
155 class CoolingTowerTwoSpeed;
156 class CoolingTowerVariableSpeed;
157 class CurrencyType;
158 class CurveBicubic;
159 class CurveBiquadratic;
160 class CurveCubic;
161 class CurveDoubleExponentialDecay;
162 class CurveExponent;
163 class CurveExponentialDecay;
164 class CurveExponentialSkewNormal;
165 class CurveFanPressureRise;
166 class CurveFunctionalPressureDrop;
167 class CurveLinear;
168 class CurveQuadLinear;
169 class CurveQuintLinear;
170 class CurveQuadratic;
171 class CurveQuadraticLinear;
172 class CurveQuartic;
173 class CurveRectangularHyperbola1;
174 class CurveRectangularHyperbola2;
175 class CurveSigmoid;
176 class CurveTriquadratic;
177 class DaylightingControl;
178 class DaylightingDeviceShelf;
179 class DaylightingDeviceTubular;
180 class DaylightingDeviceLightWell;
181 class DaylightRedirectionDevice;
182 class DefaultConstructionSet;
183 class DefaultSurfaceConstructions;
184 class DefaultSubSurfaceConstructions;
185 class DesignDay;
186 class DesignSpecificationOutdoorAir;
187 class DistrictCooling;
188 class DistrictHeatingWater;
189 class DistrictHeatingSteam;
190 class Duct;
191 class ElectricEquipment;
192 class ElectricEquipmentDefinition;
193 class ElectricEquipmentITEAirCooled;
194 class ElectricEquipmentITEAirCooledDefinition;
195 class ElectricLoadCenterDistribution;
196 class ElectricLoadCenterInverterLookUpTable;
197 class ElectricLoadCenterInverterSimple;
198 class ElectricLoadCenterInverterPVWatts;
199 class ElectricLoadCenterStorageSimple;
200 class ElectricLoadCenterStorageConverter;
201 class ElectricLoadCenterStorageLiIonNMCBattery;
202 class ElectricLoadCenterTransformer;
203 class EnergyManagementSystemActuator;
204 class EnergyManagementSystemConstructionIndexVariable;
205 class EnergyManagementSystemCurveOrTableIndexVariable;
206 class EnergyManagementSystemGlobalVariable;
207 class EnergyManagementSystemInternalVariable;
208 class EnergyManagementSystemMeteredOutputVariable;
209 class EnergyManagementSystemOutputVariable;
210 class EnergyManagementSystemProgram;
211 class EnergyManagementSystemProgramCallingManager;
212 class EnergyManagementSystemSensor;
213 class EnergyManagementSystemSubroutine;
214 class EnergyManagementSystemTrendVariable;
215 class EvaporativeCoolerDirectResearchSpecial;
216 class EvaporativeCoolerIndirectResearchSpecial;
217 class EvaporativeFluidCoolerSingleSpeed;
218 class EvaporativeFluidCoolerTwoSpeed;
219 class ExteriorLights;
220 class ExteriorFuelEquipment;
221 class ExteriorWaterEquipment;
222 class ExternalInterface;
223 class ExternalInterfaceActuator;
224 class ExternalInterfaceFunctionalMockupUnitExportFromVariable;
225 class ExternalInterfaceFunctionalMockupUnitExportToActuator;
226 class ExternalInterfaceFunctionalMockupUnitExportToSchedule;
227 class ExternalInterfaceFunctionalMockupUnitExportToVariable;
228 class ExternalInterfaceFunctionalMockupUnitImport;
229 class ExternalInterfaceFunctionalMockupUnitImportFromVariable;
230 class ExternalInterfaceFunctionalMockupUnitImportToActuator;
231 class ExternalInterfaceFunctionalMockupUnitImportToSchedule;
232 class ExternalInterfaceFunctionalMockupUnitImportToVariable;
233 class ExternalInterfaceSchedule;
234 class ExternalInterfaceVariable;
235 class FanComponentModel;
236 class FanConstantVolume;
237 class FanOnOff;
238 class FanSystemModel;
239 class FanVariableVolume;
240 class FanZoneExhaust;
241 class FFactorGroundFloorConstruction;
242 class FluidCoolerSingleSpeed;
243 class FluidCoolerTwoSpeed;
244 class FoundationKiva;
245 class FoundationKivaSettings;
246 class Gas;
247 class GasEquipment;
248 class GasEquipmentDefinition;
249 class GasMixture;
250 class GeneratorMicroTurbine;
251 class GeneratorFuelCell;
252 class GeneratorFuelCellAirSupply;
253 class GeneratorFuelCellAuxiliaryHeater;
254 class GeneratorFuelCellElectricalStorage;
255 class GeneratorFuelCellExhaustGasToWaterHeatExchanger;
256 class GeneratorFuelCellInverter;
257 class GeneratorFuelCellPowerModule;
258 class GeneratorFuelCellStackCooler;
259 class GeneratorFuelCellWaterSupply;
260 class GeneratorFuelSupply;
261 class GeneratorPhotovoltaic;
262 class GeneratorPVWatts;
263 class GeneratorWindTurbine;
264 class GroundHeatExchangerHorizontalTrench;
265 class GroundHeatExchangerVertical;
266 class HeaderedPumpsConstantSpeed;
267 class HeaderedPumpsVariableSpeed;
268 class HeatBalanceAlgorithm;
269 class HeatExchangerAirToAirSensibleAndLatent;
270 class HeatExchangerDesiccantBalancedFlow;
271 class HeatExchangerDesiccantBalancedFlowPerformanceDataType1;
272 class HeatExchangerFluidToFluid;
273 class HeatPumpAirToWater;
274 class HeatPumpAirToWaterCooling;
275 class HeatPumpAirToWaterHeating;
276 class HeatPumpAirToWaterFuelFiredHeating;
277 class HeatPumpAirToWaterFuelFiredCooling;
278 class HeatPumpWaterToWaterEquationFitCooling;
279 class HeatPumpWaterToWaterEquationFitHeating;
280 class HeatPumpPlantLoopEIRCooling;
281 class HeatPumpPlantLoopEIRHeating;
282 class HotWaterEquipment;
283 class HotWaterEquipmentDefinition;
284 class HumidifierSteamElectric;
285 class HumidifierSteamGas;
286 class IlluminanceMap;
287 class InsideSurfaceConvectionAlgorithm;
288 class InfraredTransparentMaterial;
289 class InteriorPartitionSurface;
290 class InteriorPartitionSurfaceGroup;
291 class InternalMass;
292 class LoadProfilePlant;
293 class LifeCycleCost;
294 class LifeCycleCostParameters;
295 class Lights;
296 class LightsDefinition;
297 class Luminaire;
298 class MaterialPropertyGlazingSpectralData;
299 class MaterialPropertyMoisturePenetrationDepthSettings;
300 class MaterialPropertyPhaseChange;
301 class MaterialPropertyPhaseChangeHysteresis;
302 class MasslessOpaqueMaterial;
303 class MeterCustom;
304 class MeterCustomDecrement;
305 class Node;
306 class OtherEquipment;
307 class OtherEquipmentDefinition;
308 class OutsideSurfaceConvectionAlgorithm;
309 class OutputControlFiles;
310 class OutputControlReportingTolerances;
311 class OutputControlResilienceSummaries;
312 class OutputControlTableStyle;
313 class OutputControlTimestamp;
314 class OutputDebuggingData;
315 class OutputDiagnostics;
316 class OutputJSON;
317 class OutputSQLite;
318 class OutputSchedules;
319 class OutputConstructions;
320 class OutputEnvironmentalImpactFactors;
321 class EnvironmentalImpactFactors;
322 class FuelFactors;
323 class OutputMeter;
324 class OutputVariable;
325 class OutputEnergyManagementSystem;
326 class OutputTableAnnual;
327 class OutputTableMonthly;
328 class OutputTableSummaryReports;
329 class People;
330 class PeopleDefinition;
331 class PerformancePrecisionTradeoffs;
332 class PhotovoltaicPerformanceEquivalentOneDiode;
333 class PhotovoltaicPerformanceSimple;
334 class PhotovoltaicPerformanceSandia;
335 class PipeAdiabatic;
336 class PipeIndoor;
337 class PipeOutdoor;
338 class PlantLoop;
339 class PlantComponentTemperatureSource;
340 class PlantComponentUserDefined;
341 class PlantEquipmentOperationCoolingLoad;
342 class PlantEquipmentOperationHeatingLoad;
343 class PlantEquipmentOperationOutdoorDryBulb;
344 class PlantEquipmentOperationOutdoorWetBulb;
345 class PlantEquipmentOperationOutdoorDewpoint;
346 class PlantEquipmentOperationOutdoorRelativeHumidity;
347 class PlantEquipmentOperationOutdoorDryBulbDifference;
348 class PlantEquipmentOperationOutdoorWetBulbDifference;
349 class PlantEquipmentOperationOutdoorDewpointDifference;
350 class PortList;
351 class PumpConstantSpeed;
352 class PumpVariableSpeed;
353 class PythonPluginInstance;
354 class PythonPluginVariable;
355 class PythonPluginTrendVariable;
356 class PythonPluginOutputVariable;
357 class PythonPluginSearchPaths;
358 class RefractionExtinctionGlazing;
359 class RefrigerationAirChiller;
360 class RefrigerationCase;
361 class RefrigerationCompressor;
362 class RefrigerationCompressorRack;
363 class RefrigerationCondenserAirCooled;
364 class RefrigerationCondenserCascade;
365 class RefrigerationCondenserEvaporativeCooled;
366 class RefrigerationCondenserWaterCooled;
367 class RefrigerationGasCoolerAirCooled;
368 class RefrigerationSubcoolerLiquidSuction;
369 class RefrigerationSubcoolerMechanical;
370 class RefrigerationSecondarySystem;
371 class RefrigerationSystem;
372 class RefrigerationTranscriticalSystem;
373 class RefrigerationWalkIn;
374 class RoofVegetation;
375 class RunPeriod;
376 class RunPeriodControlDaylightSavingTime;
377 class RunPeriodControlSpecialDays;
378 class Screen;
379 class SetpointManagerColdest;
380 class SetpointManagerFollowGroundTemperature;
381 class SetpointManagerFollowOutdoorAirTemperature;
382 class SetpointManagerFollowSystemNodeTemperature;
383 class SetpointManagerMixedAir;
384 class SetpointManagerMultiZoneCoolingAverage;
385 class SetpointManagerMultiZoneHeatingAverage;
386 class SetpointManagerMultiZoneHumidityMaximum;
387 class SetpointManagerMultiZoneHumidityMinimum;
388 class SetpointManagerMultiZoneMaximumHumidityAverage;
389 class SetpointManagerMultiZoneMinimumHumidityAverage;
390 class SetpointManagerOutdoorAirPretreat;
391 class SetpointManagerOutdoorAirReset;
392 class SetpointManagerScheduled;
393 class SetpointManagerScheduledDualSetpoint;
394 class SetpointManagerSingleZoneCooling;
395 class SetpointManagerSingleZoneHeating;
396 class SetpointManagerSingleZoneHumidityMaximum;
397 class SetpointManagerSingleZoneHumidityMinimum;
398 class SetpointManagerSingleZoneOneStageCooling;
399 class SetpointManagerSingleZoneOneStageHeating;
400 class SetpointManagerSingleZoneReheat;
401 class SetpointManagerWarmest;
402 class SetpointManagerWarmestTemperatureFlow;
403 class SetpointManagerSystemNodeResetHumidity;
404 class SetpointManagerSystemNodeResetTemperature;
405 class ShadowCalculation;
406 class Shade;
407 class SimulationControl;
408 class SiteGroundReflectance;
409 class SiteGroundTemperatureBuildingSurface;
410 class SiteGroundTemperatureDeep;
411 class SiteGroundTemperatureFCfactorMethod;
412 class SiteGroundTemperatureShallow;
413 class SiteGroundTemperatureUndisturbedKusudaAchenbach;
414 class SiteGroundTemperatureUndisturbedXing;
415 class SiteWaterMainsTemperature;
416 class SizingParameters;
417 class SizingPlant;
418 class SizingSystem;
419 class SizingZone;
420 class SpaceLoad;
421 class StandardGlazing;
422 class StandardOpaqueMaterial;
423 class SimpleGlazing;
424 class ScheduleCompact;
425 class ScheduleConstant;
426 class ScheduleDay;
427 class ScheduleFile;
428 class ScheduleFixedInterval;
429 class ScheduleRuleset;
430 class ScheduleTypeLimits;
431 class ScheduleVariableInterval;
432 class ScheduleWeek;
433 class ScheduleYear;
434 class ShadingControl;
435 class ShadingSurface;
436 class ShadingSurfaceGroup;
437 class Site;
438 class SkyTemperature;
439 class SolarCollectorFlatPlatePhotovoltaicThermal;
440 class SolarCollectorFlatPlateWater;
441 class SolarCollectorIntegralCollectorStorage;
442 class SolarCollectorPerformanceFlatPlate;
443 class SolarCollectorPerformanceIntegralCollectorStorage;
444 class SolarCollectorPerformancePhotovoltaicThermalBIPVT;
445 class SolarCollectorPerformancePhotovoltaicThermalSimple;
446 class Space;
447 class SpaceInfiltrationDesignFlowRate;
448 class SpaceInfiltrationEffectiveLeakageArea;
449 class SpaceInfiltrationFlowCoefficient;
450 class SpaceVentilationDesignFlowRate;
451 class SpaceType;
452 class SteamEquipment;
453 class SteamEquipmentDefinition;
454 class SubSurface;
455 class Surface;
456 class SurfaceControlMovableInsulation;
457 class SurfacePropertyConvectionCoefficients;
458 class SurfacePropertyConvectionCoefficientsMultipleSurface;
459 class SurfacePropertyLocalEnvironment;
460 class SurfacePropertyExposedFoundationPerimeter;
461 class SurfacePropertyOtherSideCoefficients;
462 class SurfacePropertyOtherSideConditionsModel;
463 class SurfacePropertySurroundingSurfaces;
464 class SurfacePropertyGroundSurfaces;
465 class SurfacePropertyIncidentSolarMultiplier;
466 class SwimmingPoolIndoor;
467 class TableMultiVariableLookup;
468 class TableLookup;
469 class TableIndependentVariable;
470 class TemperingValve;
471 class ThermalZone;
472 class ThermalStorageIceDetailed;
473 class ThermalStorageChilledWaterStratified;
474 class ThermochromicGlazing;
475 class ThermostatSetpointDualSetpoint;
476 class Timestep;
477 class UnitarySystemPerformanceMultispeed;
478 class Version;
479 class WaterHeaterMixed;
480 class WaterHeaterHeatPump;
481 class WaterHeaterHeatPumpWrappedCondenser;
482 class WaterHeaterSizing;
483 class WaterHeaterStratified;
484 class WaterUseConnections;
485 class WaterUseEquipment;
486 class WindowPropertyFrameAndDivider;
487 class ZoneAirContaminantBalance;
488 class ZoneAirHeatBalanceAlgorithm;
489 class ZoneAirMassFlowConservation;
490 class ZoneCapacitanceMultiplierResearchSpecial;
491 class ZoneControlContaminantController;
492 class ZoneControlHumidistat;
493 class ZoneControlThermostatStagedDualSetpoint;
494 class ZoneHVACBaseboardConvectiveElectric;
495 class ZoneHVACBaseboardConvectiveWater;
496 class ZoneHVACBaseboardRadiantConvectiveElectric;
497 class ZoneHVACBaseboardRadiantConvectiveWater;
498 class ZoneHVACCoolingPanelRadiantConvectiveWater;
499 class ZoneHVACDehumidifierDX;
500 class ZoneHVACEnergyRecoveryVentilator;
501 class ZoneHVACEnergyRecoveryVentilatorController;
502 class ZoneHVACEquipmentList;
503 class ZoneHVACEvaporativeCoolerUnit;
504 class ZoneHVACFourPipeFanCoil;
505 class ZoneHVACHighTemperatureRadiant;
506 class ZoneHVACIdealLoadsAirSystem;
507 class ZoneHVACLowTemperatureRadiantElectric;
508 class ZoneHVACLowTempRadiantConstFlow;
509 class ZoneHVACLowTempRadiantVarFlow;
510 class ZoneHVACPackagedTerminalHeatPump;
511 class ZoneHVACPackagedTerminalAirConditioner;
512 class ZoneHVACTerminalUnitVariableRefrigerantFlow;
513 class ZoneHVACUnitHeater;
514 class ZoneHVACUnitVentilator;
515 class ZoneHVACWaterToAirHeatPump;
516 class ZoneMixing;
517 class ZoneMRTCalculation;
518 class ComfortViewFactorAngles;
519 class ZonePropertyUserViewFactorsBySurfaceName;
520 class ZoneVentilationDesignFlowRate;
521 class ZoneVentilationWindandStackOpenArea;
522 } // namespace model
523
524 namespace energyplus {
525
526 namespace detail {
527 struct ForwardTranslatorInitializer;
528
529 // TODO: I have to put this back because of AirTerminalDualDuctVAV which should be using Control for Outdoor Air
530 // I'm setting it up as a free function in detail:: though, so you know you shouldn't call it!
531 boost::optional<IdfObject> translateDesignSpecificationOutdoorAir(model::DesignSpecificationOutdoorAir& modelObject);
532 }; // namespace detail
533
534 #define ENERGYPLUS_VERSION "26.2"
535
536 class ENERGYPLUS_API ForwardTranslator
537 {
538 public:
539 ForwardTranslator();
540
541 /** Translates the given Model to a Workspace.
542 */
543 Workspace translateModel(const model::Model& model, ProgressBar* progressBar = nullptr);
544
545 /** Translates a ModelObject into a Workspace
546 */
547 Workspace translateModelObject(model::ModelObject& modelObject);
548
549 /** Get warning messages generated by the last translation.
550 */
551 std::vector<LogMessage> warnings() const;
552
553 /** Get error messages generated by the last translation.
554 */
555 std::vector<LogMessage> errors() const;
556
557 ForwardTranslatorOptions forwardTranslatorOptions() const;
558
559 void setForwardTranslatorOptions(ForwardTranslatorOptions forwardTranslatorOptions);
560
561 /** @Convenience methods for ForwardTranslatorOptions (and for backward compatibility) */
562 //@{
563 //
564 /** keepRunControlSpecialDays is enabled by default. You can use this method to NOT translate the holidays in the model.
565 */
566 void setKeepRunControlSpecialDays(bool keepRunControlSpecialDays);
567
568 /** If isIP, translate to a Workspace that requests Inch Pound tabular (HTML) reports from EnergyPlus
569 * Use this interface with extreme caution and understanding of the impacts of reporting IP units.
570 * Some assumptions in OpenStudio results processing may fail.
571 */
572 void setIPTabularOutput(bool isIP);
573
574 /** If excludeLCCObjects, skip translation of life cycle cost objects.
575 * Use this interface with extreme caution and understanding of the impacts.
576 * Some assumptions in OpenStudio will fail if you exclude life cycle costs
577 */
578 void setExcludeLCCObjects(bool excludeLCCObjects);
579
580 /** If excludeSQliteOutputReport, do not include the Output:Sqlite object.
581 * Use this at your own risks */
582 void setExcludeSQliteOutputReport(bool excludeSQliteOutputReport);
583
584 /** If excludeHTMLOutputReport, do not include the Output:Table:SummaryReports object.
585 * Use this at your own risks */
586 void setExcludeHTMLOutputReport(bool excludeHTMLOutputReport);
587
588 /** If excludeVariableDictionary, do not include the Output:VariableDictionary object.
589 * Use this at your own risks */
590 void setExcludeVariableDictionary(bool excludeVariableDictionary);
591
592 /** If excludeSpaceTranslation, do usual combineSpaces(), etc. Otherwise, translate space objects.
593 * Use this at your own risks */
594 void setExcludeSpaceTranslation(bool excludeSpaceTranslation);
595
596 /** If excludeSpaceLoadInstances is false, translate SpaceLoads (People, Lights, ElectricEquipment, etc)
597 * to their EnergyPlus ...:Definition / ...:Instance object pairs instead of the legacy combined objects.
598 * Use this at your own risks */
599 void setExcludeSpaceLoadInstances(bool excludeSpaceLoadInstances);
600
601 /** If excludeConstructionAssignmentSets is false, translate DefaultConstructionSet/DefaultSurfaceConstructions/
602 * DefaultSubSurfaceConstructions to the EnergyPlus ConstructionAssignmentSet / SurfaceConstructionAssignments /
603 * SubSurfaceConstructionAssignments objects referenced by Space, instead of resolving and inlining the Construction
604 * Name directly on each Surface/SubSurface/InternalMass. Only takes effect when excludeSpaceTranslation is false
605 * (E+ Space objects are required to reference a ConstructionAssignmentSet).
606 * Use this at your own risks */
607 void setExcludeConstructionAssignmentSets(bool excludeConstructionAssignmentSets);
608
609 //@}
610
611 private:
612 − REGISTER_LOGGER("openstudio.energyplus.ForwardTranslator");
613
614 /** Translates the given Model to a workspace. If fullModelTranslation is true
615 * various "front matter" objects (such as global geometry rules and others) are added to the workspace so that it is fully
616 * prepared for simulation.
617 *
618 * The method translateModelPrivate() carries out its work by explicitly translating the highest level objects in
619 * the model by calling translateAndMapModelObject(). The translateAndMapModelObject method in turn calls a type
620 * specific function to translate the given object. Each type specific function is responsible for translating
621 * not only the direct model object passed into it, but also related model objects under its purview. Related objects
622 * are often identified by an object list reference pointing to them, but this rule is not absolute. For example,
623 * AirLoopHVAC is connected to other components via node connections and the translate function for AirLoopHVAC
624 * is responsible for translating the components associated with the loop. The method translateAndMapModelObject()
625 * uses an internal map to determine if a model object has already been translated, therefore there is no
626 * concern of translating a model object twice, provided that model objects are always translated using the
627 * translateAndMapModelObject() interface as opposed to the type specific translators.
628 */
629 Workspace translateModelPrivate(model::Model& model, bool fullModelTranslation);
630
631 // Pick up the Zone, ZoneList, Space or SpaceList (if allowSpaceType is true) object for a given SpaceLoad (or SpaceLoadInstance)
632 IdfObject getSpaceLoadParent(const model::SpaceLoad& sp, bool allowSpaceType = true);
633
634 // NOLINTBEGIN(readability-function-size, bugprone-branch-clone)
635 boost::optional<IdfObject> translateAndMapModelObject(model::ModelObject& modelObject);
636 // NOLINTEND(readability-function-size, bugprone-branch-clone)
637
638 boost::optional<IdfObject> translateAirConditionerVariableRefrigerantFlow(model::AirConditionerVariableRefrigerantFlow& modelObject);
639
640 boost::optional<IdfObject> translateAirConditionerVariableRefrigerantFlowFluidTemperatureControl(
641 model::AirConditionerVariableRefrigerantFlowFluidTemperatureControl& modelObject);
642
643 boost::optional<IdfObject> translateAirConditionerVariableRefrigerantFlowFluidTemperatureControlHR(
644 model::AirConditionerVariableRefrigerantFlowFluidTemperatureControlHR& modelObject);
645
646 boost::optional<IdfObject> translateAirflowNetworkSimulationControl(model::AirflowNetworkSimulationControl& modelObject);
647
648 boost::optional<IdfObject> translateAirflowNetworkZone(model::AirflowNetworkZone& modelObject);
649
650 boost::optional<IdfObject> translateAirflowNetworkSurface(model::AirflowNetworkSurface& modelObject);
651
652 boost::optional<IdfObject> translateAirflowNetworkReferenceCrackConditions(model::AirflowNetworkReferenceCrackConditions& modelObject);
653
654 boost::optional<IdfObject> translateAirflowNetworkCrack(model::AirflowNetworkCrack& modelObject);
655
656 boost::optional<IdfObject> translateAirflowNetworkEffectiveLeakageArea(model::AirflowNetworkEffectiveLeakageArea& modelObject);
657
658 boost::optional<IdfObject> translateAirflowNetworkDetailedOpening(model::AirflowNetworkDetailedOpening& modelObject);
659
660 boost::optional<IdfObject> translateAirflowNetworkSimpleOpening(model::AirflowNetworkSimpleOpening& modelObject);
661
662 boost::optional<IdfObject> translateAirflowNetworkHorizontalOpening(model::AirflowNetworkHorizontalOpening& modelObject);
663
664 boost::optional<IdfObject> translateAirflowNetworkSpecifiedFlowRate(model::AirflowNetworkSpecifiedFlowRate& modelObject);
665
666 boost::optional<IdfObject> translateAirflowNetworkZoneExhaustFan(model::AirflowNetworkZoneExhaustFan& modelObject);
667
668 boost::optional<IdfObject> translateAirflowNetworkExternalNode(model::AirflowNetworkExternalNode& modelObject);
669
670 boost::optional<IdfObject> translateAirflowNetworkDistributionNode(model::AirflowNetworkDistributionNode& modelObject);
671
672 boost::optional<IdfObject> translateAirflowNetworkLeakageRatio(model::AirflowNetworkLeakageRatio& modelObject);
673
674 boost::optional<IdfObject> translateAirflowNetworkDuct(model::AirflowNetworkDuct& modelObject);
675
676 boost::optional<IdfObject> translateAirflowNetworkFan(model::AirflowNetworkFan& modelObject);
677
678 boost::optional<IdfObject> translateAirflowNetworkEquivalentDuct(model::AirflowNetworkEquivalentDuct& modelObject);
679
680 boost::optional<IdfObject> translateAirflowNetworkConstantPressureDrop(model::AirflowNetworkConstantPressureDrop& modelObject);
681
682 boost::optional<IdfObject> translateAirflowNetworkOutdoorAirflow(model::AirflowNetworkOutdoorAirflow& modelObject);
683
684 boost::optional<IdfObject> translateAirflowNetworkDistributionLinkage(model::AirflowNetworkDistributionLinkage& modelObject);
685
686 boost::optional<IdfObject> translateAirflowNetworkDuctViewFactors(model::AirflowNetworkDuctViewFactors& modelObject);
687
688 boost::optional<IdfObject> translateAirflowNetworkOccupantVentilationControl(model::AirflowNetworkOccupantVentilationControl& modelObject);
689
690 boost::optional<IdfObject> translateAirGap(model::AirGap& modelObject);
691
692 boost::optional<IdfObject> translateAirLoopHVAC(model::AirLoopHVAC& modelObject);
693
694 boost::optional<IdfObject> translateAirLoopHVACOutdoorAirSystem(model::AirLoopHVACOutdoorAirSystem& modelObject);
695
696 boost::optional<IdfObject> translateAirLoopHVACDedicatedOutdoorAirSystem(model::AirLoopHVACDedicatedOutdoorAirSystem& modelObject);
697
698 boost::optional<IdfObject>
699 translateAirLoopHVACUnitaryHeatCoolVAVChangeoverBypass(model::AirLoopHVACUnitaryHeatCoolVAVChangeoverBypass& modelObject);
700
701 boost::optional<IdfObject> translateAirLoopHVACUnitaryHeatPumpAirToAir(model::AirLoopHVACUnitaryHeatPumpAirToAir& modelObject);
702
703 boost::optional<IdfObject>
704 translateAirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed(model::AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed& modelObject);
705
706 boost::optional<IdfObject> translateAirLoopHVACUnitarySystem(model::AirLoopHVACUnitarySystem& modelObject);
707
708 boost::optional<IdfObject> translateAirLoopHVACReturnPlenum(model::AirLoopHVACReturnPlenum& airLoopHVACReturnPlenum);
709
710 boost::optional<IdfObject> translateAirLoopHVACSupplyPlenum(model::AirLoopHVACSupplyPlenum& airLoopHVACSupplyPlenum);
711
712 boost::optional<IdfObject> translateAirLoopHVACZoneMixer(model::AirLoopHVACZoneMixer& modelObject);
713
714 boost::optional<IdfObject> translateAirLoopHVACZoneSplitter(model::AirLoopHVACZoneSplitter& airLoopHVACZoneSplitter);
715
716 boost::optional<IdfObject> translateAirTerminalDualDuctConstantVolume(model::AirTerminalDualDuctConstantVolume& modelObject);
717
718 boost::optional<IdfObject> translateAirTerminalDualDuctVAV(model::AirTerminalDualDuctVAV& modelObject);
719
720 boost::optional<IdfObject> translateAirTerminalDualDuctVAVOutdoorAir(model::AirTerminalDualDuctVAVOutdoorAir& modelObject);
721
722 boost::optional<IdfObject>
723 translateAirTerminalSingleDuctConstantVolumeCooledBeam(model::AirTerminalSingleDuctConstantVolumeCooledBeam& modelObject);
724
725 boost::optional<IdfObject>
726 translateAirTerminalSingleDuctConstantVolumeFourPipeInduction(model::AirTerminalSingleDuctConstantVolumeFourPipeInduction& modelObject);
727
728 boost::optional<IdfObject>
729 translateAirTerminalSingleDuctConstantVolumeFourPipeBeam(model::AirTerminalSingleDuctConstantVolumeFourPipeBeam& modelObject);
730
731 boost::optional<IdfObject> translateAirTerminalSingleDuctConstantVolumeReheat(model::AirTerminalSingleDuctConstantVolumeReheat& modelObject);
732
733 boost::optional<IdfObject> translateAirTerminalSingleDuctParallelPIUReheat(model::AirTerminalSingleDuctParallelPIUReheat& modelObject);
734
735 boost::optional<IdfObject> translateAirTerminalSingleDuctSeriesPIUReheat(model::AirTerminalSingleDuctSeriesPIUReheat& modelObject);
736
737 boost::optional<IdfObject> translateAirTerminalSingleDuctConstantVolumeNoReheat(model::AirTerminalSingleDuctConstantVolumeNoReheat& modelObject);
738
739 boost::optional<IdfObject> translateAirTerminalSingleDuctVAVNoReheat(model::AirTerminalSingleDuctVAVNoReheat& modelObject);
740
741 boost::optional<IdfObject> translateAirTerminalSingleDuctVAVReheat(model::AirTerminalSingleDuctVAVReheat& modelObject);
742
743 boost::optional<IdfObject> translateAirTerminalSingleDuctInletSideMixer(model::AirTerminalSingleDuctInletSideMixer& modelObject);
744
745 boost::optional<IdfObject> translateAirTerminalSingleDuctVAVHeatAndCoolNoReheat(model::AirTerminalSingleDuctVAVHeatAndCoolNoReheat& modelObject);
746
747 boost::optional<IdfObject> translateAirTerminalSingleDuctVAVHeatAndCoolReheat(model::AirTerminalSingleDuctVAVHeatAndCoolReheat& modelObject);
748
749 boost::optional<IdfObject> translateAvailabilityManagerAssignmentList(model::AvailabilityManagerAssignmentList& modelObject);
750
751 boost::optional<IdfObject> translateAvailabilityManagerHybridVentilation(model::AvailabilityManagerHybridVentilation& modelObject);
752
753 boost::optional<IdfObject> translateAvailabilityManagerOptimumStart(model::AvailabilityManagerOptimumStart& modelObject);
754
755 boost::optional<IdfObject> translateAvailabilityManagerDifferentialThermostat(model::AvailabilityManagerDifferentialThermostat& modelObject);
756
757 boost::optional<IdfObject> translateAvailabilityManagerNightVentilation(model::AvailabilityManagerNightVentilation& modelObject);
758
759 boost::optional<IdfObject> translateAvailabilityManagerNightCycle(model::AvailabilityManagerNightCycle& modelObject);
760
761 boost::optional<IdfObject> translateAvailabilityManagerHighTemperatureTurnOn(model::AvailabilityManagerHighTemperatureTurnOn& modelObject);
762
763 boost::optional<IdfObject> translateAvailabilityManagerHighTemperatureTurnOff(model::AvailabilityManagerHighTemperatureTurnOff& modelObject);
764
765 boost::optional<IdfObject> translateAvailabilityManagerLowTemperatureTurnOn(model::AvailabilityManagerLowTemperatureTurnOn& modelObject);
766
767 boost::optional<IdfObject> translateAvailabilityManagerLowTemperatureTurnOff(model::AvailabilityManagerLowTemperatureTurnOff& modelObject);
768
769 boost::optional<IdfObject> translateAvailabilityManagerScheduled(model::AvailabilityManagerScheduled& modelObject);
770
771 boost::optional<IdfObject> translateAvailabilityManagerScheduledOn(model::AvailabilityManagerScheduledOn& modelObject);
772
773 boost::optional<IdfObject> translateAvailabilityManagerScheduledOff(model::AvailabilityManagerScheduledOff& modelObject);
774
775 boost::optional<IdfObject> translateBlind(model::Blind& modelObject);
776
777 boost::optional<IdfObject> translateBoilerHotWater(model::BoilerHotWater& modelObject);
778
779 boost::optional<IdfObject> translateBoilerSteam(model::BoilerSteam& modelObject);
780
781 boost::optional<IdfObject> translateBuilding(model::Building& modelObject);
782
783 boost::optional<IdfObject> translateCentralHeatPumpSystem(model::CentralHeatPumpSystem& modelObject);
784
785 boost::optional<IdfObject> translateCFactorUndergroundWallConstruction(model::CFactorUndergroundWallConstruction& modelObject);
786
787 boost::optional<IdfObject> translateChillerAbsorption(model::ChillerAbsorption& modelObject);
788
789 boost::optional<IdfObject> translateChillerAbsorptionIndirect(model::ChillerAbsorptionIndirect& modelObject);
790
791 boost::optional<IdfObject> translateChillerElectricASHRAE205(model::ChillerElectricASHRAE205& modelObject);
792
793 boost::optional<IdfObject> translateChillerElectricEIR(model::ChillerElectricEIR& modelObject);
794
795 boost::optional<IdfObject> translateChillerElectricReformulatedEIR(model::ChillerElectricReformulatedEIR& modelObject);
796
797 boost::optional<IdfObject> translateChillerHeaterPerformanceElectricEIR(model::ChillerHeaterPerformanceElectricEIR& modelObject);
798
799 boost::optional<IdfObject> translateCoilCoolingDXSingleSpeed(model::CoilCoolingDXSingleSpeed& modelObject);
800
801 boost::optional<IdfObject> translateCoilCoolingDXSingleSpeedWithoutUnitary(model::CoilCoolingDXSingleSpeed& modelObject);
802
803 boost::optional<IdfObject> translateCoilCoolingDXSingleSpeedThermalStorage(model::CoilCoolingDXSingleSpeedThermalStorage& modelObject);
804
805 boost::optional<IdfObject>
806 translateCoilCoolingDXSingleSpeedThermalStorageWithoutUnitary(model::CoilCoolingDXSingleSpeedThermalStorage& modelObject);
807
808 boost::optional<IdfObject> translateCoilCoolingDX(model::CoilCoolingDX& modelObject);
809
810 boost::optional<IdfObject> translateCoilCoolingDXWithoutUnitary(model::CoilCoolingDX& modelObject);
811
812 boost::optional<IdfObject> translateCoilCoolingDXCurveFitPerformance(model::CoilCoolingDXCurveFitPerformance& modelObject);
813
814 boost::optional<IdfObject> translateCoilCoolingDXCurveFitOperatingMode(model::CoilCoolingDXCurveFitOperatingMode& modelObject);
815
816 boost::optional<IdfObject> translateCoilCoolingDXCurveFitSpeed(model::CoilCoolingDXCurveFitSpeed& modelObject);
817
818 boost::optional<IdfObject> translateCoilCoolingDXMultiSpeed(model::CoilCoolingDXMultiSpeed& modelObject);
819
820 boost::optional<IdfObject> translateCoilCoolingDXTwoSpeed(model::CoilCoolingDXTwoSpeed& modelObject);
821
822 boost::optional<IdfObject> translateCoilCoolingDXTwoSpeedWithoutUnitary(model::CoilCoolingDXTwoSpeed& modelObject);
823
824 boost::optional<IdfObject>
825 translateCoilCoolingDXTwoStageWithHumidityControlMode(model::CoilCoolingDXTwoStageWithHumidityControlMode& modelObject);
826
827 boost::optional<IdfObject>
828 translateCoilCoolingDXTwoStageWithHumidityControlModeWithoutUnitary(model::CoilCoolingDXTwoStageWithHumidityControlMode& modelObject);
829
830 boost::optional<IdfObject> translateCoilCoolingDXVariableRefrigerantFlow(model::CoilCoolingDXVariableRefrigerantFlow& modelObject);
831
832 boost::optional<IdfObject> translateCoilCoolingDXVariableRefrigerantFlowFluidTemperatureControl(
833 model::CoilCoolingDXVariableRefrigerantFlowFluidTemperatureControl& modelObject);
834
835 boost::optional<IdfObject> translateCoilCoolingDXVariableSpeed(model::CoilCoolingDXVariableSpeed& modelObject);
836
837 boost::optional<IdfObject> translateCoilCoolingDXVariableSpeedWithoutUnitary(model::CoilCoolingDXVariableSpeed& modelObject);
838
839 boost::optional<IdfObject> translateCoilCoolingWater(model::CoilCoolingWater& modelObject);
840
841 boost::optional<IdfObject> translateCoilCoolingWaterToAirHeatPumpEquationFit(model::CoilCoolingWaterToAirHeatPumpEquationFit& modelObject);
842
843 boost::optional<IdfObject>
844 translateCoilCoolingWaterToAirHeatPumpVariableSpeedEquationFit(model::CoilCoolingWaterToAirHeatPumpVariableSpeedEquationFit& modelObject);
845
846 boost::optional<IdfObject> translateCoilHeatingDesuperheater(model::CoilHeatingDesuperheater& modelObject);
847
848 boost::optional<IdfObject> translateCoilHeatingDXMultiSpeed(model::CoilHeatingDXMultiSpeed& modelObject);
849
850 boost::optional<IdfObject> translateCoilHeatingDXSingleSpeed(model::CoilHeatingDXSingleSpeed& modelObject);
851
852 boost::optional<IdfObject> translateCoilHeatingDXSingleSpeedWithoutUnitary(model::CoilHeatingDXSingleSpeed& modelObject);
853
854 boost::optional<IdfObject> translateCoilHeatingDXVariableRefrigerantFlow(model::CoilHeatingDXVariableRefrigerantFlow& modelObject);
855
856 boost::optional<IdfObject> translateCoilHeatingDXVariableRefrigerantFlowFluidTemperatureControl(
857 model::CoilHeatingDXVariableRefrigerantFlowFluidTemperatureControl& modelObject);
858
859 boost::optional<IdfObject> translateCoilHeatingDXVariableSpeed(model::CoilHeatingDXVariableSpeed& modelObject);
860
861 boost::optional<IdfObject> translateCoilHeatingDXVariableSpeedWithoutUnitary(model::CoilHeatingDXVariableSpeed& modelObject);
862
863 boost::optional<IdfObject> translateCoilHeatingElectric(model::CoilHeatingElectric& modelObject);
864
865 boost::optional<IdfObject> translateCoilHeatingElectricMultiStage(model::CoilHeatingElectricMultiStage& modelObject);
866
867 boost::optional<IdfObject> translateCoilHeatingGas(model::CoilHeatingGas& modelObject);
868
869 boost::optional<IdfObject> translateCoilHeatingGasMultiStage(model::CoilHeatingGasMultiStage& modelObject);
870
871 boost::optional<IdfObject> translateCoilHeatingWater(model::CoilHeatingWater& modelObject);
872
873 boost::optional<IdfObject> translateCoilHeatingWaterToAirHeatPumpEquationFit(model::CoilHeatingWaterToAirHeatPumpEquationFit& modelObject);
874
875 boost::optional<IdfObject>
876 translateCoilHeatingWaterToAirHeatPumpVariableSpeedEquationFit(model::CoilHeatingWaterToAirHeatPumpVariableSpeedEquationFit& modelObject);
877
878 boost::optional<IdfObject> translateCoilPerformanceDXCooling(model::CoilPerformanceDXCooling& modelObject);
879
880 boost::optional<IdfObject> translateCoilSystemCoolingDXHeatExchangerAssisted(model::CoilSystemCoolingDXHeatExchangerAssisted& modelObject);
881
882 boost::optional<IdfObject> translateCoilSystemCoolingWater(model::CoilSystemCoolingWater& modelObject);
883
884 boost::optional<IdfObject> translateCoilSystemCoolingWaterHeatExchangerAssisted(model::CoilSystemCoolingWaterHeatExchangerAssisted& modelObject);
885
886 boost::optional<IdfObject> translateCoilSystemIntegratedHeatPumpAirSource(model::CoilSystemIntegratedHeatPumpAirSource& modelObject);
887
888 boost::optional<IdfObject> translateCoilUserDefined(model::CoilUserDefined& modelObject);
889
890 boost::optional<IdfObject> translateCoilWaterHeatingDesuperheater(model::CoilWaterHeatingDesuperheater& modelObject);
891
892 boost::optional<IdfObject> translateCoilWaterHeatingAirToWaterHeatPump(model::CoilWaterHeatingAirToWaterHeatPump& modelObject);
893
894 boost::optional<IdfObject>
895 translateCoilWaterHeatingAirToWaterHeatPumpVariableSpeed(model::CoilWaterHeatingAirToWaterHeatPumpVariableSpeed& modelObject);
896
897 boost::optional<IdfObject> translateCoilWaterHeatingAirToWaterHeatPumpWrapped(model::CoilWaterHeatingAirToWaterHeatPumpWrapped& modelObject);
898
899 boost::optional<IdfObject> translateConstruction(model::Construction& modelObject);
900
901 boost::optional<IdfObject> translateConstructionAirBoundary(model::ConstructionAirBoundary& modelObject);
902
903 boost::optional<IdfObject> translateConstructionWithInternalSource(model::ConstructionWithInternalSource& modelObject);
904
905 boost::optional<IdfObject> translateControllerMechanicalVentilation(model::ControllerMechanicalVentilation& modelObject);
906
907 boost::optional<IdfObject> translateControllerOutdoorAir(model::ControllerOutdoorAir& modelObject);
908
909 boost::optional<IdfObject> translateControllerWaterCoil(model::ControllerWaterCoil& modelObject);
910
911 boost::optional<IdfObject> translateConvergenceLimits(model::ConvergenceLimits& modelObject);
912
913 boost::optional<IdfObject> translateCoolingTowerPerformanceCoolTools(model::CoolingTowerPerformanceCoolTools& modelObject);
914
915 boost::optional<IdfObject> translateCoolingTowerPerformanceYorkCalc(model::CoolingTowerPerformanceYorkCalc& modelObject);
916
917 boost::optional<IdfObject> translateCoolingTowerTwoSpeed(model::CoolingTowerTwoSpeed& modelObject);
918
919 boost::optional<IdfObject> translateCoolingTowerSingleSpeed(model::CoolingTowerSingleSpeed& modelObject);
920
921 boost::optional<IdfObject> translateCoolingTowerVariableSpeed(model::CoolingTowerVariableSpeed& modelObject);
922
923 boost::optional<IdfObject> translateCurrencyType(model::CurrencyType& modelObject);
924
925 boost::optional<IdfObject> translateCurveBicubic(model::CurveBicubic& modelObject);
926
927 boost::optional<IdfObject> translateCurveBiquadratic(model::CurveBiquadratic& modelObject);
928
929 boost::optional<IdfObject> translateCurveCubic(model::CurveCubic& modelObject);
930
931 boost::optional<IdfObject> translateCurveDoubleExponentialDecay(model::CurveDoubleExponentialDecay& modelObject);
932
933 boost::optional<IdfObject> translateCurveExponent(model::CurveExponent& modelObject);
934
935 boost::optional<IdfObject> translateCurveExponentialDecay(model::CurveExponentialDecay& modelObject);
936
937 boost::optional<IdfObject> translateCurveExponentialSkewNormal(model::CurveExponentialSkewNormal& modelObject);
938
939 boost::optional<IdfObject> translateCurveFanPressureRise(model::CurveFanPressureRise& modelObject);
940
941 boost::optional<IdfObject> translateCurveFunctionalPressureDrop(model::CurveFunctionalPressureDrop& modelObject);
942
943 boost::optional<IdfObject> translateCurveLinear(model::CurveLinear& modelObject);
944
945 boost::optional<IdfObject> translateCurveQuadLinear(model::CurveQuadLinear& modelObject);
946
947 boost::optional<IdfObject> translateCurveQuintLinear(model::CurveQuintLinear& modelObject);
948
949 boost::optional<IdfObject> translateCurveQuadratic(model::CurveQuadratic& modelObject);
950
951 boost::optional<IdfObject> translateCurveQuadraticLinear(model::CurveQuadraticLinear& modelObject);
952
953 boost::optional<IdfObject> translateCurveQuartic(model::CurveQuartic& modelObject);
954
955 boost::optional<IdfObject> translateCurveRectangularHyperbola1(model::CurveRectangularHyperbola1& modelObject);
956
957 boost::optional<IdfObject> translateCurveRectangularHyperbola2(model::CurveRectangularHyperbola2& modelObject);
958
959 boost::optional<IdfObject> translateCurveSigmoid(model::CurveSigmoid& modelObject);
960
961 boost::optional<IdfObject> translateCurveTriquadratic(model::CurveTriquadratic& modelObject);
962
963 boost::optional<IdfObject> translateDaylightingControl(model::DaylightingControl& modelObject);
964
965 boost::optional<IdfObject> translateDaylightingDeviceShelf(model::DaylightingDeviceShelf& modelObject);
966
967 boost::optional<IdfObject> translateDaylightingDeviceTubular(model::DaylightingDeviceTubular& modelObject);
968
969 boost::optional<IdfObject> translateDaylightingDeviceLightWell(model::DaylightingDeviceLightWell& modelObject);
970
971 boost::optional<IdfObject> translateDaylightRedirectionDevice(model::DaylightRedirectionDevice& modelObject);
972
973 boost::optional<IdfObject> translateDefaultConstructionSet(model::DefaultConstructionSet& modelObject);
974 boost::optional<IdfObject> translateDefaultSurfaceConstructions(model::DefaultSurfaceConstructions& modelObject);
975 boost::optional<IdfObject> translateDefaultSubSurfaceConstructions(model::DefaultSubSurfaceConstructions& modelObject);
976 // When Space translation is excluded there is no E+ Space, so defaulted constructions would end up unresolved. This function hard-assigns
977 // constructions to all surfaces, subsurfaces and interior partitions in the model that have defaulted constructions, using the
978 // DefaultConstructionSet at the Space, SpaceType and BuildingStory level. Implemented in ForwardTranslateDefaultConstructionSet.cpp.
979 static void hardApplyConstructionsWhenSpaceTranslationOff(model::Model& model);
980
981 boost::optional<IdfObject> translateDesignDay(model::DesignDay& modelObject);
982
983 // Construct (or fetch if already created) a DesignSpecificationOutdoorAir (DSOA) or DSOA:SpaceList
984 // * if there are no spaces with a DSOA assigned: return empty
985 // * otherwise:
986 // * otherwise:
987 // * if we translated to E+ with spaces:
988 // * If a single one: DSOA, otherwise create a DSOA:SpaceList
989 // * if we do not use E+ spaces: create DSOA
990 boost::optional<IdfObject> getOrCreateThermalZoneDSOA(const model::ThermalZone& z);
991
992 boost::optional<IdfObject> translateDistrictCooling(model::DistrictCooling& modelObject);
993
994 boost::optional<IdfObject> translateDistrictHeatingWater(model::DistrictHeatingWater& modelObject);
995
996 boost::optional<IdfObject> translateDistrictHeatingSteam(model::DistrictHeatingSteam& modelObject);
997
998 boost::optional<IdfObject> translateDuct(model::Duct& modelObject);
999
1000 boost::optional<IdfObject> translateElectricEquipment(model::ElectricEquipment& modelObject);
1001 boost::optional<IdfObject> translateElectricEquipmentLegacy(model::ElectricEquipment& modelObject);
1002 boost::optional<IdfObject> translateElectricEquipmentInstance(model::ElectricEquipment& modelObject);
1003 boost::optional<IdfObject> translateElectricEquipmentDefinition(model::ElectricEquipmentDefinition& modelObject);
1004
1005 boost::optional<IdfObject> translateElectricEquipmentITEAirCooled(model::ElectricEquipmentITEAirCooled& modelObject);
1006 boost::optional<IdfObject> translateElectricEquipmentITEAirCooledLegacy(model::ElectricEquipmentITEAirCooled& modelObject);
1007 boost::optional<IdfObject> translateElectricEquipmentITEAirCooledInstance(model::ElectricEquipmentITEAirCooled& modelObject);
1008 boost::optional<IdfObject> translateElectricEquipmentITEAirCooledDefinition(model::ElectricEquipmentITEAirCooledDefinition& modelObject);
1009
1010 boost::optional<IdfObject> translateElectricLoadCenterDistribution(model::ElectricLoadCenterDistribution& modelObject);
1011
1012 boost::optional<IdfObject> translateElectricLoadCenterInverterLookUpTable(model::ElectricLoadCenterInverterLookUpTable& modelObject);
1013
1014 boost::optional<IdfObject> translateElectricLoadCenterInverterSimple(model::ElectricLoadCenterInverterSimple& modelObject);
1015
1016 boost::optional<IdfObject> translateElectricLoadCenterInverterPVWatts(model::ElectricLoadCenterInverterPVWatts& modelObject);
1017
1018 boost::optional<IdfObject> translateElectricLoadCenterStorageSimple(model::ElectricLoadCenterStorageSimple& modelObject);
1019
1020 boost::optional<IdfObject> translateElectricLoadCenterStorageConverter(model::ElectricLoadCenterStorageConverter& modelObject);
1021
1022 boost::optional<IdfObject> translateElectricLoadCenterStorageLiIonNMCBattery(model::ElectricLoadCenterStorageLiIonNMCBattery& modelObject);
1023
1024 boost::optional<IdfObject> translateElectricLoadCenterTransformer(model::ElectricLoadCenterTransformer& modelObject);
1025
1026 boost::optional<IdfObject> translateEnergyManagementSystemActuator(model::EnergyManagementSystemActuator& modelObject);
1027
1028 boost::optional<IdfObject>
1029 translateEnergyManagementSystemConstructionIndexVariable(model::EnergyManagementSystemConstructionIndexVariable& modelObject);
1030
1031 boost::optional<IdfObject>
1032 translateEnergyManagementSystemCurveOrTableIndexVariable(model::EnergyManagementSystemCurveOrTableIndexVariable& modelObject);
1033
1034 boost::optional<IdfObject> translateEnergyManagementSystemGlobalVariable(model::EnergyManagementSystemGlobalVariable& modelObject);
1035
1036 boost::optional<IdfObject> translateEnergyManagementSystemInternalVariable(model::EnergyManagementSystemInternalVariable& modelObject);
1037
1038 boost::optional<IdfObject> translateEnergyManagementSystemMeteredOutputVariable(model::EnergyManagementSystemMeteredOutputVariable& modelObject);
1039
1040 boost::optional<IdfObject> translateEnergyManagementSystemOutputVariable(model::EnergyManagementSystemOutputVariable& modelObject);
1041
1042 boost::optional<IdfObject> translateEnergyManagementSystemProgram(model::EnergyManagementSystemProgram& modelObject);
1043
1044 boost::optional<IdfObject> translateEnergyManagementSystemProgramCallingManager(model::EnergyManagementSystemProgramCallingManager& modelObject);
1045
1046 boost::optional<IdfObject> translateEnergyManagementSystemSensor(model::EnergyManagementSystemSensor& modelObject);
1047
1048 boost::optional<IdfObject> translateEnergyManagementSystemSubroutine(model::EnergyManagementSystemSubroutine& modelObject);
1049
1050 boost::optional<IdfObject> translateEnergyManagementSystemTrendVariable(model::EnergyManagementSystemTrendVariable& modelObject);
1051
1052 boost::optional<IdfObject> translateEvaporativeFluidCoolerSingleSpeed(model::EvaporativeFluidCoolerSingleSpeed& modelObject);
1053
1054 boost::optional<IdfObject> translateEvaporativeFluidCoolerTwoSpeed(model::EvaporativeFluidCoolerTwoSpeed& modelObject);
1055
1056 boost::optional<IdfObject> translateExteriorLights(model::ExteriorLights& modelObject);
1057
1058 boost::optional<IdfObject> translateExteriorFuelEquipment(model::ExteriorFuelEquipment& modelObject);
1059
1060 boost::optional<IdfObject> translateExteriorWaterEquipment(model::ExteriorWaterEquipment& modelObject);
1061
1062 boost::optional<IdfObject> translateExternalInterface(model::ExternalInterface& modelObject);
1063
1064 boost::optional<IdfObject> translateExternalInterfaceActuator(model::ExternalInterfaceActuator& modelObject);
1065
1066 boost::optional<IdfObject>
1067 translateExternalInterfaceFunctionalMockupUnitExportFromVariable(model::ExternalInterfaceFunctionalMockupUnitExportFromVariable& modelObject);
1068
1069 boost::optional<IdfObject>
1070 translateExternalInterfaceFunctionalMockupUnitExportToActuator(model::ExternalInterfaceFunctionalMockupUnitExportToActuator& modelObject);
1071
1072 boost::optional<IdfObject>
1073 translateExternalInterfaceFunctionalMockupUnitExportToSchedule(model::ExternalInterfaceFunctionalMockupUnitExportToSchedule& modelObject);
1074
1075 boost::optional<IdfObject>
1076 translateExternalInterfaceFunctionalMockupUnitExportToVariable(model::ExternalInterfaceFunctionalMockupUnitExportToVariable& modelObject);
1077
1078 boost::optional<IdfObject> translateExternalInterfaceFunctionalMockupUnitImport(model::ExternalInterfaceFunctionalMockupUnitImport& modelObject);
1079
1080 boost::optional<IdfObject>
1081 translateExternalInterfaceFunctionalMockupUnitImportFromVariable(model::ExternalInterfaceFunctionalMockupUnitImportFromVariable& modelObject);
1082
1083 boost::optional<IdfObject>
1084 translateExternalInterfaceFunctionalMockupUnitImportToActuator(model::ExternalInterfaceFunctionalMockupUnitImportToActuator& modelObject);
1085
1086 boost::optional<IdfObject>
1087 translateExternalInterfaceFunctionalMockupUnitImportToSchedule(model::ExternalInterfaceFunctionalMockupUnitImportToSchedule& modelObject);
1088
1089 boost::optional<IdfObject>
1090 translateExternalInterfaceFunctionalMockupUnitImportToVariable(model::ExternalInterfaceFunctionalMockupUnitImportToVariable& modelObject);
1091
1092 boost::optional<IdfObject> translateExternalInterfaceSchedule(model::ExternalInterfaceSchedule& modelObject);
1093
1094 boost::optional<IdfObject> translateExternalInterfaceVariable(model::ExternalInterfaceVariable& modelObject);
1095
1096 boost::optional<IdfObject> translateFanComponentModel(model::FanComponentModel& modelObject);
1097
1098 boost::optional<IdfObject> translateFanConstantVolume(model::FanConstantVolume& modelObject);
1099
1100 boost::optional<IdfObject> translateFanOnOff(model::FanOnOff& modelObject);
1101
1102 boost::optional<IdfObject> translateFanSystemModel(model::FanSystemModel& modelObject);
1103
1104 boost::optional<IdfObject> translateFanVariableVolume(model::FanVariableVolume& modelObject);
1105
1106 boost::optional<IdfObject> translateFanZoneExhaust(model::FanZoneExhaust& modelObject);
1107
1108 boost::optional<IdfObject> translateEvaporativeCoolerDirectResearchSpecial(model::EvaporativeCoolerDirectResearchSpecial& modelObject);
1109
1110 boost::optional<IdfObject> translateEvaporativeCoolerIndirectResearchSpecial(model::EvaporativeCoolerIndirectResearchSpecial& modelObject);
1111
1112 boost::optional<IdfObject> translateFFactorGroundFloorConstruction(model::FFactorGroundFloorConstruction& modelObject);
1113
1114 boost::optional<IdfObject> translateFluidCoolerSingleSpeed(model::FluidCoolerSingleSpeed& modelObject);
1115
1116 boost::optional<IdfObject> translateFluidCoolerTwoSpeed(model::FluidCoolerTwoSpeed& modelObject);
1117
1118 boost::optional<IdfObject> translateFoundationKiva(model::FoundationKiva& modelObject);
1119
1120 boost::optional<IdfObject> translateFoundationKivaSettings(model::FoundationKivaSettings& modelObject);
1121
1122 boost::optional<IdfObject> translateGas(model::Gas& modelObject);
1123
1124 boost::optional<IdfObject> translateGasEquipment(model::GasEquipment& modelObject);
1125 boost::optional<IdfObject> translateGasEquipmentLegacy(model::GasEquipment& modelObject);
1126 boost::optional<IdfObject> translateGasEquipmentInstance(model::GasEquipment& modelObject);
1127 boost::optional<IdfObject> translateGasEquipmentDefinition(model::GasEquipmentDefinition& modelObject);
1128
1129 boost::optional<IdfObject> translateGasMixture(model::GasMixture& modelObject);
1130
1131 boost::optional<IdfObject> translateGeneratorMicroTurbine(model::GeneratorMicroTurbine& modelObject);
1132
1133 boost::optional<IdfObject> translateGeneratorFuelCell(model::GeneratorFuelCell& modelObject);
1134 boost::optional<IdfObject> translateGeneratorFuelCellAirSupply(model::GeneratorFuelCellAirSupply& modelObject);
1135 boost::optional<IdfObject> translateGeneratorFuelCellAuxiliaryHeater(model::GeneratorFuelCellAuxiliaryHeater& modelObject);
1136 boost::optional<IdfObject> translateGeneratorFuelCellElectricalStorage(model::GeneratorFuelCellElectricalStorage& modelObject);
1137 boost::optional<IdfObject>
1138 translateGeneratorFuelCellExhaustGasToWaterHeatExchanger(model::GeneratorFuelCellExhaustGasToWaterHeatExchanger& modelObject);
1139 boost::optional<IdfObject> translateGeneratorFuelCellInverter(model::GeneratorFuelCellInverter& modelObject);
1140 boost::optional<IdfObject> translateGeneratorFuelCellPowerModule(model::GeneratorFuelCellPowerModule& modelObject);
1141 boost::optional<IdfObject> translateGeneratorFuelCellStackCooler(model::GeneratorFuelCellStackCooler& modelObject);
1142 boost::optional<IdfObject> translateGeneratorFuelCellWaterSupply(model::GeneratorFuelCellWaterSupply& modelObject);
1143 boost::optional<IdfObject> translateGeneratorFuelSupply(model::GeneratorFuelSupply& modelObject);
1144
1145 boost::optional<IdfObject> translateGeneratorPhotovoltaic(model::GeneratorPhotovoltaic& modelObject);
1146
1147 boost::optional<IdfObject> translateGeneratorPVWatts(model::GeneratorPVWatts& modelObject);
1148
1149 boost::optional<IdfObject> translateGeneratorWindTurbine(model::GeneratorWindTurbine& modelObject);
1150
1151 boost::optional<IdfObject> translateGroundHeatExchangerHorizontalTrench(model::GroundHeatExchangerHorizontalTrench& modelObject);
1152
1153 boost::optional<IdfObject> translateGroundHeatExchangerVertical(model::GroundHeatExchangerVertical& modelObject);
1154
1155 boost::optional<IdfObject> translateHeaderedPumpsConstantSpeed(model::HeaderedPumpsConstantSpeed& modelObject);
1156
1157 boost::optional<IdfObject> translateHeaderedPumpsVariableSpeed(model::HeaderedPumpsVariableSpeed& modelObject);
1158
1159 boost::optional<IdfObject> translateHeatBalanceAlgorithm(model::HeatBalanceAlgorithm& modelObject);
1160
1161 boost::optional<IdfObject> translateHeatExchangerAirToAirSensibleAndLatent(model::HeatExchangerAirToAirSensibleAndLatent& modelObject);
1162
1163 boost::optional<IdfObject> translateHeatExchangerDesiccantBalancedFlow(model::HeatExchangerDesiccantBalancedFlow& modelObject);
1164
1165 boost::optional<IdfObject>
1166 translateHeatExchangerDesiccantBalancedFlowPerformanceDataType1(model::HeatExchangerDesiccantBalancedFlowPerformanceDataType1& modelObject);
1167
1168 boost::optional<IdfObject> translateHeatExchangerFluidToFluid(model::HeatExchangerFluidToFluid& modelObject);
1169
1170 boost::optional<IdfObject> translateHeatPumpAirToWater(model::HeatPumpAirToWater& modelObject);
1171 void translateHeatPumpAirToWaterCooling(model::HeatPumpAirToWaterCooling& modelObject, IdfObject& idfObject);
1172 void translateHeatPumpAirToWaterHeating(model::HeatPumpAirToWaterHeating& modelObject, IdfObject& idfObject);
1173
1174 boost::optional<IdfObject> translateHeatPumpAirToWaterFuelFiredHeating(model::HeatPumpAirToWaterFuelFiredHeating& modelObject);
1175
1176 boost::optional<IdfObject> translateHeatPumpAirToWaterFuelFiredCooling(model::HeatPumpAirToWaterFuelFiredCooling& modelObject);
1177
1178 boost::optional<IdfObject> translateHeatPumpWaterToWaterEquationFitCooling(model::HeatPumpWaterToWaterEquationFitCooling& modelObject);
1179
1180 boost::optional<IdfObject> translateHeatPumpWaterToWaterEquationFitHeating(model::HeatPumpWaterToWaterEquationFitHeating& modelObject);
1181
1182 boost::optional<IdfObject> translateHeatPumpPlantLoopEIRCooling(model::HeatPumpPlantLoopEIRCooling& modelObject);
1183
1184 boost::optional<IdfObject> translateHeatPumpPlantLoopEIRHeating(model::HeatPumpPlantLoopEIRHeating& modelObject);
1185
1186 boost::optional<IdfObject> translateHumidifierSteamElectric(model::HumidifierSteamElectric& modelObject);
1187
1188 boost::optional<IdfObject> translateHumidifierSteamGas(model::HumidifierSteamGas& modelObject);
1189
1190 boost::optional<IdfObject> translateHotWaterEquipment(model::HotWaterEquipment& modelObject);
1191 boost::optional<IdfObject> translateHotWaterEquipmentLegacy(model::HotWaterEquipment& modelObject);
1192 boost::optional<IdfObject> translateHotWaterEquipmentInstance(model::HotWaterEquipment& modelObject);
1193 boost::optional<IdfObject> translateHotWaterEquipmentDefinition(model::HotWaterEquipmentDefinition& modelObject);
1194
1195 boost::optional<IdfObject> translateIlluminanceMap(model::IlluminanceMap& modelObject);
1196
1197 boost::optional<IdfObject> translateInfraredTransparentMaterial(model::InfraredTransparentMaterial& modelObject);
1198
1199 boost::optional<IdfObject> translateInsideSurfaceConvectionAlgorithm(model::InsideSurfaceConvectionAlgorithm& modelObject);
1200
1201 boost::optional<IdfObject> translateInteriorPartitionSurface(model::InteriorPartitionSurface& modelObject);
1202
1203 boost::optional<IdfObject> translateInteriorPartitionSurfaceGroup(model::InteriorPartitionSurfaceGroup& modelObject);
1204
1205 boost::optional<IdfObject> translateInternalMass(model::InternalMass& modelObject);
1206
1207 boost::optional<IdfObject> translateLoadProfilePlant(model::LoadProfilePlant& modelObject);
1208
1209 boost::optional<IdfObject> translateLifeCycleCost(model::LifeCycleCost& modelObject);
1210
1211 boost::optional<IdfObject> translateLifeCycleCostParameters(model::LifeCycleCostParameters& modelObject);
1212
1213 boost::optional<IdfObject> translateLights(model::Lights& modelObject);
1214 boost::optional<IdfObject> translateLightsLegacy(model::Lights& modelObject);
1215 boost::optional<IdfObject> translateLightsInstance(model::Lights& modelObject);
1216 boost::optional<IdfObject> translateLightsDefinition(model::LightsDefinition& modelObject);
1217
1218 boost::optional<IdfObject> translateLuminaire(model::Luminaire& modelObject);
1219
1220 boost::optional<IdfObject> translateMaterialPropertyGlazingSpectralData(model::MaterialPropertyGlazingSpectralData& modelObject);
1221
1222 boost::optional<IdfObject>
1223 translateMaterialPropertyMoisturePenetrationDepthSettings(model::MaterialPropertyMoisturePenetrationDepthSettings& modelObject);
1224
1225 boost::optional<IdfObject> translateMaterialPropertyPhaseChange(model::MaterialPropertyPhaseChange& modelObject);
1226
1227 boost::optional<IdfObject> translateMaterialPropertyPhaseChangeHysteresis(model::MaterialPropertyPhaseChangeHysteresis& modelObject);
1228
1229 boost::optional<IdfObject> translateMasslessOpaqueMaterial(model::MasslessOpaqueMaterial& modelObject);
1230
1231 boost::optional<IdfObject> translateMeterCustom(model::MeterCustom& modelObject);
1232
1233 boost::optional<IdfObject> translateMeterCustomDecrement(model::MeterCustomDecrement& modelObject);
1234
1235 boost::optional<IdfObject> translateNode(model::Node& modelObject);
1236
1237 boost::optional<IdfObject> translateOtherEquipment(model::OtherEquipment& modelObject);
1238 boost::optional<IdfObject> translateOtherEquipmentLegacy(model::OtherEquipment& modelObject);
1239 boost::optional<IdfObject> translateOtherEquipmentInstance(model::OtherEquipment& modelObject);
1240 boost::optional<IdfObject> translateOtherEquipmentDefinition(model::OtherEquipmentDefinition& modelObject);
1241
1242 boost::optional<IdfObject> translateOutsideSurfaceConvectionAlgorithm(model::OutsideSurfaceConvectionAlgorithm& modelObject);
1243
1244 boost::optional<IdfObject> translateOutputControlFiles(model::OutputControlFiles& modelObject);
1245
1246 boost::optional<IdfObject> translateOutputControlReportingTolerances(model::OutputControlReportingTolerances& modelObject);
1247
1248 boost::optional<IdfObject> translateOutputControlResilienceSummaries(model::OutputControlResilienceSummaries& modelObject);
1249
1250 boost::optional<IdfObject> translateOutputControlTableStyle(model::OutputControlTableStyle& modelObject);
1251
1252 boost::optional<IdfObject> translateOutputControlTimestamp(model::OutputControlTimestamp& modelObject);
1253
1254 boost::optional<IdfObject> translateOutputDebuggingData(model::OutputDebuggingData& modelObject);
1255
1256 boost::optional<IdfObject> translateOutputDiagnostics(model::OutputDiagnostics& modelObject);
1257
1258 boost::optional<IdfObject> translateOutputJSON(model::OutputJSON& modelObject);
1259
1260 boost::optional<IdfObject> translateOutputSQLite(model::OutputSQLite& modelObject);
1261
1262 boost::optional<IdfObject> translateOutputSchedules(model::OutputSchedules& modelObject);
1263
1264 boost::optional<IdfObject> translateOutputConstructions(model::OutputConstructions& modelObject);
1265
1266 boost::optional<IdfObject> translateOutputEnvironmentalImpactFactors(model::OutputEnvironmentalImpactFactors& modelObject);
1267
1268 boost::optional<IdfObject> translateEnvironmentalImpactFactors(model::EnvironmentalImpactFactors& modelObject);
1269
1270 boost::optional<IdfObject> translateFuelFactors(model::FuelFactors& modelObject);
1271
1272 boost::optional<IdfObject> translateOutputMeter(model::OutputMeter& modelObject);
1273
1274 boost::optional<IdfObject> translateOutputVariable(model::OutputVariable& modelObject);
1275
1276 boost::optional<IdfObject> translateOutputEnergyManagementSystem(model::OutputEnergyManagementSystem& modelObject);
1277
1278 boost::optional<IdfObject> translateOutputTableSummaryReports(model::OutputTableSummaryReports& modelObject);
1279
1280 boost::optional<IdfObject> translateOutputTableAnnual(model::OutputTableAnnual& modelObject);
1281
1282 boost::optional<IdfObject> translateOutputTableMonthly(model::OutputTableMonthly& modelObject);
1283
1284 boost::optional<IdfObject> translatePeople(model::People& modelObject);
1285 boost::optional<IdfObject> translatePeopleLegacy(model::People& modelObject);
1286 boost::optional<IdfObject> translatePeopleInstance(model::People& modelObject);
1287 boost::optional<IdfObject> translatePeopleDefinition(model::PeopleDefinition& modelObject);
1288
1289 boost::optional<IdfObject> translatePerformancePrecisionTradeoffs(model::PerformancePrecisionTradeoffs& modelObject);
1290
1291 boost::optional<IdfObject> translatePhotovoltaicPerformanceEquivalentOneDiode(model::PhotovoltaicPerformanceEquivalentOneDiode& modelObject);
1292
1293 boost::optional<IdfObject> translatePhotovoltaicPerformanceSimple(model::PhotovoltaicPerformanceSimple& modelObject);
1294
1295 boost::optional<IdfObject> translatePhotovoltaicPerformanceSandia(model::PhotovoltaicPerformanceSandia& modelObject);
1296
1297 boost::optional<IdfObject> translatePipeAdiabatic(model::PipeAdiabatic& modelObject);
1298
1299 boost::optional<IdfObject> translatePipeIndoor(model::PipeIndoor& modelObject);
1300
1301 boost::optional<IdfObject> translatePipeOutdoor(model::PipeOutdoor& modelObject);
1302
1303 boost::optional<IdfObject> translatePlantLoop(model::PlantLoop& modelObject);
1304
1305 boost::optional<IdfObject> translatePlantComponentTemperatureSource(model::PlantComponentTemperatureSource& modelObject);
1306
1307 boost::optional<IdfObject> translatePlantComponentUserDefined(model::PlantComponentUserDefined& modelObject);
1308
1309 boost::optional<IdfObject> translatePlantEquipmentOperationSchemes(model::PlantLoop& plantLoop);
1310
1311 boost::optional<IdfObject> translatePlantEquipmentOperationCoolingLoad(model::PlantEquipmentOperationCoolingLoad& modelObject);
1312
1313 boost::optional<IdfObject> translatePlantEquipmentOperationHeatingLoad(model::PlantEquipmentOperationHeatingLoad& modelObject);
1314
1315 boost::optional<IdfObject> translatePlantEquipmentOperationOutdoorDryBulb(model::PlantEquipmentOperationOutdoorDryBulb& modelObject);
1316
1317 boost::optional<IdfObject> translatePlantEquipmentOperationOutdoorWetBulb(model::PlantEquipmentOperationOutdoorWetBulb& modelObject);
1318
1319 boost::optional<IdfObject> translatePlantEquipmentOperationOutdoorDewpoint(model::PlantEquipmentOperationOutdoorDewpoint& modelObject);
1320
1321 boost::optional<IdfObject>
1322 translatePlantEquipmentOperationOutdoorRelativeHumidity(model::PlantEquipmentOperationOutdoorRelativeHumidity& modelObject);
1323
1324 boost::optional<IdfObject>
1325 translatePlantEquipmentOperationOutdoorDryBulbDifference(model::PlantEquipmentOperationOutdoorDryBulbDifference& modelObject);
1326
1327 boost::optional<IdfObject>
1328 translatePlantEquipmentOperationOutdoorWetBulbDifference(model::PlantEquipmentOperationOutdoorWetBulbDifference& modelObject);
1329
1330 boost::optional<IdfObject>
1331 translatePlantEquipmentOperationOutdoorDewpointDifference(model::PlantEquipmentOperationOutdoorDewpointDifference& modelObject);
1332
1333 boost::optional<IdfObject> translatePortList(model::PortList& modelObject);
1334
1335 boost::optional<IdfObject> translatePumpConstantSpeed(model::PumpConstantSpeed& modelObject);
1336
1337 boost::optional<IdfObject> translatePumpVariableSpeed(model::PumpVariableSpeed& modelObject);
1338
1339 boost::optional<IdfObject> translatePythonPluginInstance(model::PythonPluginInstance& modelObject);
1340
1341 boost::optional<IdfObject> translatePythonPluginVariable(model::PythonPluginVariable& modelObject);
1342
1343 boost::optional<IdfObject> translatePythonPluginTrendVariable(model::PythonPluginTrendVariable& modelObject);
1344
1345 boost::optional<IdfObject> translatePythonPluginOutputVariable(model::PythonPluginOutputVariable& modelObject);
1346
1347 boost::optional<IdfObject> translatePythonPluginSearchPaths(model::PythonPluginSearchPaths& modelObject);
1348
1349 boost::optional<IdfObject> translateRefractionExtinctionGlazing(model::RefractionExtinctionGlazing& modelObject);
1350
1351 boost::optional<IdfObject> translateRefrigerationAirChiller(model::RefrigerationAirChiller& modelObject);
1352
1353 boost::optional<IdfObject> translateRefrigerationCase(model::RefrigerationCase& modelObject);
1354
1355 boost::optional<IdfObject> translateRefrigerationCompressor(model::RefrigerationCompressor& modelObject);
1356
1357 boost::optional<IdfObject> translateRefrigerationCompressorRack(model::RefrigerationCompressorRack& modelObject);
1358
1359 boost::optional<IdfObject> translateRefrigerationCondenserAirCooled(model::RefrigerationCondenserAirCooled& modelObject);
1360
1361 boost::optional<IdfObject> translateRefrigerationCondenserCascade(model::RefrigerationCondenserCascade& modelObject);
1362
1363 boost::optional<IdfObject> translateRefrigerationCondenserEvaporativeCooled(model::RefrigerationCondenserEvaporativeCooled& modelObject);
1364
1365 boost::optional<IdfObject> translateRefrigerationCondenserWaterCooled(model::RefrigerationCondenserWaterCooled& modelObject);
1366
1367 boost::optional<IdfObject> translateRefrigerationGasCoolerAirCooled(model::RefrigerationGasCoolerAirCooled& modelObject);
1368
1369 boost::optional<IdfObject> translateRefrigerationSubcoolerLiquidSuction(model::RefrigerationSubcoolerLiquidSuction& modelObject);
1370
1371 boost::optional<IdfObject> translateRefrigerationSubcoolerMechanical(model::RefrigerationSubcoolerMechanical& modelObject);
1372
1373 boost::optional<IdfObject> translateRefrigerationSecondarySystem(model::RefrigerationSecondarySystem& modelObject);
1374
1375 boost::optional<IdfObject> translateRefrigerationSystem(model::RefrigerationSystem& modelObject);
1376
1377 boost::optional<IdfObject> translateRefrigerationTranscriticalSystem(model::RefrigerationTranscriticalSystem& modelObject);
1378
1379 boost::optional<IdfObject> translateRefrigerationWalkIn(model::RefrigerationWalkIn& modelObject);
1380
1381 boost::optional<IdfObject> translateRoofVegetation(model::RoofVegetation& modelObject);
1382
1383 boost::optional<IdfObject> translateRunPeriod(model::RunPeriod& modelObject);
1384
1385 boost::optional<IdfObject> translateRunPeriodControlDaylightSavingTime(model::RunPeriodControlDaylightSavingTime& modelObject);
1386
1387 boost::optional<IdfObject> translateRunPeriodControlSpecialDays(model::RunPeriodControlSpecialDays& modelObject);
1388
1389 boost::optional<IdfObject> translateScheduleCompact(model::ScheduleCompact& modelObject);
1390
1391 boost::optional<IdfObject> translateScheduleConstant(model::ScheduleConstant& modelObject); //blb
1392
1393 boost::optional<IdfObject> translateScheduleDay(model::ScheduleDay& modelObject);
1394
1395 boost::optional<IdfObject> translateScheduleFixedInterval(model::ScheduleFixedInterval& modelObject);
1396
1397 boost::optional<IdfObject> translateScheduleFile(model::ScheduleFile& modelObject);
1398
1399 boost::optional<IdfObject> translateScheduleRuleset(model::ScheduleRuleset& modelObject);
1400
1401 boost::optional<IdfObject> translateScheduleTypeLimits(model::ScheduleTypeLimits& modelObject);
1402
1403 boost::optional<IdfObject> translateScheduleVariableInterval(model::ScheduleVariableInterval& modelObject);
1404
1405 boost::optional<IdfObject> translateScheduleWeek(model::ScheduleWeek& modelObject);
1406
1407 boost::optional<IdfObject> translateScheduleYear(model::ScheduleYear& modelObject);
1408
1409 boost::optional<IdfObject> translateScreen(model::Screen& modelObject);
1410
1411 boost::optional<IdfObject> translateSetpointManagerColdest(model::SetpointManagerColdest& modelObject);
1412
1413 boost::optional<IdfObject> translateSetpointManagerFollowGroundTemperature(model::SetpointManagerFollowGroundTemperature& modelObject);
1414
1415 boost::optional<IdfObject> translateSetpointManagerFollowOutdoorAirTemperature(model::SetpointManagerFollowOutdoorAirTemperature& modelObject);
1416
1417 boost::optional<IdfObject> translateSetpointManagerFollowSystemNodeTemperature(model::SetpointManagerFollowSystemNodeTemperature& modelObject);
1418
1419 boost::optional<IdfObject> translateSetpointManagerMixedAir(model::SetpointManagerMixedAir& modelObject);
1420
1421 boost::optional<IdfObject> translateSetpointManagerMultiZoneCoolingAverage(model::SetpointManagerMultiZoneCoolingAverage& modelObject);
1422
1423 boost::optional<IdfObject> translateSetpointManagerMultiZoneHeatingAverage(model::SetpointManagerMultiZoneHeatingAverage& modelObject);
1424
1425 boost::optional<IdfObject> translateSetpointManagerMultiZoneHumidityMaximum(model::SetpointManagerMultiZoneHumidityMaximum& modelObject);
1426
1427 boost::optional<IdfObject> translateSetpointManagerMultiZoneHumidityMinimum(model::SetpointManagerMultiZoneHumidityMinimum& modelObject);
1428
1429 boost::optional<IdfObject>
1430 translateSetpointManagerMultiZoneMaximumHumidityAverage(model::SetpointManagerMultiZoneMaximumHumidityAverage& modelObject);
1431
1432 boost::optional<IdfObject>
1433 translateSetpointManagerMultiZoneMinimumHumidityAverage(model::SetpointManagerMultiZoneMinimumHumidityAverage& modelObject);
1434
1435 boost::optional<IdfObject> translateSetpointManagerOutdoorAirPretreat(model::SetpointManagerOutdoorAirPretreat& modelObject);
1436
1437 boost::optional<IdfObject> translateSetpointManagerOutdoorAirReset(model::SetpointManagerOutdoorAirReset& modelObject);
1438
1439 boost::optional<IdfObject> translateSetpointManagerScheduled(model::SetpointManagerScheduled& modelObject);
1440
1441 boost::optional<IdfObject> translateSetpointManagerScheduledDualSetpoint(model::SetpointManagerScheduledDualSetpoint& modelObject);
1442
1443 boost::optional<IdfObject> translateSetpointManagerSingleZoneCooling(model::SetpointManagerSingleZoneCooling& modelObject);
1444
1445 boost::optional<IdfObject> translateSetpointManagerSingleZoneHeating(model::SetpointManagerSingleZoneHeating& modelObject);
1446
1447 boost::optional<IdfObject> translateSetpointManagerSingleZoneHumidityMaximum(model::SetpointManagerSingleZoneHumidityMaximum& modelObject);
1448
1449 boost::optional<IdfObject> translateSetpointManagerSingleZoneHumidityMinimum(model::SetpointManagerSingleZoneHumidityMinimum& modelObject);
1450
1451 boost::optional<IdfObject> translateSetpointManagerSingleZoneOneStageCooling(model::SetpointManagerSingleZoneOneStageCooling& modelObject);
1452
1453 boost::optional<IdfObject> translateSetpointManagerSingleZoneOneStageHeating(model::SetpointManagerSingleZoneOneStageHeating& modelObject);
1454
1455 boost::optional<IdfObject> translateSetpointManagerSingleZoneReheat(model::SetpointManagerSingleZoneReheat& modelObject);
1456
1457 boost::optional<IdfObject> translateSetpointManagerWarmest(model::SetpointManagerWarmest& modelObject);
1458
1459 boost::optional<IdfObject> translateSetpointManagerWarmestTemperatureFlow(model::SetpointManagerWarmestTemperatureFlow& modelObject);
1460
1461 boost::optional<IdfObject> translateSetpointManagerSystemNodeResetHumidity(model::SetpointManagerSystemNodeResetHumidity& modelObject);
1462
1463 boost::optional<IdfObject> translateSetpointManagerSystemNodeResetTemperature(model::SetpointManagerSystemNodeResetTemperature& modelObject);
1464
1465 boost::optional<IdfObject> translateShade(model::Shade& modelObject);
1466
1467 boost::optional<IdfObject> translateShadingControl(model::ShadingControl& modelObject);
1468
1469 boost::optional<IdfObject> translateShadingSurface(model::ShadingSurface& modelObject);
1470
1471 boost::optional<IdfObject> translateShadingSurfaceGroup(model::ShadingSurfaceGroup& modelObject);
1472
1473 boost::optional<IdfObject> translateShadowCalculation(model::ShadowCalculation& modelObject);
1474
1475 boost::optional<IdfObject> translateSimpleGlazing(model::SimpleGlazing& modelObject);
1476
1477 boost::optional<IdfObject> translateSimulationControl(model::SimulationControl& modelObject);
1478
1479 boost::optional<IdfObject> translateSite(model::Site& modelObject);
1480
1481 boost::optional<IdfObject> translateSiteGroundReflectance(model::SiteGroundReflectance& modelObject);
1482
1483 boost::optional<IdfObject> translateSiteGroundTemperatureBuildingSurface(model::SiteGroundTemperatureBuildingSurface& modelObject);
1484
1485 boost::optional<IdfObject> translateSiteGroundTemperatureDeep(model::SiteGroundTemperatureDeep& modelObject);
1486
1487 boost::optional<IdfObject> translateSiteGroundTemperatureFCfactorMethod(model::SiteGroundTemperatureFCfactorMethod& modelObject);
1488
1489 boost::optional<IdfObject> translateSiteGroundTemperatureShallow(model::SiteGroundTemperatureShallow& modelObject);
1490
1491 boost::optional<IdfObject>
1492 translateSiteGroundTemperatureUndisturbedKusudaAchenbach(model::SiteGroundTemperatureUndisturbedKusudaAchenbach& modelObject);
1493
1494 boost::optional<IdfObject> translateSiteGroundTemperatureUndisturbedXing(model::SiteGroundTemperatureUndisturbedXing& modelObject);
1495
1496 boost::optional<IdfObject> translateSiteWaterMainsTemperature(model::SiteWaterMainsTemperature& modelObject);
1497
1498 boost::optional<IdfObject> translateSizingParameters(model::SizingParameters& modelObject);
1499
1500 boost::optional<IdfObject> translateSizingPlant(model::SizingPlant& modelObject);
1501
1502 boost::optional<IdfObject> translateSizingSystem(model::SizingSystem& modelObject);
1503
1504 boost::optional<IdfObject> translateSizingZone(model::SizingZone& modelObject);
1505
1506 boost::optional<IdfObject> translateSkyTemperature(model::SkyTemperature& modelObject);
1507
1508 boost::optional<IdfObject> translateSolarCollectorFlatPlatePhotovoltaicThermal(model::SolarCollectorFlatPlatePhotovoltaicThermal& modelObject);
1509
1510 boost::optional<IdfObject> translateSolarCollectorFlatPlateWater(model::SolarCollectorFlatPlateWater& modelObject);
1511
1512 boost::optional<IdfObject> translateSolarCollectorIntegralCollectorStorage(model::SolarCollectorIntegralCollectorStorage& modelObject);
1513
1514 boost::optional<IdfObject> translateSolarCollectorPerformanceFlatPlate(model::SolarCollectorPerformanceFlatPlate& modelObject);
1515
1516 boost::optional<IdfObject>
1517 translateSolarCollectorPerformanceIntegralCollectorStorage(model::SolarCollectorPerformanceIntegralCollectorStorage& modelObject);
1518
1519 boost::optional<IdfObject>
1520 translateSolarCollectorPerformancePhotovoltaicThermalBIPVT(model::SolarCollectorPerformancePhotovoltaicThermalBIPVT& modelObject);
1521
1522 boost::optional<IdfObject>
1523 translateSolarCollectorPerformancePhotovoltaicThermalSimple(model::SolarCollectorPerformancePhotovoltaicThermalSimple& modelObject);
1524
1525 boost::optional<IdfObject> translateSpace(model::Space& modelObject);
1526
1527 boost::optional<IdfObject> translateSpaceInfiltrationDesignFlowRate(model::SpaceInfiltrationDesignFlowRate& modelObject);
1528
1529 boost::optional<IdfObject> translateSpaceInfiltrationEffectiveLeakageArea(model::SpaceInfiltrationEffectiveLeakageArea& modelObject);
1530
1531 boost::optional<IdfObject> translateSpaceInfiltrationFlowCoefficient(model::SpaceInfiltrationFlowCoefficient& modelObject);
1532
1533 boost::optional<IdfObject> translateSpaceType(model::SpaceType& modelObject);
1534 std::string zoneListNameForSpaceType(const model::SpaceType& modelObject) const; // helper function
1535
1536 boost::optional<IdfObject> translateStandardGlazing(model::StandardGlazing& modelObject);
1537
1538 boost::optional<IdfObject> translateStandardOpaqueMaterial(model::StandardOpaqueMaterial& modelObject);
1539
1540 boost::optional<IdfObject> translateSteamEquipment(model::SteamEquipment& modelObject);
1541 boost::optional<IdfObject> translateSteamEquipmentLegacy(model::SteamEquipment& modelObject);
1542 boost::optional<IdfObject> translateSteamEquipmentInstance(model::SteamEquipment& modelObject);
1543 boost::optional<IdfObject> translateSteamEquipmentDefinition(model::SteamEquipmentDefinition& modelObject);
1544
1545 boost::optional<IdfObject> translateSubSurface(model::SubSurface& modelObject);
1546
1547 boost::optional<IdfObject> translateSurface(model::Surface& modelObject);
1548
1549 boost::optional<IdfObject> translateSurfaceControlMovableInsulation(model::SurfaceControlMovableInsulation& modelObject);
1550
1551 boost::optional<IdfObject> translateSurfacePropertyConvectionCoefficients(model::SurfacePropertyConvectionCoefficients& modelObject);
1552
1553 boost::optional<IdfObject>
1554 translateSurfacePropertyConvectionCoefficientsMultipleSurface(model::SurfacePropertyConvectionCoefficientsMultipleSurface& modelObject);
1555
1556 boost::optional<IdfObject> translateSurfacePropertyExposedFoundationPerimeter(model::SurfacePropertyExposedFoundationPerimeter& modelObject);
1557
1558 boost::optional<IdfObject> translateSurfacePropertyOtherSideCoefficients(model::SurfacePropertyOtherSideCoefficients& modelObject);
1559
1560 boost::optional<IdfObject> translateSurfacePropertyOtherSideConditionsModel(model::SurfacePropertyOtherSideConditionsModel& modelObject);
1561
1562 boost::optional<IdfObject> translateSurfacePropertyLocalEnvironment(model::SurfacePropertyLocalEnvironment& modelObject);
1563
1564 boost::optional<IdfObject> translateSurfacePropertySurroundingSurfaces(model::SurfacePropertySurroundingSurfaces& modelObject);
1565
1566 boost::optional<IdfObject> translateSurfacePropertyGroundSurfaces(model::SurfacePropertyGroundSurfaces& modelObject);
1567
1568 boost::optional<IdfObject> translateSurfacePropertyIncidentSolarMultiplier(model::SurfacePropertyIncidentSolarMultiplier& modelObject);
1569
1570 boost::optional<IdfObject> translateSwimmingPoolIndoor(model::SwimmingPoolIndoor& modelObject);
1571
1572 OS_DEPRECATED(3, 5, 0) boost::optional<IdfObject> translateTableMultiVariableLookup(model::TableMultiVariableLookup& modelObject);
1573
1574 boost::optional<IdfObject> translateTableLookup(model::TableLookup& modelObject);
1575
1576 boost::optional<IdfObject> translateTableIndependentVariable(model::TableIndependentVariable& modelObject);
1577
1578 boost::optional<IdfObject> translateTemperingValve(model::TemperingValve& modelObject);
1579
1580 boost::optional<IdfObject> translateThermalStorageIceDetailed(model::ThermalStorageIceDetailed& modelObject);
1581
1582 boost::optional<IdfObject> translateThermalStorageChilledWaterStratified(model::ThermalStorageChilledWaterStratified& modelObject);
1583
1584 boost::optional<IdfObject> translateThermalZone(model::ThermalZone& modelObject);
1585 void translateThermalZoneSpacesWhenCombinedSpaces(model::ThermalZone& modelObject, IdfObject& idfObject);
1586 void translateThermalZoneSpacesToEnergyPlusSpaces(model::ThermalZone& modelObject, IdfObject& idfObject);
1587 // Helper for the DesignSpecification:ZoneAirDistribution, returns empty when the DSZAD is not needed,
1588 // which is when fields on Sizing:Zone related to it are all defaulted (Implemeted in ForwardTranslateSizingZone)
1589 boost::optional<std::string> zoneDSZADName(const model::ThermalZone& zone);
1590
1591 boost::optional<IdfObject> translateThermochromicGlazing(model::ThermochromicGlazing& modelObject);
1592
1593 boost::optional<IdfObject> translateThermostatSetpointDualSetpoint(model::ThermostatSetpointDualSetpoint& tsds);
1594
1595 boost::optional<IdfObject> translateTimestep(model::Timestep& modelObject);
1596
1597 boost::optional<IdfObject> translateUnitarySystemPerformanceMultispeed(model::UnitarySystemPerformanceMultispeed& modelObject);
1598
1599 boost::optional<IdfObject> translateVersion(model::Version& modelObject);
1600
1601 boost::optional<IdfObject> translateWaterHeaterMixed(model::WaterHeaterMixed& modelObject);
1602
1603 boost::optional<IdfObject> translateWaterHeaterHeatPump(model::WaterHeaterHeatPump& modelObject);
1604
1605 boost::optional<IdfObject> translateWaterHeaterHeatPumpWrappedCondenser(model::WaterHeaterHeatPumpWrappedCondenser& modelObject);
1606
1607 boost::optional<IdfObject> translateWaterHeaterSizing(model::WaterHeaterSizing& modelObject);
1608
1609 boost::optional<IdfObject> translateWaterHeaterStratified(model::WaterHeaterStratified& modelObject);
1610
1611 boost::optional<IdfObject> translateWaterUseConnections(model::WaterUseConnections& modelObject);
1612
1613 boost::optional<IdfObject> translateWaterUseEquipment(model::WaterUseEquipment& modelObject);
1614
1615 boost::optional<IdfObject> translateWindowPropertyFrameAndDivider(model::WindowPropertyFrameAndDivider& modelObject);
1616
1617 boost::optional<IdfObject> translateZoneAirHeatBalanceAlgorithm(model::ZoneAirHeatBalanceAlgorithm& modelObject);
1618
1619 boost::optional<IdfObject> translateZoneAirContaminantBalance(model::ZoneAirContaminantBalance& modelObject);
1620
1621 boost::optional<IdfObject> translateZoneAirMassFlowConservation(model::ZoneAirMassFlowConservation& modelObject);
1622
1623 boost::optional<IdfObject> translateZoneCapacitanceMultiplierResearchSpecial(model::ZoneCapacitanceMultiplierResearchSpecial& modelObject);
1624
1625 boost::optional<IdfObject> translateZoneControlContaminantController(model::ZoneControlContaminantController& modelObject);
1626
1627 boost::optional<IdfObject> translateZoneControlHumidistat(model::ZoneControlHumidistat& modelObject);
1628
1629 boost::optional<IdfObject> translateZoneControlThermostatStagedDualSetpoint(model::ZoneControlThermostatStagedDualSetpoint& modelObject);
1630
1631 boost::optional<IdfObject> translateZoneHVACBaseboardConvectiveElectric(model::ZoneHVACBaseboardConvectiveElectric& modelObject);
1632
1633 boost::optional<IdfObject> translateZoneHVACBaseboardConvectiveWater(model::ZoneHVACBaseboardConvectiveWater& modelObject);
1634
1635 boost::optional<IdfObject> translateZoneHVACBaseboardRadiantConvectiveElectric(model::ZoneHVACBaseboardRadiantConvectiveElectric& modelObject);
1636
1637 boost::optional<IdfObject> translateZoneHVACBaseboardRadiantConvectiveWater(model::ZoneHVACBaseboardRadiantConvectiveWater& modelObject);
1638
1639 boost::optional<IdfObject> translateZoneHVACCoolingPanelRadiantConvectiveWater(model::ZoneHVACCoolingPanelRadiantConvectiveWater& modelObject);
1640
1641 boost::optional<IdfObject> translateZoneHVACDehumidifierDX(model::ZoneHVACDehumidifierDX& modelObject);
1642
1643 boost::optional<IdfObject> translateZoneHVACEnergyRecoveryVentilator(model::ZoneHVACEnergyRecoveryVentilator& modelObject);
1644
1645 boost::optional<IdfObject> translateZoneHVACEnergyRecoveryVentilatorController(model::ZoneHVACEnergyRecoveryVentilatorController& modelObject);
1646
1647 boost::optional<IdfObject> translateZoneHVACEquipmentList(model::ZoneHVACEquipmentList& modelObject);
1648
1649 boost::optional<IdfObject> translateZoneHVACEvaporativeCoolerUnit(model::ZoneHVACEvaporativeCoolerUnit& modelObject);
1650
1651 boost::optional<IdfObject> translateZoneHVACFourPipeFanCoil(model::ZoneHVACFourPipeFanCoil& modelObject);
1652
1653 boost::optional<IdfObject> translateZoneHVACHighTemperatureRadiant(model::ZoneHVACHighTemperatureRadiant& modelObject);
1654
1655 boost::optional<IdfObject> translateZoneHVACIdealLoadsAirSystem(model::ZoneHVACIdealLoadsAirSystem& modelObject);
1656
1657 boost::optional<IdfObject> translateZoneHVACLowTemperatureRadiantElectric(model::ZoneHVACLowTemperatureRadiantElectric& modelObject);
1658
1659 boost::optional<IdfObject> translateZoneHVACLowTempRadiantConstFlow(model::ZoneHVACLowTempRadiantConstFlow& modelObject);
1660
1661 boost::optional<IdfObject> translateZoneHVACLowTempRadiantVarFlow(model::ZoneHVACLowTempRadiantVarFlow& modelObject);
1662
1663 boost::optional<IdfObject> translateZoneHVACPackagedTerminalHeatPump(model::ZoneHVACPackagedTerminalHeatPump& modelObject);
1664
1665 boost::optional<IdfObject> translateZoneHVACPackagedTerminalAirConditioner(model::ZoneHVACPackagedTerminalAirConditioner& modelObject);
1666
1667 boost::optional<IdfObject> translateZoneHVACTerminalUnitVariableRefrigerantFlow(model::ZoneHVACTerminalUnitVariableRefrigerantFlow& modelObject);
1668
1669 boost::optional<IdfObject> translateZoneHVACUnitHeater(model::ZoneHVACUnitHeater& modelObject);
1670
1671 boost::optional<IdfObject> translateZoneHVACUnitVentilator(model::ZoneHVACUnitVentilator& modelObject);
1672
1673 boost::optional<IdfObject> translateZoneHVACWaterToAirHeatPump(model::ZoneHVACWaterToAirHeatPump& modelObject);
1674
1675 boost::optional<IdfObject> translateZoneMixing(model::ZoneMixing& modelObject);
1676
1677 boost::optional<IdfObject> translateZoneMRTCalculation(model::ZoneMRTCalculation& modelObject);
1678
1679 boost::optional<IdfObject> translateComfortViewFactorAngles(model::ComfortViewFactorAngles& modelObject);
1680
1681 boost::optional<IdfObject> translateZonePropertyUserViewFactorsBySurfaceName(model::ZonePropertyUserViewFactorsBySurfaceName& modelObject);
1682
1683 boost::optional<IdfObject> createAirLoopHVACSupplyPath(const model::Node& demandInletNode);
1684
1685 boost::optional<IdfObject> translateZoneVentilationDesignFlowRate(model::ZoneVentilationDesignFlowRate& modelObject);
1686
1687 boost::optional<IdfObject> translateZoneVentilationWindandStackOpenArea(model::ZoneVentilationWindandStackOpenArea& modelObject);
1688
1689 boost::optional<IdfObject> createAirLoopHVACSupplyPath(model::AirLoopHVAC& airLoopHVAC);
1690
1691 boost::optional<IdfObject> createAirLoopHVACReturnPath(model::AirLoopHVAC& airLoopHVAC);
1692
1693 // reset the state of the translator between translations
1694 void reset();
1695
1696 // helper method used by ForwardTranslatePlantLoop
1697 IdfObject populateBranch(IdfObject& branchIdfObject, std::vector<model::ModelObject>& modelObjects, model::Loop& loop, bool isSupplyBranch);
1698
1699 // translate all constructions
1700 void translateConstructions(const model::Model& model);
1701
1702 // translate all schedules and find always on and always off schedules if they exist
1703 void translateSchedules(const model::Model& model);
1704
1705 // translate all airflow network objects if an AFN simulation control exists
1706 void translateAirflowNetwork(const model::Model& model);
1707
1708 // returns the default interior partition surface construction, otherwise creates one and saves for later
1709 model::ConstructionBase interiorPartitionSurfaceConstruction(model::Model& model);
1710 boost::optional<model::ConstructionBase> m_interiorPartitionSurfaceConstruction;
1711
1712 // returns the default exterior surface construction, otherwise creates one and saves for later
1713 model::ConstructionBase exteriorSurfaceConstruction(model::Model& model);
1714 boost::optional<model::ConstructionBase> m_exteriorSurfaceConstruction;
1715
1716 // reverse a construction if needed
1717 model::ConstructionBase reverseConstruction(const model::ConstructionBase& construction);
1718 std::map<Handle, model::ConstructionBase> m_constructionHandleToReversedConstructions;
1719
1720 // resolve conflicts about constructions in matched surfaces
1721 void resolveMatchedSurfaceConstructionConflicts(model::Model& model);
1722 void resolveMatchedSubSurfaceConstructionConflicts(model::Model& model);
1723
1724 // ugly hack to fix upstream mixed air setpoint managers that have internal fans
1725 // This should be used by the various translateUnitaryFoo methods.
1726 void fixSPMsForUnitarySystem(const model::HVACComponent& unitary, const std::string& fanInletNodeName, const std::string& FanOutletNodeName);
1727
1728 void createStandardOutputRequests(const model::Model& model);
1729
1730 static std::string stripOS2(const std::string& s);
1731
1732 IdfObject createAndRegisterIdfObject(const IddObjectType& idfObjectType, const model::ModelObject& modelObject);
1733
1734 IdfObject createRegisterAndNameIdfObject(const IddObjectType& idfObjectType, const model::ModelObject& modelObject);
1735
1736 static std::vector<IddObjectType> iddObjectsToTranslate();
1737 static std::vector<IddObjectType> iddObjectsToTranslateInitializer();
1738
1739 /** Determines whether or not the HVACComponent is part of a unitary system or on an
1740 * AirLoopHVAC */
1741 static bool isHVACComponentWithinUnitary(const model::HVACComponent& hvacComponent);
1742
1743 /** Looks up in embedded_files to locate the path to IdfFile that is supplied, and returns the
1744 * IdfFile if successful. */
1745 static boost::optional<IdfFile> findIdfFile(const std::string& path);
1746
1747 /** Create a simple Schedule:Compact based on input vectors. The function will consume the vectors in
1748 * order, so the times must be in chronological order otherwise E+ will output an error. Summer and
1749 * winter design days are not required entries, only defaultDay and name are required. At the moment,
1750 * there is no ScheduleTypeLimit so there is no validation and E+ outputs a warning. It is up to the
1751 * developer to make sure all E+ rules and validation for Schedule:Compact are upheld. This converts
1752 * openstudio::Time of 00:00 to 24:00 and makes sure it is the last value.
1753 */
1754 boost::optional<IdfObject> createSimpleSchedule(
1755 const std::string& name, const std::vector<std::pair<openstudio::Time, double>>& defaultDay,
1756 const std::vector<std::pair<openstudio::Time, double>>& summerDesignDay = std::vector<std::pair<openstudio::Time, double>>(),
1757 const std::vector<std::pair<openstudio::Time, double>>& winterDesignDay = std::vector<std::pair<openstudio::Time, double>>());
1758
1759 /** Creates the FluidProperties IdfObjects and adds them to m_idfObjects based on the input
1760 * fluidType. Returns an uninitialized object if unsuccessful for any reason. If successful, returns
1761 * the FluidProperties:Name IdfObject. If the fluidType already exists in m_idfObjects, it will not
1762 * add new IdfObjects and will return the existing FluidProperties:Name IdfObject. Valid choices for
1763 * fluidType are: R11, R12, R22, R123, R134a, R404a, R407a, R410a, NH3, R507a, R744 */
1764 boost::optional<IdfObject> createFluidProperties(const std::string& fluidType);
1765
1766 /** Creates the FluidProperties IdfObjects and adds them to m_idfObjects based on the input
1767 * glycolType and glycolConcentration. Returns an uninitialized object if unsuccessful for any reason.
1768 * If successful, returns the FluidProperties:Name IdfObject with a FluidName of
1769 * glycolType + "_" + glycolConcentration ie. PropyleneGlycol_30. If the fluidType already
1770 * exists in m_idfObjects, it will not add new IdfObjects and will return the existing
1771 * FluidProperties:Name IdfObject. Valid choices for glycolType are: PropyleneGlycol, EthyleneGlycol
1772 * */
1773 boost::optional<IdfObject> createFluidProperties(const std::string& glycolType, int glycolConcentration);
1774
1775 /** Initializes m_fluidPropertiesMap with refrigerant names and path to refrigerant resource files.
1776 * Valid refrigerants are: R11, R12, R22, R123, R134a, R404a, R407a, R410a, NH3, R507a, R744 */
1777 void createFluidPropertiesMap();
1778
1779 using ModelObjectMap = std::map<const openstudio::Handle, const IdfObject>;
1780
1781 using FluidPropertiesMap = std::map<const std::string, const std::string>;
1782
1783 FluidPropertiesMap m_fluidPropertiesMap;
1784
1785 ModelObjectMap m_map;
1786
1787 using ZoneToMaybeDSOA = std::map<const openstudio::Handle, boost::optional<IdfObject>>;
1788 ZoneToMaybeDSOA m_zoneDSOAsMap;
1789
1790 std::vector<IdfObject> m_idfObjects;
1791
1792 boost::optional<IdfObject> m_anyNumberScheduleTypeLimits;
1793
1794 StringStreamLogSink m_logSink;
1795
1796 ProgressBar* m_progressBar;
1797
1798 // ForwardTranslator options
1799 ForwardTranslatorOptions m_forwardTranslatorOptions;
1800 };
1801
1802 } // namespace energyplus
1803
1804 } // namespace openstudio
1805
1806 #endif // ENERGYPLUS_FORWARDTRANSLATOR_HPP
1807