From 95055149e7d0194f77db0730b424946bb14b3e91 Mon Sep 17 00:00:00 2001 From: Joe Robertson Date: Mon, 26 Aug 2024 12:59:32 -0700 Subject: [PATCH 001/126] Update cmakelists. --- CMakeLists.txt | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 9d8f6659a9f..7d78ffb008d 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -192,15 +192,15 @@ endif() # EnergyPlus Idd version set(ENERGYPLUS_VERSION_MAJOR 24) -set(ENERGYPLUS_VERSION_MINOR 1) +set(ENERGYPLUS_VERSION_MINOR 2) set(ENERGYPLUS_VERSION_PATCH 0) set(ENERGYPLUS_VERSION "${ENERGYPLUS_VERSION_MAJOR}.${ENERGYPLUS_VERSION_MINOR}.${ENERGYPLUS_VERSION_PATCH}") # Build SHA is not required to have a value, but if it does OpenStudio will require this build. -set(ENERGYPLUS_BUILD_SHA "9d7789a3ac") +set(ENERGYPLUS_BUILD_SHA "a99cc59429") # ENERGYPLUS_RELEASE_NAME is used to locate the E+ download # from the github releases -set(ENERGYPLUS_RELEASE_NAME "v24.1.0") +set(ENERGYPLUS_RELEASE_NAME "v24.2.0-IOFreeze") set(ENERGYPLUS_REPO "NREL") @@ -639,24 +639,30 @@ endif() if(UNIX) if(APPLE) if (ARCH MATCHES "arm64") - set(ENERGYPLUS_EXPECTED_HASH 3b465e87fc07e18db458e1d058da447b) - set(ENERGYPLUS_PLATFORM "Darwin-macOS12.1-arm64") + set(ENERGYPLUS_EXPECTED_HASH 7e2a4bf570e8f94e37f94668e2855ec1) + set(ENERGYPLUS_PLATFORM "Darwin-macOS13-arm64") else() - set(ENERGYPLUS_EXPECTED_HASH 4f15adccac3df1e699d26f815800c783) - set(ENERGYPLUS_PLATFORM "Darwin-macOS11.6-x86_64") + set(ENERGYPLUS_EXPECTED_HASH b6493ab5580f8b494b51cdfd0e583b9d) + set(ENERGYPLUS_PLATFORM "Darwin-macOS12.1-x86_64") endif() elseif(LSB_RELEASE_ID_SHORT MATCHES "CentOS") set(ENERGYPLUS_EXPECTED_HASH c31dfb86d8967636fca0a1ecf4052f22) set(ENERGYPLUS_PLATFORM "Linux-CentOS7.9.2009-x86_64") else() - if(LSB_RELEASE_VERSION_SHORT MATCHES "22.04") + if(LSB_RELEASE_VERSION_SHORT MATCHES "24.04") if (ARCH MATCHES "arm64") - set(ENERGYPLUS_EXPECTED_HASH 2e1e9516b39ca8046b7cf79ad3a81fa7) + # set(ENERGYPLUS_EXPECTED_HASH 7ce649525157b6e18b170eb72916e83c) ??? else() - set(ENERGYPLUS_EXPECTED_HASH fb171a5da7d41da80da7868686b41126) + set(ENERGYPLUS_EXPECTED_HASH 67b3c4971de2b75fdcbf07cfdf3a77b1) + endif() + elseif(LSB_RELEASE_VERSION_SHORT MATCHES "22.04") + if (ARCH MATCHES "arm64") + set(ENERGYPLUS_EXPECTED_HASH 7ce649525157b6e18b170eb72916e83c) + else() + set(ENERGYPLUS_EXPECTED_HASH 10c5e4d2d795de9ef94cbdb36d977578) endif() elseif(LSB_RELEASE_VERSION_SHORT MATCHES "20.04") - set(ENERGYPLUS_EXPECTED_HASH 4ea21126c3989cad35078a711573572e) + set(ENERGYPLUS_EXPECTED_HASH 47dd8f60252fab92b6f0859dd66806c1) else() # 18.04 message(FATAL_ERROR "EnergyPlus no longer provides packages for Ubuntu 18.04") endif() @@ -692,11 +698,11 @@ elseif(WIN32) if(CMAKE_SIZEOF_VOID_P EQUAL 8) # 64 bit set(ENERGYPLUS_PATH "EnergyPlus-${ENERGYPLUS_VERSION}-${ENERGYPLUS_BUILD_SHA}-Windows-x86_64") set(ENERGYPLUS_ARCH 64) - set(ENERGYPLUS_EXPECTED_HASH c9dd8a23b64d1327d00c5d85896b46bb) + set(ENERGYPLUS_EXPECTED_HASH 9aca9b49d6a0870cb639790604328899) else() set(ENERGYPLUS_PATH "EnergyPlus-${ENERGYPLUS_VERSION}-${ENERGYPLUS_BUILD_SHA}-Windows-i386") set(ENERGYPLUS_ARCH 32) - set(ENERGYPLUS_EXPECTED_HASH 766cf42388ca5b682800fe6ded8ac3ee) + # set(ENERGYPLUS_EXPECTED_HASH 766cf42388ca5b682800fe6ded8ac3ee) ? set(ENERGYPLUS_REPO "jmarrec") endif() if(EXISTS "${PROJECT_BINARY_DIR}/${ENERGYPLUS_PATH}.zip") From 48870bc438df57dbb0b977118abf6d3eb23adfd3 Mon Sep 17 00:00:00 2001 From: Joe Robertson Date: Mon, 26 Aug 2024 12:59:41 -0700 Subject: [PATCH 002/126] Update proposed idd. --- resources/energyplus/ProposedEnergy+.idd | 510 +++++++++++++++++++---- 1 file changed, 418 insertions(+), 92 deletions(-) diff --git a/resources/energyplus/ProposedEnergy+.idd b/resources/energyplus/ProposedEnergy+.idd index 3a5801e5c34..9c8f34fa64a 100644 --- a/resources/energyplus/ProposedEnergy+.idd +++ b/resources/energyplus/ProposedEnergy+.idd @@ -1,4 +1,4 @@ -!IDD_Version 24.1.0 +!IDD_Version 24.2.0 !IDD_BUILD TBD ! ************************************************************************** ! This file is the Input Data Dictionary (IDD) for EnergyPlus. @@ -405,7 +405,7 @@ Version, \format singleLine \min-fields 1 A1 ; \field Version Identifier - \default 24.1 + \default 24.2 SimulationControl, \unique-object @@ -1020,12 +1020,17 @@ Site:Location, \default 0.0 \note Time relative to GMT. Decimal hours. \type real - N4 ; \field Elevation + N4 , \field Elevation \units m \minimum -300.0 \maximum< 8900.0 \default 0.0 \type real + A2 ; \field Keep Site Location Information + \type choice + \key Yes + \key No + \default No Site:VariableLocation, \memo Captures the scheduling of a moving/reorienting building, or more likely a vessel @@ -4975,6 +4980,7 @@ MaterialProperty:MoisturePenetrationDepth:Settings, MaterialProperty:PhaseChange, \memo Additional properties for temperature dependent thermal conductivity \memo and enthalpy for Phase Change Materials (PCM) + \memo Name and temperature coefficient are followed by up to 100 sets of temperature-enthalpy pairs. \memo HeatBalanceAlgorithm = CondFD(ConductionFiniteDifference) solution algorithm only. \memo Constructions with this should use the detailed CondFD process. \memo Has no effect with other HeatBalanceAlgorithm solution algorithms @@ -5098,6 +5104,7 @@ MaterialProperty:PhaseChangeHysteresis, MaterialProperty:VariableThermalConductivity, \memo Additional properties for temperature dependent thermal conductivity \memo using piecewise linear temperature-conductivity function. + \memo Name is followed by up to 100 sets of temperature-conductivity pairs. \memo HeatBalanceAlgorithm = CondFD(ConductionFiniteDifference) solution algorithm only. \memo Has no effect with other HeatBalanceAlgorithm solution algorithms \extensible:2 @@ -7728,16 +7735,16 @@ InternalMass, \type object-list \object-list ConstructionNames A3 , \field Zone or ZoneList Name - \required-field \type object-list \object-list ZoneAndZoneListNames - \note Zone the surface is a part of. - \note used to be Interior Environment + \note Zone(s) the surface is a part of. + \note This field is ignored when a Space or SpaceList Name is specified. A4 , \field Space or SpaceList Name \type object-list \object-list SpaceAndSpaceListNames - \note Space the surface is a part of (optional, see description of Space object for more details). + \note Space(s) the surface is a part of. \note This field is ignored when a ZoneList Name is specified for Zone or ZoneList Name. + \note An internal mass surface will be added to every Space in every Zone in the ZoneList. N1 ; \field Surface Area \required-field \units m2 @@ -11350,7 +11357,8 @@ RoomAir:Node:AirflowNetwork:HVACEquipment, \key ZoneHVAC:IdealLoadsAirSystem \key ZoneHVAC:RefrigerationChillerSet \key Fan:ZoneExhaust - \key WaterHeater:HeatPump + \key WaterHeater:HeatPump:PumpedCondenser + \key WaterHeater:HeatPump:WrappedCondenser \key AirTerminal:DualDuct:ConstantVolume \key AirTerminal:DualDuct:VAV \key AirTerminal:SingleDuct:ConstantVolume:Reheat @@ -12989,10 +12997,11 @@ Output:IlluminanceMap, \memo Daylighting Reference Point CoordinateSystem field A1 , \field Name \required-field - A2 , \field Zone Name + A2 , \field Zone or Space Name \required-field \type object-list \object-list ZoneNames + \object-list SpaceNames N1 , \field Z height \units m \type real @@ -13721,7 +13730,7 @@ ZoneCrossMixing, ZoneRefrigerationDoorMixing, \min-fields 4 - \memo Refrigeration Door Mixing is used for an opening between two zones that are at the + \memo Refrigeration Door Mixing is used for an opening between two zones (or spaces) that are at the \memo same elevation but have different air temperatures. In this case, the mixing air flow \memo between the two zones is determined by the density difference between the two zones. \memo This would typically be used between two zones in a refrigerated warehouse that are @@ -13730,14 +13739,18 @@ ZoneRefrigerationDoorMixing, A1 , \field Name \required-field \type alpha - A2 , \field Zone 1 Name + A2 , \field Zone or Space Name 1 + \note If a space name is used, it must belong to a different zone than Zone or Space Name 2. \required-field \type object-list \object-list ZoneNames - A3 , \field Zone 2 Name + \object-list SpaceNames + A3 , \field Zone or Space Name 2 + \note If a space name is used, it must belong to a different zone than Zone or Space Name 1. \required-field \type object-list \object-list ZoneNames + \object-list SpaceNames A4 , \field Schedule Name \note This schedule defines the fraction of the time the refrigeration door is open \note For example, if the warehouse is closed at night and there are no door openings @@ -13940,7 +13953,7 @@ ZoneCoolTower:Shower, \memo A cooltower (sometimes referred to as a wind tower or a shower cooling tower) \memo models passive downdraught evaporative cooling (PDEC) that is designed to capture the \memo wind at the top of a tower and cool the outdoor air using water evaporation before - \memo delivering it to a space. + \memo delivering it to a zone (or space). A1, \field Name \required-field A2, \field Availability Schedule Name @@ -13948,10 +13961,11 @@ ZoneCoolTower:Shower, \note If this field is blank, the system is always available. \type object-list \object-list ScheduleNames - A3, \field Zone Name + A3, \field Zone or Space Name \required-field \type object-list \object-list ZoneNames + \object-list SpaceNames A4, \field Water Supply Storage Tank Name \note In case of stand alone tank or underground water, leave this input blank \type object-list @@ -14010,13 +14024,13 @@ ZoneThermalChimney, \memo A thermal chimney is a vertical shaft utilizing solar radiation to enhance natural \memo ventilation. It consists of an absorber wall, air gap and glass cover with high solar \memo transmissivity. - \min-fields 10 - \extensible:4 - \max-fields 86 + \min-fields 10 + \extensible:4 + \max-fields 86 A1, \field Name \required-field A2, \field Zone Name - \note Name of zone that is the thermal chimney + \note Name of zone that is the thermal chimney. \required-field \type object-list \object-list ZoneNames @@ -14040,17 +14054,18 @@ ZoneThermalChimney, \minimum 0 \maximum 1 \default 0.8 - A4, \field Zone 1 Name + A4, \field Zone or Space 1 Name \required-field \type object-list \object-list ZoneNames + \object-list SpaceNames \begin-extensible N4, \field Distance from Top of Thermal Chimney to Inlet 1 \required-field \units m \type real \minimum 0 - N5, \field Relative Ratios of Air Flow Rates Passing through Zone 1 + N5, \field Relative Ratios of Air Flow Rates Passing through Inlet 1 \type real \minimum 0 \maximum 1 @@ -22584,7 +22599,7 @@ Sizing:Zone, \note no humidistat is associated with this zone. \type object-list \object-list ScheduleNames - A14;\field Zone Humidistat Humidification Set Point Schedule Name + A14,\field Zone Humidistat Humidification Set Point Schedule Name \note Enter the zone relative humidity schedule used for zone latent \note heating calculations. \note A zone humidistat will take priority over this input. @@ -22594,6 +22609,12 @@ Sizing:Zone, \note no humidistat is associated with this zone. \type object-list \object-list ScheduleNames + A15;\field Type of Space Sum to Use + \note NonCoincident is available only if Do Space Heat Balance for Sizing=Yes in ZoneAirHeatBalanceAlgorithm. + \type choice + \key Coincident + \key NonCoincident + \default Coincident DesignSpecification:ZoneHVAC:Sizing, \min-fields 1 @@ -25954,11 +25975,10 @@ ZoneHVAC:TerminalUnit:VariableRefrigerantFlow, \key Fan:SystemModel \key Fan:OnOff \key Fan:ConstantVolume - \key Fan:VariableVolume \default Fan:ConstantVolume \note Supply Air Fan Object Type must be Fan:SystemModel, Fan:OnOff, or Fan:ConstantVolume \note if AirConditioner:VariableRefrigerantFlow is used to model VRF outdoor unit - \note Supply Air Fan Object Type must be Fan:SystemModel or Fan:VariableVolume if + \note Supply Air Fan Object Type must be Fan:SystemModel if \note AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl or \note AirConditioner:VariableRefrigerantFlow:FluidTemperatureControl:HR \note is used to model VRF outdoor unit @@ -28071,10 +28091,39 @@ AirTerminal:SingleDuct:SeriesPIU:Reheat, \minimum 0.0 \default 0.0 \ip-units gal/min - N6; \field Convergence Tolerance + N6, \field Convergence Tolerance \type real \minimum> 0.0 \default 0.001 + A11, \field Fan Control Type + \note If VariableSpeed, then the fan object type must be Fan:SystemModel + \type choice + \key VariableSpeed + \key ConstantSpeed + \default ConstantSpeed + N7, \field Minimum Fan Turn Down Ratio + \type real + \units dimensionless + \note flow through terminal at minimum fan speed is this ratio multiplied by Maximum Air Flow Rate + \minimum 0.0 + \maximum 1.0 + \default 0.3 + A12, \field Heating Control Type + \type choice + \key Staged + \key Modulated + N8, \field Design Heating Discharge Air Temperature + \type real + \units C + \default 32.1 + \note Only used if Heating Control Type is Modulated + \note Used to control second stage heating, typically zone heat setpoint plus 20F + N9; \field High Limit Heating Discharge Air Temperature + \type real + \units C + \default 37.7 + \note Only used if Heating Control Type is Modulated + \note Used to determine end of third stage heating AirTerminal:SingleDuct:ParallelPIU:Reheat, \memo Central air system terminal unit, single duct, variable volume, parallel powered @@ -28155,10 +28204,39 @@ AirTerminal:SingleDuct:ParallelPIU:Reheat, \minimum 0.0 \default 0.0 \ip-units gal/min - N7; \field Convergence Tolerance + N7, \field Convergence Tolerance \type real \minimum> 0.0 \default 0.001 + A11, \field Fan Control Type + \note If VariableSpeed, then the fan object type must be Fan:SystemModel + \type choice + \key VariableSpeed + \key ConstantSpeed + \default ConstantSpeed + N8, \field Minimum Fan Turn Down Ratio + \type real + \units dimensionless + \note flow through terminal at minimum fan speed is this ratio multiplied by Maximum Air Flow Rate + \minimum 0.0 + \maximum 1.0 + \default 0.3 + A12, \field Heating Control Type + \type choice + \key Staged + \key Modulated + N9, \field Design Heating Discharge Air Temperature + \type real + \units C + \default 32.1 + \note Only used if Heating Control Type is Modulated + \note Used to control second stage heating, typically zone heat setpoint plus 20F + N10; \field High Limit Heating Discharge Air Temperature + \type real + \units C + \default 37.7 + \note Only used if Heating Control Type is Modulated + \note Used to determine end of third stage heating AirTerminal:SingleDuct:ConstantVolume:FourPipeInduction, \memo Central air system terminal unit, single duct, variable volume, induction unit with @@ -29138,6 +29216,35 @@ SpaceHVAC:ZoneEquipmentMixer, \required-field \type node +SpaceHVAC:ZoneReturnMixer, + \extensible:2 + \memo Mixes the return airflow from one or more Spaces into a zone return node. + \memo All spaces in the zone must also have a SpaceHVAC:EquipmentConnections object. + \memo Used only when ZoneAirHeatBalanceAlgorithm "Do Space Heat Balance for Sizing" = Yes. + \min-fields 5 + A1, \field Name + \required-field + \reference SpaceMixerNames + A2, \field Zone Name + \note Must be a controlled zone which has a ZoneHVAC:EquipmentConfiguration object. + \required-field + \type object-list + \object-list ZoneNames + A3, \field Zone Return Air Node Name + \note The zone return air node will be mixed from the spaces. + \note Must match a Zone Return Air Node for this zone. + \required-field + \type node + A4, \field Space 1 Name + \begin-extensible + \required-field + \type object-list + \object-list SpaceNames + A5, \field Space 1 Return Air Node Name + \note Matches a SpaceHVAC:EquipmentConnections Return Air Node Name + \required-field + \type node + \group Fans !*****************AIR LOOP COMPONENTS********************* Fan:SystemModel, @@ -37726,7 +37833,7 @@ AirLoopHVAC:UnitarySystem, \key Yes \key No \default Yes - \note This field is not used when Design Specification Multispeed Object Type input is present + \note This field is not used when Design Specification Multispeed Object Type input is present \note When Yes is selected the minimum air flow rate is used. \note When No is selected the maximum air flow rate is used. N17, \field Maximum Supply Air Temperature @@ -43343,11 +43450,61 @@ Chiller:Electric:EIR, \note Using this triggers a model more suited to series bundle and chillers with higher temperature heat recovery \note If this field is not used, the bundles are modeled as being in parallel \type node - A16; \field End-Use Subcategory + A16, \field End-Use Subcategory \note Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table. \type alpha \retaincase \default General + A17, \field Condenser Flow Control + \note Select the chiller condenser flow request mode. With "ConstantFlow" a chiller will always request + \note its maximum condenser flow rate. With "ModulatedChillerPLR" the condenser flow request corresponds + \note to the chiller part load ratio multiplied by the chiller maximum condenser flow rate. With + \note "ModulatedLoopPLR" the chiller will request a flow rate that is function of the chilled water + \note loop's part load ratio, see the "Condenser Loop Flow Rate Fraction Function of Loop Part Load Ratio + \note Curve Name" input. With "ModulatedDeltaTemperature" the chiller will request the flow rate required to meet + \note the condenser loop load based on the condenser leaving fluid temperature and a reference temperature, + \note see the "Temperature Difference Across Condenser" and "Temperature Difference Across Condenser Schedule + \note Name" input. + \note Use "ConstantFlow" when modeling a constant flow condenser plant loop, choose one of the other inputs + \note when modeling a variable flow condenser plant loop. + \key ConstantFlow + \key ModulatedChillerPLR + \key ModulatedLoopPLR + \key ModulatedDeltaTemperature + \default ConstantFlow + A18, \field Condenser Loop Flow Rate Fraction Function of Loop Part Load Ratio Curve Name + \note Condenser loop flow rate fraction as a function of loop part load ratio + \note CWFR = C * PLR + D + \note Where: + \note CWFR is the condenser water flow fraction (actual/design) + \note C and D are coefficients, see "Optimizing Design & Control Of Chilled Water Plants, Part 5", S. Taylor, ASHRAE Journal June 2012 + \note PLR is the chilled water plant loop part load ratio (actual/design) + \type object-list + \object-list UnivariateFunctions + A19, \field Temperature Difference Across Condenser Schedule Name + \note A schedule that defines the temperature difference across the condenser. This input is used to + \note calculate the condenser flow. This input is only used when "Condenser Flow Control" is set to + \note "ModulatedDeltaTemperature". + \type object-list + \object-list ScheduleNames + N19, \field Condenser Minimum Flow Fraction + \note This input corresponds to the minimum flow fraction to be simulated. The minimum condenser flow + \note corresponds to this fraction multiplied by the maximum condenser flow rate. This input is only used + \note when the "Condenser Flow Control" input is set to "ModulatedChillerPLR", "ModulatedLoopPLR" or + \note "ModulatedDeltaTemperature". + A20, \field Thermosiphon Capacity Fraction Curve Name + \type object-list + \object-list UniVariateFunctions + \note quadratic curve = a + b * (Tevap, out - Tcond, in) is typical, other univariate curves may be used + \note Tevap, out = evaporator outlet temperature + \note Tcond, in = condenser inlet temperature + \note If this field is blank the thermosiphon model is disabled. + N20; \field Thermosiphon Minimum Temperature Difference + \type real + \minimum 0.0 + \default 0.0 + \note Thermosiphon model is disabled below this minimum limit and + \note when the load is greater than calculated using the prevoius field. Chiller:Electric:ReformulatedEIR, \min-fields 22 @@ -43541,11 +43698,61 @@ Chiller:Electric:ReformulatedEIR, \note Using this triggers a model more suited to series bundle and chillers with higher temperature heat recovery \note If this field is not used, the bundles are modeled as being in parallel \type node - A15; \field End-Use Subcategory + A15, \field End-Use Subcategory \note Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table. \type alpha \retaincase \default General + A16, \field Condenser Flow Control + \note Select the chiller condenser flow request mode. With "ConstantFlow" a chiller will always request + \note its maximum condenser flow rate. With "ModulatedChillerPLR" the condenser flow request corresponds + \note to the chiller part load ratio multiplied by the chiller maximum condenser flow rate. With + \note "ModulatedLoopPLR" the chiller will request a flow rate that is function of the chilled water + \note loop's part load ratio, see the "Condenser Loop Flow Rate Fraction Function of Loop Part Load Ratio + \note Curve Name" input. With "ModulatedDeltaTemperature" the chiller will request the flow rate required to meet + \note the condenser loop load based on the condenser leaving fluid temperature and a reference temperature, + \note see the "Temperature Difference Across Condenser" and "Temperature Difference Across Condenser Schedule + \note Name" input. + \note Use "ConstantFlow" when modeling a constant flow condenser plant loop, choose one of the other inputs + \note when modeling a variable flow condenser plant loop. + \key ConstantFlow + \key ModulatedChillerPLR + \key ModulatedLoopPLR + \key ModulatedDeltaTemperature + \default ConstantFlow + A17, \field Condenser Loop Flow Rate Fraction Function of Loop Part Load Ratio Curve Name + \note Condenser loop flow rate fraction as a function of loop part load ratio + \note CWFR = C * PLR + D + \note Where: + \note CWFR is the condenser water flow fraction (actual/design) + \note C and D are coefficients, see "Optimizing Design & Control Of Chilled Water Plants, Part 5", S. Taylor, ASHRAE Journal June 2012 + \note PLR is the chilled water plant loop part load ratio (actual/design) + \type object-list + \object-list UnivariateFunctions + A18, \field Temperature Difference Across Condenser Schedule Name + \note A schedule that defines the temperature difference across the condenser. This input is used to + \note calculate the condenser flow. This input is only used when "Condenser Flow Control" is set to + \note "ModulatedDeltaTemperature". + \type object-list + \object-list ScheduleNames + N16, \field Condenser Minimum Flow Fraction + \note This input corresponds to the minimum flow fraction to be simulated. The minimum condenser flow + \note corresponds to this fraction multiplied by the maximum condenser flow rate. This input is only used + \note when the "Condenser Flow Control" input is set to "ModulatedChillerPLR", "ModulatedLoopPLR" or + \note "ModulatedDeltaTemperature". + A19, \field Thermosiphon Capacity Fraction Curve Name + \type object-list + \object-list UniVariateFunctions + \note quadratic curve = a + b * (Tevap, out - Tcond, in) is typical, other univariate curves may be used + \note Tevap, out = evaporator outlet temperature + \note Tcond, in = condenser inlet temperature + \note If this field is blank the thermosiphon model is disabled. + N17; \field Thermosiphon Minimum Temperature Difference + \type real + \minimum 0.0 + \default 0.0 + \note Thermosiphon model is disabled below this minimum limit and + \note when the load is greater than calculated using the prevoius field. Chiller:Electric, \min-fields 27 @@ -43689,11 +43896,24 @@ Chiller:Electric, \note Using this triggers a model more suited to series bundle and chillers with higher temperature heat recovery \note If this field is not used, the bundles are modeled as being in parallel \type node - A13; \field End-Use Subcategory + A13, \field End-Use Subcategory \note Any text may be used here to categorize the end-uses in the ABUPS End Uses by Subcategory table. \type alpha \retaincase \default General + A14, \field Thermosiphon Capacity Fraction Curve Name + \type object-list + \object-list UniVariateFunctions + \note quadratic curve = a + b * (Tevap, out - Tcond, in) is typical, other univariate curves may be used + \note Tevap, out = evaporator outlet temperature + \note Tcond, in = condenser inlet temperature + \note If this field is blank the thermosiphon model is disabled. + N26; \field Thermosiphon Minimum Temperature Difference + \type real + \minimum 0.0 + \default 0.0 + \note Thermosiphon model is disabled below this minimum limit and + \note when the load is greater than calculated using the prevoius field. Chiller:Absorption:Indirect, \min-fields 17 @@ -44063,7 +44283,7 @@ Chiller:ConstantCOP, \default 2.0 \note This field is only used for Condenser Type = EvaporativelyCooled. \note Enter the outdoor dry-bulb temperature when the basin heater turns on. - A8 ; \field Basin Heater Operating Schedule Name + A8 , \field Basin Heater Operating Schedule Name \type object-list \object-list ScheduleNames \note This field is only used for Condenser Type = EvaporativelyCooled. @@ -44071,6 +44291,19 @@ Chiller:ConstantCOP, \note air dry-bulb temperature is below the basin heater setpoint temperature. \note If a schedule name is not entered, the basin heater is allowed to operate \note throughout the entire simulation. + A9 , \field Thermosiphon Capacity Fraction Curve Name + \type object-list + \object-list UniVariateFunctions + \note quadratic curve = a + b * (Tevap, out - Tcond, in) is typical, other univariate curves may be used + \note Tevap, out = evaporator outlet temperature + \note Tcond, in = condenser inlet temperature + \note If this field is blank the thermosiphon model is disabled. + N8 ; \field Thermosiphon Minimum Temperature Difference + \type real + \minimum 0.0 + \default 0.0 + \note Thermosiphon model is disabled below this minimum limit and + \note when the load is greater than calculated using the prevoius field. Chiller:EngineDriven, \min-fields 43 @@ -44853,7 +45086,7 @@ ChillerHeater:Absorption:DoubleEffect, HeatPump:PlantLoop:EIR:Cooling, \memo An EIR formulated water to water heat pump model, cooling operation. - \min-fields 15 + \min-fields 18 A1, \field Name \type alpha \reference PLHPCoolingNames @@ -44879,7 +45112,13 @@ HeatPump:PlantLoop:EIR:Cooling, A6, \field Source Side Outlet Node Name \required-field \type node - A7, \field Companion Heat Pump Name + A7, \field Heat Recovery Inlet Node Name + \type node + \note Not available with water source condenser type + A8, \field Heat Recovery Outlet Node Name + \type node + \note Not available with water source condenser type + A9, \field Companion Heat Pump Name \note This field allows the user to specify a companion heating \note object for this cooling object. The companion is used in \note sizing the heat pump as well as to allow checks for unexpected @@ -44902,23 +45141,31 @@ HeatPump:PlantLoop:EIR:Cooling, \ip-units gal/min \autosizable \default autosize - N3, \field Reference Capacity + N3, \field Heat Recovery Reference Flow Rate + \type real + \minimum> 0.0 + \units m3/s + \ip-units gal/min + \autosizable + \default autosize + \note Not available with water source condenser type + N4, \field Reference Capacity \type real \minimum> 0.0 \units W \autosizable \default autosize - N4, \field Reference Coefficient of Performance + N5, \field Reference Coefficient of Performance \type real \minimum> 0.0 \default 3.0 \units W/W - N5, \field Sizing Factor + N6, \field Sizing Factor \note Multiplies the autosized load side reference flow rate which is then used to autosize the capacity \type real \minimum> 0.0 \default 1.0 - A8, \field Capacity Modifier Function of Temperature Curve Name + A10, \field Capacity Modifier Function of Temperature Curve Name \note Cooling capacity modifier as a function of CW supply temp and entering condenser temp \required-field \type object-list @@ -44926,7 +45173,7 @@ HeatPump:PlantLoop:EIR:Cooling, \note curve = a + b*CWS + c*CWS**2 + d*ECT + e*ECT**2 + f*CWS*ECT \note CWS = supply (leaving) chilled water temperature(C) \note ECT = entering condenser fluid temperature(C) - A9, \field Electric Input to Output Ratio Modifier Function of Temperature Curve Name + A11, \field Electric Input to Output Ratio Modifier Function of Temperature Curve Name \note Electric Input Ratio (EIR) modifier as a function of temperature \note EIR = 1/COP \required-field @@ -44935,7 +45182,7 @@ HeatPump:PlantLoop:EIR:Cooling, \note curve = a + b*CWS + c*CWS**2 + d*ECT + e*ECT**2 + f*CWS*ECT \note CWS = supply (leaving) chilled water temperature(C) \note ECT = entering condenser fluid temperature(C) - A10, \field Electric Input to Output Ratio Modifier Function of Part Load Ratio Curve Name + A12, \field Electric Input to Output Ratio Modifier Function of Part Load Ratio Curve Name \note Electric Input Ratio (EIR) modifier as a function of Part Load Ratio (PLR) \note EIR = 1/COP \required-field @@ -44943,13 +45190,13 @@ HeatPump:PlantLoop:EIR:Cooling, \object-list UnivariateFunctions \note quadratic curve = a + b*PLR + c*PLR**2 is typical, other univariate curves may be used \note PLR = part load ratio (cooling load/steady state capacity) - A11, \field Control Type + A13, \field Control Type \note Heat pump can be controlled on leaving water temperature set point or plant load \type choice \key Setpoint \key Load \default Load - A12, \field Flow Mode + A14, \field Flow Mode \note Select operating mode for fluid flow through the chiller. "ConstantFlow" is for \note constant pumping with flow controlled by chiller to operate at full design \note flow rate. "VariableSpeedPumping" is for variable pumping with flow proportional @@ -44958,35 +45205,72 @@ HeatPump:PlantLoop:EIR:Cooling, \key ConstantFlow \key VariableSpeedPumping \default ConstantFlow - N6, \field Minimum Part Load Ratio + N7, \field Minimum Part Load Ratio \note Below this operating limit compressor cycling will occur \type real \minimum 0.0 \default 0.0 - N7, \field Minimum Source Inlet Temperature + N8, \field Minimum Source Inlet Temperature \type real \units C \default -100.0 \note Enter the minimum inlet outdoor air dry-bulb temperature \note for air-cooled units or minimum inlet water temperature for water-cooled units. \note The unit is disabled below this temperature. - N8, \field Maximum Source Inlet Temperature + N9, \field Maximum Source Inlet Temperature \type real \units C \default 100.0 \note Enter the maximum inlet outdoor air dry-bulb temperature \note for air-cooled units or maximum inlet water temperature for water-cooled units. \note The unit is disabled above this temperature. - N9, \field Minimum Supply Water Temperature Curve Name + A15, \field Minimum Supply Water Temperature Curve Name \type object-list \object-list UnivariateFunctions \note quadratic curve = a + b*OAT is typical, other univariate curves may be used \note OAT = Outdoor Dry-Bulb Temperature - N10; \field Maximum Supply Water Temperature Curve Name + A16, \field Maximum Supply Water Temperature Curve Name \type object-list \object-list UnivariateFunctions \note quadratic curve = a + b*OAT is typical, other univariate curves may be used \note OAT = Outdoor Dry-Bulb Temperature + N10, \field Maximum Heat Recovery Outlet Temperature + \type real + \units C + \default 60.0 + \note Enter the maximum heat recovery leaving water temperature limit + \note The hot water temperature is not allowed to exceed this value + \note Not available with water source condenser type + A17, \field Heat Recovery Capacity Modifier Function of Temperature Curve Name + \note Cooling capacity modifier as a function of CW supply temp and condenser entering fluid temp + \type object-list + \object-list BivariateFunctions + \note curve = a + b*CWS + c*CWS**2 + d*ECT + e*ECT**2 + f*CWS*ECT + \note CWS = supply (leaving) chilled water temperature(C) + \note ECT = entering condenser fluid temperature(C) + \note If this field is blank, the AWHP curve without heat recovery will be used + A18, \field Heat Recovery Electric Input to Output Ratio Modifier Function of Temperature Curve Name + \note Electric Input Ratio (EIR) modifier as a function of temperature + \note EIR = 1/COP + \type object-list + \object-list BivariateFunctions + \note curve = a + b*CWS + c*CWS**2 + d*ECT + e*ECT**2 + f*CWS*ECT + \note CWS = supply (leaving) chilled water temperature(C) + \note ECT = entering condenser fluid temperature(C) + \note If this field is blank, the AWHP curve without heat recovery will be used + A19, \field Thermosiphon Capacity Fraction Curve Name + \type object-list + \object-list UniVariateFunctions + \note quadratic curve = a + b * (Tevap, out - Tcond, in) is typical, other univariate curves may be used + \note Tevap, out = evaporator outlet temperature + \note Tcond, in = condenser inlet temperature + \note If this field is blank the thermosiphon model is disabled. + N11; \field Thermosiphon Minimum Temperature Difference + \type real + \minimum 0.0 + \default 0.0 + \note Thermosiphon model is disabled below this minimum limit and + \note when the load is greater than calculated using the prevoius field. HeatPump:PlantLoop:EIR:Heating, \memo An EIR formulated water to water heat pump model, heating operation @@ -45016,7 +45300,13 @@ HeatPump:PlantLoop:EIR:Heating, A6, \field Source Side Outlet Node Name \required-field \type node - A7, \field Companion Heat Pump Name + A7, \field Heat Recovery Inlet Node Name + \type node + \note Not available with water source condenser type + A8, \field Heat Recovery Outlet Node Name + \type node + \note Not available with water source condenser type + A9, \field Companion Heat Pump Name \note This field allows the user to specify a companion cooling \note object for this heating object. The companion is used in \note sizing the heat pump as well as to allow checks for unexpected @@ -45039,23 +45329,31 @@ HeatPump:PlantLoop:EIR:Heating, \ip-units gal/min \autosizable \default autosize - N3, \field Reference Capacity + N3, \field Heat Recovery Reference Flow Rate + \type real + \minimum> 0.0 + \units m3/s + \ip-units gal/min + \autosizable + \default autosize + \note Not available with water source condenser type + N4, \field Reference Capacity \type real \minimum> 0.0 \units W \autosizable \default autosize - N4, \field Reference Coefficient of Performance + N5, \field Reference Coefficient of Performance \type real \minimum> 0.0 \default 3.0 \units W/W - N5, \field Sizing Factor + N6, \field Sizing Factor \note Multiplies the autosized load side reference flow rate which is then used to autosize the capacity \type real \minimum> 0.0 \default 1.0 - A8, \field Capacity Modifier Function of Temperature Curve Name + A10, \field Capacity Modifier Function of Temperature Curve Name \note Heating capacity modifier as a function of CW supply temp and entering condenser temp \required-field \type object-list @@ -45063,7 +45361,7 @@ HeatPump:PlantLoop:EIR:Heating, \note curve = a + b*CWS + c*CWS**2 + d*ECT + e*ECT**2 + f*CWS*ECT \note CWS = supply (leaving) hot water temperature(C) \note ECT = entering condenser fluid temperature(C) - A9, \field Electric Input to Output Ratio Modifier Function of Temperature Curve Name + A11, \field Electric Input to Output Ratio Modifier Function of Temperature Curve Name \note Electric Input Ratio (EIR) modifier as a function of temperature \note EIR = 1/COP \required-field @@ -45072,7 +45370,7 @@ HeatPump:PlantLoop:EIR:Heating, \note curve = a + b*CWS + c*CWS**2 + d*ECT + e*ECT**2 + f*CWS*ECT \note CWS = supply (leaving) hot water temperature(C) \note ECT = entering condenser fluid temperature(C) - A10, \field Electric Input to Output Ratio Modifier Function of Part Load Ratio Curve Name + A12, \field Electric Input to Output Ratio Modifier Function of Part Load Ratio Curve Name \note Electric Input Ratio (EIR) modifier as a function of Part Load Ratio (PLR) \note EIR = 1/COP \required-field @@ -45080,25 +45378,25 @@ HeatPump:PlantLoop:EIR:Heating, \object-list UnivariateFunctions \note quadratic curve = a + b*PLR + c*PLR**2 is typical, other univariate curves may be used \note PLR = part load ratio (hot load/steady state capacity) - N6, \field Heating To Cooling Capacity Sizing Ratio + N7, \field Heating To Cooling Capacity Sizing Ratio \note Multiplies the autosized heating capacity \type real \minimum 0.0 \default 1.0 - A11, \field Heat Pump Sizing Method + A13, \field Heat Pump Sizing Method \note Specifies sizing method when companion coil exists \type choice \key CoolingCapacity \key HeatingCapacity \key GreaterOfHeatingOrCooling \default CoolingCapacity - A12, \field Control Type + A14, \field Control Type \note Heat pump can be controlled on leaving water temperature set point or plant load \type choice \key Setpoint \key Load \default Load - A13, \field Flow Mode + A15, \field Flow Mode \note Select operating mode for fluid flow through the chiller. "ConstantFlow" is for \note constant pumping with flow controlled by chiller to operate at full design \note flow rate. "VariableSpeedPumping" is for variable pumping with flow proportional @@ -45107,56 +45405,56 @@ HeatPump:PlantLoop:EIR:Heating, \key ConstantFlow \key VariableSpeedPumping \default ConstantFlow - N7, \field Minimum Part Load Ratio + N8, \field Minimum Part Load Ratio \note Below this operating limit compressor cycling will occur \type real \minimum 0.0 \default 0.0 - N8, \field Minimum Source Inlet Temperature + N9, \field Minimum Source Inlet Temperature \type real \units C \default -100.0 \note Enter the minimum inlet outdoor air dry-bulb temperature \note for air-cooled units or minimum inlet water temperature for water-cooled units. \note The unit is disabled below this temperature. - N9, \field Maximum Source Inlet Temperature + N10, \field Maximum Source Inlet Temperature \type real \units C \default 100.0 \note Enter the maximum inlet outdoor air dry-bulb temperature \note for air-cooled units or maximum inlet water temperature for water-cooled units. \note The unit is disabled above this temperature. - A14, \field Minimum Supply Water Temperature Curve Name + A16, \field Minimum Supply Water Temperature Curve Name \type object-list \object-list UnivariateFunctions \note quadratic curve = a + b*OAT is typical, other univariate curves may be used \note OAT = Outdoor Dry-Bulb Temperature - A15, \field Maximum Supply Water Temperature Curve Name + A17, \field Maximum Supply Water Temperature Curve Name \type object-list \object-list UnivariateFunctions \note quadratic curve = a + b*OAT is typical, other univariate curves may be used \note OAT = Outdoor Dry-Bulb Temperature - A16, \field Dry Outdoor Correction Factor Curve Name + A18, \field Dry Outdoor Correction Factor Curve Name \type object-list \object-list UnivariateFunctions - N10, \field Maximum Outdoor Dry Bulb Temperature For Defrost Operation + N11, \field Maximum Outdoor Dry Bulb Temperature For Defrost Operation \type real \default 10.0 \note defrost operation will not be active above this outdoor temperature - A17, \field Heat Pump Defrost Control + A19, \field Heat Pump Defrost Control \type choice \key None \key Timed \key OnDemand \key TimedEmpirical \note A blank field is the same as None. - N11, \field Heat Pump Defrost Time Period Fraction + N12, \field Heat Pump Defrost Time Period Fraction \type real \minimum 0.0 \default 0.058333 \note Nominal fraction of time in defrost mode \note only applicable if Timed or TimedEmpirical heat pump defrost control is specified - A18, \field Defrost Energy Input Ratio Function of Temperature Curve Name + A20, \field Defrost Energy Input Ratio Function of Temperature Curve Name \type object-list \object-list BivariateFunctions \note univariate curve = a + b*OAT is typical, other univariate curves may be used @@ -45164,14 +45462,14 @@ HeatPump:PlantLoop:EIR:Heating, \note OAT = outdoor air dry-bulb temperature (C) \note WB = wet-bulb temperature (C) of air entering the indoor coil \note only required if Timed or OnDemand defrost strategy is specified - A19, \field Timed Empirical Defrost Frequency Curve Name + A21, \field Timed Empirical Defrost Frequency Curve Name \type object-list \object-list UnivariateFunctions \note univariate curve = a + b*OAT is typical, other univariate curves may be used \note OAT = outdoor air dry-bulb temperature (C) \note Timed Empirical Defrost Frequency fraction in hours = curve output \note only applicable if TimedEmpirical defrost control is specified - A20, \field Timed Empirical Defrost Heat Load Penalty Curve Name + A22, \field Timed Empirical Defrost Heat Load Penalty Curve Name \type object-list \object-list UnivariateFunctions \object-list BivariateFunctions @@ -45181,7 +45479,7 @@ HeatPump:PlantLoop:EIR:Heating, \note WB = wet-bulb temperature (C) of air entering the indoor coil \note Timed Empirical Defrost Heat Load Penalty in watts = hot load * curve output \note only applicable if TimedEmpirical defrost control is specified - A21; \field Timed Empirical Defrost Heat Input Energy Fraction Curve Name + A23, \field Timed Empirical Defrost Heat Input Energy Fraction Curve Name \type object-list \object-list UnivariateFunctions \object-list BivariateFunctions @@ -45191,6 +45489,29 @@ HeatPump:PlantLoop:EIR:Heating, \note WB = wet-bulb temperature (C) of air entering the indoor coil \note Timed Empirical Defrost Heat Input Energy in watts = rated hot load * curve output \note only applicable if TimedEmpirical defrost control is specified + N13, \field Minimum Heat Recovery Outlet Temperature + \type real + \units C + \default 4.5 + \note Enter the minimum heat recovery leaving water temperature limit + \note The chilled water temperature is not allowed to drop below this value + \note Not available with water source condenser type + A24, \field Heat Recovery Capacity Modifier Function of Temperature Curve Name + \note Heating capacity modifier as a function of HW supply temp and entering condenser fluid temp + \type object-list + \object-list BivariateFunctions + \note curve = a + b*HWS + c*HWS**2 + d*ECT + e*ECT**2 + f*HWS*ECT + \note HWS = supply (leaving) hot water temperature(C) + \note ECT = entering condenser fluid temperature(C) + A25; \field Heat Recovery Electric Input to Output Ratio Modifier Function of Temperature Curve Name + \note Electric Input Ratio (EIR) modifier as a function of temperature + \note EIR = 1/COP + \type object-list + \object-list BiVariateFunctions + \note curve = a + b*HWS + c*HWS**2 + d*ECT + e*ECT**2 + f*HWS*ECT + \note HWS = supply (leaving) hot water temperature(C) + \note ECT = entering condenser fluid temperature(C) + \note If this field is blank, the AWHP curve without heat recovery will be used HeatPump:AirToWater:FuelFired:Heating, \memo The object defines a fuel-fired absorption heat pump based on equation-fit models. @@ -63025,117 +63346,122 @@ OutputControl:Files, \key Yes \key No \default Yes - A9 , \field Output Zone Sizing + A9 , \field Output Space Sizing + \type choice + \key Yes + \key No + \default Yes + A10, \field Output Zone Sizing \type choice \key Yes \key No \default Yes - A10, \field Output System Sizing + A11, \field Output System Sizing \type choice \key Yes \key No \default Yes - A11, \field Output DXF + A12, \field Output DXF \type choice \key Yes \key No \default Yes - A12, \field Output BND + A13, \field Output BND \type choice \key Yes \key No \default Yes - A13, \field Output RDD + A14, \field Output RDD \type choice \key Yes \key No \default Yes - A14, \field Output MDD + A15, \field Output MDD \type choice \key Yes \key No \default Yes - A15, \field Output MTD + A16, \field Output MTD \type choice \key Yes \key No \default Yes - A16, \field Output END + A17, \field Output END \type choice \key Yes \key No \default Yes - A17, \field Output SHD + A18, \field Output SHD \type choice \key Yes \key No \default Yes - A18, \field Output DFS + A19, \field Output DFS \type choice \key Yes \key No \default Yes - A19, \field Output GLHE + A20, \field Output GLHE \type choice \key Yes \key No \default Yes - A20, \field Output DelightIn + A21, \field Output DelightIn \type choice \key Yes \key No \default Yes - A21, \field Output DelightELdmp + A22, \field Output DelightELdmp \type choice \key Yes \key No \default Yes - A22, \field Output DelightDFdmp + A23, \field Output DelightDFdmp \type choice \key Yes \key No \default Yes - A23, \field Output EDD + A24, \field Output EDD \type choice \key Yes \key No \default Yes - A24, \field Output DBG + A25, \field Output DBG \type choice \key Yes \key No \default Yes - A25, \field Output PerfLog + A26, \field Output PerfLog \type choice \key Yes \key No \default Yes - A26, \field Output SLN + A27, \field Output SLN \type choice \key Yes \key No \default Yes - A27, \field Output SCI + A28, \field Output SCI \type choice \key Yes \key No \default Yes - A28, \field Output WRL + A29, \field Output WRL \type choice \key Yes \key No \default Yes - A29, \field Output Screen + A30, \field Output Screen \type choice \key Yes \key No \default Yes - A30, \field Output ExtShd + A31, \field Output ExtShd \type choice \key Yes \key No \default Yes - A31; \field Output Tarcog + A32; \field Output Tarcog \note Not Implemented Yet \type choice \key Yes From 5b6a2d8e5d755a9b07da3d593d2a8836e8f76bbd Mon Sep 17 00:00:00 2001 From: Joe Robertson Date: Tue, 27 Aug 2024 09:11:51 -0700 Subject: [PATCH 003/126] Stub ft, vt, and idd version change. --- resources/model/OpenStudio.idd | 4 +- src/energyplus/ForwardTranslator.hpp | 2 +- src/osversion/VersionTranslator.cpp | 25 +- src/osversion/VersionTranslator.hpp | 1 + src/utilities/idd/Test/IddFile_GTest.cpp | 2 +- .../idd/versions/3_8_0/OpenStudio.idd | 40273 ++++++++++++++++ 6 files changed, 40300 insertions(+), 7 deletions(-) create mode 100644 src/utilities/idd/versions/3_8_0/OpenStudio.idd diff --git a/resources/model/OpenStudio.idd b/resources/model/OpenStudio.idd index 105e0d2169f..067e2465634 100644 --- a/resources/model/OpenStudio.idd +++ b/resources/model/OpenStudio.idd @@ -1,4 +1,4 @@ -!IDD_Version 3.8.0 +!IDD_Version 3.9.0 ! ***************************************************************************** ! This file is the Input Data Dictionary (IDD) for OpenStudio Model. ! @@ -40,7 +40,7 @@ OS:Version, \required-field A2, \field Version Identifier \type alpha - \default 3.8.0 + \default 3.9.0 A3; \field Prerelease Identifier \type alpha diff --git a/src/energyplus/ForwardTranslator.hpp b/src/energyplus/ForwardTranslator.hpp index adda3d13d83..976de7e6065 100644 --- a/src/energyplus/ForwardTranslator.hpp +++ b/src/energyplus/ForwardTranslator.hpp @@ -504,7 +504,7 @@ namespace energyplus { struct ForwardTranslatorInitializer; }; -#define ENERGYPLUS_VERSION "24.1" +#define ENERGYPLUS_VERSION "24.2" class ENERGYPLUS_API ForwardTranslator { diff --git a/src/osversion/VersionTranslator.cpp b/src/osversion/VersionTranslator.cpp index b4c7b138e15..279627bf1fd 100644 --- a/src/osversion/VersionTranslator.cpp +++ b/src/osversion/VersionTranslator.cpp @@ -144,7 +144,8 @@ namespace osversion { m_updateMethods[VersionString("3.6.0")] = &VersionTranslator::update_3_5_1_to_3_6_0; m_updateMethods[VersionString("3.7.0")] = &VersionTranslator::update_3_6_1_to_3_7_0; m_updateMethods[VersionString("3.8.0")] = &VersionTranslator::update_3_7_0_to_3_8_0; - // m_updateMethods[VersionString("3.8.0")] = &VersionTranslator::defaultUpdate; + m_updateMethods[VersionString("3.9.0")] = &VersionTranslator::update_3_8_0_to_3_9_0; + // m_updateMethods[VersionString("3.9.0")] = &VersionTranslator::defaultUpdate; // List of previous versions that may be updated to this one. // - To increment the translator, add an entry for the version just released (branched for @@ -181,9 +182,9 @@ namespace osversion { VersionString("2.7.1"), VersionString("2.7.2"), VersionString("2.8.0"), VersionString("2.8.1"), VersionString("2.9.0"), VersionString("2.9.1"), VersionString("3.0.0"), VersionString("3.0.1"), VersionString("3.1.0"), VersionString("3.2.0"), VersionString("3.2.1"), VersionString("3.3.0"), VersionString("3.4.0"), VersionString("3.5.0"), VersionString("3.5.1"), - VersionString("3.6.0"), VersionString("3.6.1"), VersionString("3.7.0"), + VersionString("3.6.0"), VersionString("3.6.1"), VersionString("3.7.0"), VersionString("3.8.0"), // Note: do **not** include the **current** version in m_startVersions, stop at the previous release - //VersionString("3.8.0"), + //VersionString("3.9.0"), }; } @@ -9196,5 +9197,23 @@ namespace osversion { } // end update_3_7_0_to_3_8_0 + std::string VersionTranslator::update_3_8_0_to_3_9_0(const IdfFile& idf_3_8_0, const IddFileAndFactoryWrapper& idd_3_9_0) { + std::stringstream ss; + boost::optional value; + + ss << idf_3_8_0.header() << '\n' << '\n'; + IdfFile targetIdf(idd_3_9_0.iddFile()); + ss << targetIdf.versionObject().get(); + + for (const IdfObject& object : idf_3_8_0.objects()) { + auto iddname = object.iddObject().name(); + + ss << object; + } + + return ss.str(); + + } // end update_3_8_0_to_3_9_0 + } // namespace osversion } // namespace openstudio diff --git a/src/osversion/VersionTranslator.hpp b/src/osversion/VersionTranslator.hpp index b5a93555c6f..4600c2faa75 100644 --- a/src/osversion/VersionTranslator.hpp +++ b/src/osversion/VersionTranslator.hpp @@ -236,6 +236,7 @@ namespace osversion { std::string update_3_5_1_to_3_6_0(const IdfFile& idf_3_5_1, const IddFileAndFactoryWrapper& idd_3_6_0); std::string update_3_6_1_to_3_7_0(const IdfFile& idf_3_6_1, const IddFileAndFactoryWrapper& idd_3_7_0); std::string update_3_7_0_to_3_8_0(const IdfFile& idf_3_7_0, const IddFileAndFactoryWrapper& idd_3_8_0); + std::string update_3_8_0_to_3_9_0(const IdfFile& idf_3_8_0, const IddFileAndFactoryWrapper& idd_3_9_0); IdfObject updateUrlField_0_7_1_to_0_7_2(const IdfObject& object, unsigned index); diff --git a/src/utilities/idd/Test/IddFile_GTest.cpp b/src/utilities/idd/Test/IddFile_GTest.cpp index d9f2ed725ce..4127bfd0113 100644 --- a/src/utilities/idd/Test/IddFile_GTest.cpp +++ b/src/utilities/idd/Test/IddFile_GTest.cpp @@ -55,7 +55,7 @@ TEST_F(IddFixture, EpIddFile) { EXPECT_EQ("", logMessage.logMessage()); } - EXPECT_EQ("24.1.0", loadedIddFile->version()); + EXPECT_EQ("24.2.0", loadedIddFile->version()); EXPECT_EQ(epIddFile.objects().size(), loadedIddFile->objects().size()); if (epIddFile.objects().size() != loadedIddFile->objects().size()) { // get sets of IddObjectType diff --git a/src/utilities/idd/versions/3_8_0/OpenStudio.idd b/src/utilities/idd/versions/3_8_0/OpenStudio.idd new file mode 100644 index 00000000000..105e0d2169f --- /dev/null +++ b/src/utilities/idd/versions/3_8_0/OpenStudio.idd @@ -0,0 +1,40273 @@ +!IDD_Version 3.8.0 +! ***************************************************************************** +! This file is the Input Data Dictionary (IDD) for OpenStudio Model. +! +! Please see the EnergyPlus IDD Header for data formatting information. In +! addition to the syntax listed there, we add the following syntax items: +! +! Field-level comments: +! +! \type handle The field holds the UUID of the IDF object. This is used in lieu of names +! to keep track of references. It also enables \object-list AllObjects, which +! can point to any object. +! +! \type url The field references a file on at some location. The reference +! may be a relative file path (in which case a set of search locations +! are used to find the file at run time), or it may be an +! absolute path to a local file. +! +! Object-level comments: +! +! \url-object Use if the object includes one or more fields of url type. +! +! Grouping comments: +! +! The groups in the OpenStudio IDD represent high level groupings of similar objects. +! ModelEditor displays un-parented objects in their corresponding group, where each group +! is collapsible. +! +! ************************************************************************** + +\group OpenStudio Core + +OS:Version, + \unique-object + \required-object + \format singleLine + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Version Identifier + \type alpha + \default 3.8.0 + A3; \field Prerelease Identifier + \type alpha + +OS:ComponentData, + \memo Defines the meta-data and contents of a Component, that is, a + \memo subset of an OpenStudio Model. + \extensible:1 + \min-fields 7 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \note This should be the name of the Component as listed in the + \note Component Library. + \type alpha + \required-field + \reference ComponentNames + A3, \field UUID + \note This is a UUID that follows the Component throughout its life, + \note both in Models and in the Component Library. + \type alpha + \required-field + A4, \field Version UUID + \note This UUID should be changed whenever the Component is modified. + \type alpha + \required-field + A5, \field Creation Timestamp + \note Unix timestamp from January 1, 1970 00:00 GMT, in seconds. + \type integer + A6, \field Version Timestamp + \note Unix timestamp from January 1, 1970 00:00 GMT, in seconds. + \type integer + A7; \field Name of Object + \note The first object listed should be the primary object, which + \note indicates the overall Component type. + \type object-list + \required-field + \begin-extensible + \object-list AllObjects + +\group OpenStudio Simulation + +OS:ConvergenceLimits, + \unique-object + \min-fields 1 + A1, \field Handle + \type handle + \required-field + N1, \field Minimum System Timestep + \note 0 sets the minimum to the zone timestep (ref: Timestep) + \note 1 is normal (ratchet down to 1 minute) + \note setting greater than zone timestep (in minutes) will effectively set to zone timestep + \type integer + \units minutes + \minimum 0 + \maximum 60 + N2, \field Maximum HVAC Iterations + \type integer + \minimum 1 + \default 20 + N3, \field Minimum Plant Iterations + \note Controls the minimum number of plant system solver iterations within a single HVAC iteration + \note Larger values will increase runtime but might improve solution accuracy for complicated plant systems + \note Complex plants include: several interconnected loops, heat recovery, thermal load following generators, etc. + \type integer + \minimum 1 + \default 2 + N4; \field Maximum Plant Iterations + \note Controls the maximum number of plant system solver iterations within a single HVAC iteration + \note Smaller values might decrease runtime but could decrease solution accuracy for complicated plant systems + \type integer + \minimum 2 + \default 8 + +OS:ProgramControl, + \memo used to support various efforts in time reduction for simulation including threading + A1, \field Handle + \type handle + \required-field + N1; \field Number of Threads Allowed + \type integer + \minimum 0 + \note This is currently used only in the Interior Radiant Exchange module -- view factors on # surfaces + \note if value is 0, then maximum number allowed will be used. + +OS:HeatBalanceAlgorithm, + \memo Determines which Heat Balance Algorithm will be used ie. + \memo CTF (Conduction Transfer Functions), + \memo EMPD (Effective Moisture Penetration Depth with Conduction Transfer Functions). + \memo Advanced/Research Usage: CondFD (Conduction Finite Difference) + \memo Advanced/Research Usage: ConductionFiniteDifferenceSimplified + \memo Advanced/Research Usage: HAMT (Combined Heat And Moisture Finite Element) + \unique-object + \format singleLine + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Algorithm + \type choice + \default ConductionTransferFunction + \key ConductionTransferFunction + \key MoisturePenetrationDepthConductionTransferFunction + \key ConductionFiniteDifference + \key CombinedHeatAndMoistureFiniteElement + N1, \field Surface Temperature Upper Limit + \type real + \units C + \minimum 200 + \default 200.0 + N2, \field Minimum Surface Convection Heat Transfer Coefficient Value + \type real + \units W/m2-K + \minimum> 0 + \default 0.1 + N3; \field Maximum Surface Convection Heat Transfer Coefficient Value + \type real + \units W/m2-K + \minimum 1 + \default 1000 + +OS:RunPeriod, + \unique-object + \min-fields 12 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \note descriptive name (used in reporting mainly) + \note if blank, weather file title is used. if not blank, must be unique + \note EnergyPlus Start Year field is captured in OS:YearDescription object + \type alpha + \required-field + \reference RunPeriods + \reference RunPeriodsAndDesignDays + N1, \field Begin Month + \type integer + \required-field + \minimum 1 + \maximum 12 + N2, \field Begin Day of Month + \type integer + \required-field + \minimum 1 + \maximum 31 + N3, \field End Month + \type integer + \required-field + \minimum 1 + \maximum 12 + N4, \field End Day of Month + \type integer + \required-field + \minimum 1 + \maximum 31 + A3, \field Use Weather File Holidays and Special Days + \note If yes or blank, use holidays as specified on Weatherfile. + \note If no, do not use the holidays specified on the Weatherfile. + \note Note: You can still specify holidays/special days using the RunPeriodControl:SpecialDays object(s). + \type choice + \default Yes + \key Yes + \key No + A4, \field Use Weather File Daylight Saving Period + \note If yes or blank, use daylight saving period as specified on Weatherfile. + \note If no, do not use the daylight saving period as specified on the Weatherfile. + \type choice + \default Yes + \key Yes + \key No + A5, \field Apply Weekend Holiday Rule + \note if yes and single day holiday falls on weekend, "holiday" occurs on following Monday + \type choice + \default No + \key Yes + \key No + A6, \field Use Weather File Rain Indicators + \type choice + \default Yes + \key Yes + \key No + A7, \field Use Weather File Snow Indicators + \type choice + \default Yes + \key Yes + \key No + N5; \field Number of Times Runperiod to be Repeated + \type integer + \minimum 1 + \default 1 + +OS:RunPeriodControl:DaylightSavingTime, + \memo This object sets up the daylight saving time period for any RunPeriod. + \memo Ignores any daylight saving time period on the weather file and uses this definition. + \memo These are not used with SizingPeriod:DesignDay objects. + \memo Use with SizingPeriod:WeatherFileDays object can be controlled in that object. + \unique-object + \min-fields 3 + A1, \field Handle + \type handle + \required-field + A2, \field Start Date + \type alpha + \required-field + A3; \field End Date + \note Dates can be several formats: + \note / (month/day) + \note + \note + \note in in + \note can be January, February, March, April, May, June, July, August, September, October, November, December + \note Months can be the first 3 letters of the month + \note can be Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday + \note can be 1 or 1st, 2 or 2nd, etc. up to 5(?) + \type alpha + \required-field + +OS:RunPeriodControl:SpecialDays, + \memo This object sets up holidays/special days to be used during weather file + \memo run periods. (These are not used with SizingPeriod:* objects.) + \memo Depending on the value in the run period, days on the weather file may also + \memo be used. However, the weather file specification will take precedence over + \memo any specification shown here. (No error message on duplicate days or overlapping + \memo days). + \min-fields 5 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + A3, \field Start Date + \note Dates can be several formats: + \note / (month/day) + \note + \note + \note in in + \note can be January, February, March, April, May, June, July, August, September, October, November, December + \note Months can be the first 3 letters of the month + \note can be Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday + \note can be 1 or 1st, 2 or 2nd, etc. up to 5(?) + \type alpha + \required-field + N1, \field Duration + \type real + \units days + \minimum 1 + \maximum 366 + \default 1 + A4; \field Special Day Type + \note Special Day Type selects the schedules appropriate for each day so labeled + \type choice + \default Holiday + \key Holiday + \key SummerDesignDay + \key WinterDesignDay + \key CustomDay1 + \key CustomDay2 + +OS:ShadowCalculation, + \unique-object + \min-fields 2 + \memo This object is used to control details of the solar, shading, and daylighting models + \extensible:1 + A1, \field Handle + \type handle + \required-field + A2 , \field Shading Calculation Method + \note Select between CPU-based polygon clipping method, the GPU-based pixel counting method, + \note or importing from external shading data. + \note If PixelCounting is selected and GPU hardware (or GPU emulation) is not available, a warning will be + \note displayed and EnergyPlus will revert to PolygonClipping. + \note If Scheduled is chosen, the Sunlit Fraction Schedule Name is required + \note in SurfaceProperty:LocalEnvironment. + \note If Imported is chosen, the Schedule:File:Shading object is required. + \type choice + \key PolygonClipping + \key PixelCounting + \key Scheduled + \key Imported + \required-field + \note the default value is PolygonClipping + A3 , \field Shading Calculation Update Frequency Method + \note choose calculation frequency method. note that Timestep is only needed for certain cases + \note and can increase execution time significantly. + \type choice + \key Periodic + \key Timestep + \default Periodic + N1 , \field Shading Calculation Update Frequency + \type integer + \minimum 1 + \default 20 + \note enter number of days + \note this field is only used if the previous field is set to Periodic + \note warning issued if >31 + N2 , \field Maximum Figures in Shadow Overlap Calculations + \note Number of allowable figures in shadow overlap in PolygonClipping calculations + \type integer + \minimum 200 + \default 15000 + A4 , \field Polygon Clipping Algorithm + \note Advanced Feature. Internal default is SutherlandHodgman + \note Refer to InputOutput Reference and Engineering Reference for more information + \type choice + \key ConvexWeilerAtherton + \key SutherlandHodgman + \key SlaterBarskyandSutherlandHodgman + \default SutherlandHodgman + N3 , \field Pixel Counting Resolution + \note Number of pixels in both dimensions of the surface rendering + \type integer + \required-field + \note the default is 512 + A5 , \field Sky Diffuse Modeling Algorithm + \note Advanced Feature. Internal default is SimpleSkyDiffuseModeling + \note If you have shading elements that change transmittance over the + \note year, you may wish to choose the detailed method. + \note Refer to InputOutput Reference and Engineering Reference for more information + \type choice + \key SimpleSkyDiffuseModeling + \key DetailedSkyDiffuseModeling + \default SimpleSkyDiffuseModeling + A6 , \field Output External Shading Calculation Results + \type choice + \key Yes + \key No + \required-field + \note the default is No + \note If Yes is chosen, the calculated external shading fraction results will be saved to an external CSV file with surface names as the column headers. + A6 , \field Disable Self-Shading Within Shading Zone Groups + \note If Yes, self-shading will be disabled from all exterior surfaces in a given Shading Zone Group to surfaces within + \note the same Shading Zone Group. + \note If both Disable Self-Shading Within Shading Zone Groups and Disable Self-Shading From Shading Zone Groups to Other Zones = Yes, + \note then all self-shading from exterior surfaces will be disabled. + \note If only one of these fields = Yes, then at least one Shading Zone Group must be specified, or this field will be ignored. + \note Shading from Shading:* surfaces, overhangs, fins, and reveals will not be disabled. + \type choice + \key Yes + \key No + \required-field + \note the default is No + A8 , \field Disable Self-Shading From Shading Zone Groups to Other Zones + \note If Yes, self-shading will be disabled from all exterior surfaces in a given Shading Zone Group to all other zones in the model. + \note If both Disable Self-Shading Within Shading Zone Groups and Disable Self-Shading From Shading Zone Groups to Other Zones = Yes, + \note then all self-shading from exterior surfaces will be disabled. + \note If only one of these fields = Yes, then at least one Shading Zone Group must be specified, or this field will be ignored. + \note Shading from Shading:* surfaces, overhangs, fins, and reveals will not be disabled. + \type choice + \key Yes + \key No + \required-field + \note the default is No + A9 ; \field Shading Zone Group + \note Specifies a group of zones which are controlled by the Disable Self-Shading fields. + \type object-list + \object-list ModelObjectLists + \begin-extensible + +OS:SimulationControl, + \memo Note that the following 3 fields are related to the Sizing:Zone, Sizing:System, + \memo and Sizing:Plant objects. Having these fields set to Yes but no corresponding + \memo Sizing object will not cause the sizing to be done. However, having any of these + \memo fields set to No, the corresponding Sizing object is ignored. + \memo Note also, if you want to do system sizing, you must also do zone sizing in the same + \memo run or an error will result. + \unique-object + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Do Zone Sizing Calculation + \note If Yes, Zone sizing is accomplished from corresponding Sizing:Zone objects + \note and autosize fields. + \type choice + \default No + \key Yes + \key No + A3, \field Do System Sizing Calculation + \note If Yes, System sizing is accomplished from corresponding Sizing:System objects + \note and autosize fields. + \note If Yes, Zone sizing (previous field) must also be Yes. + \type choice + \default No + \key Yes + \key No + A4, \field Do Plant Sizing Calculation + \note If Yes, Plant sizing is accomplished from corresponding Sizing:Plant objects + \note and autosize fields. + \type choice + \default No + \key Yes + \key No + A5, \field Run Simulation for Sizing Periods + \note If Yes, SizingPeriod objects are executed and results from those may be displayed.. + \type choice + \default Yes + \key Yes + \key No + A6, \field Run Simulation for Weather File Run Periods + \note If Yes, RunPeriod objects are executed and results from those may be displayed.. + \type choice + \default Yes + \key Yes + \key No + N1, \field Loads Convergence Tolerance Value + \note Loads Convergence Tolerance Value is a fraction of load + \type real + \minimum> 0 + \maximum 0.5 + \default .04 + \units W + N2, \field Temperature Convergence Tolerance Value + \type real + \units deltaC + \minimum> 0 + \maximum 0.5 + \default .4 + A7, \field Solar Distribution + \note MinimalShadowing | FullExterior | FullInteriorAndExterior | FullExteriorWithReflections | FullInteriorAndExteriorWithReflections + \type choice + \default FullExterior + \key MinimalShadowing + \key FullExterior + \key FullInteriorAndExterior + \key FullExteriorWithReflections + \key FullInteriorAndExteriorWithReflections + N3, \field Maximum Number of Warmup Days + \note EnergyPlus will only use as many warmup days as needed to reach convergence tolerance. + \note This field's value should NOT be set less than 25. + \type integer + \minimum> 0 + \default 25 + N5, \field Minimum Number of Warmup Days + \note The minimum number of warmup days that produce enough temperature and flux history + \note to start EnergyPlus simulation for all reference buildings was suggested to be 6. + \note When this field is greater than the maximum warmup days defined previous field + \note the maximum number of warmup days will be reset to the minimum value entered here. + \note Warmup days will be set to be the value you entered when it is less than the default 1. + \type integer + \minimum> 0 + \default 1 + A8, \field Do HVAC Sizing Simulation for Sizing Periods + \note If Yes, SizingPeriod:* objects are executed additional times for advanced sizing. + \note Currently limited to use with coincident plant sizing, see Sizing:Plant object + \type choice + \key Yes + \key No + \default No + N6; \field Maximum Number of HVAC Sizing Simulation Passes + \note the entire set of SizingPeriod:* objects may be repeated to fine tune size results + \note this input sets a limit on the number of passes that the sizing algorithms can repeat the set + \type integer + \minimum 1 + \default 1 + +OS:PerformancePrecisionTradeoffs, + \unique-object + \memo This object enables users to choose certain options that speed up EnergyPlus simulation, + \memo but may lead to small decreases in accuracy of results. + \min-fields 2 + A1, \field Handle + \type handle + \required-field + A2, \field Use Coil Direct Solutions + \note If Yes, an analytical or empirical solution will be used to replace iterations in + \note the coil performance calculations. + \type choice + \key Yes + \key No + \default No + A3, \field Zone Radiant Exchange Algorithm + \note Determines which algorithm will be used to solve long wave radiant exchange among surfaces within a zone. + \type choice + \key ScriptF + \key CarrollMRT + \default ScriptF + A4, \field Override Mode + \note The increasing mode number roughly correspond with increased speed. A description of each mode + \note are shown in the documentation. When Advanced is selected the N1 field value is used. + \type choice + \key Normal + \key Mode01 + \key Mode02 + \key Mode03 + \key Mode04 + \key Mode05 + \key Mode06 + \key Mode07 + \key Mode08 + \key Advanced + \default Normal + N1, \field MaxZoneTempDiff + \note Maximum zone temperature change before HVAC timestep is shortened. + \note Only used when Override Mode is set to Advanced + \type real + \minimum 0.1 + \maximum 3.0 + \default 0.3 + N2, \field MaxAllowedDelTemp + \note Maximum surface temperature change before HVAC timestep is shortened. + \note Only used when Override Mode is set to Advanced + \type real + \minimum 0.002 + \maximum 0.1 + \default 0.002 + A5; \field Use Representative Surfaces for Calculations + \note Automatically group surfaces with similar characteristics and perform relevant calculations only once for each group. + \type choice + \key Yes + \key No + \default No + +OS:Sizing:Parameters, + \unique-object + \min-fields 2 + A1, \field Handle + \type handle + \required-field + N1, \field Heating Sizing Factor + \type real + \minimum> 0 + \default 1.0 + N2, \field Cooling Sizing Factor + \type real + \minimum> 0 + \default 1.0 + N3; \field Timesteps in Averaging Window + \note blank => set the timesteps in averaging window to + \note Number of Timesteps per Hour resulting in a 1 hour averaging window + \note default is number of timesteps for 1 hour averaging window + \type integer + \minimum 1 + +OS:SurfaceConvectionAlgorithm:Inside, + \memo Default indoor surface heat transfer convection algorithm to be used for all zones + \unique-object + \format singleLine + \min-fields 2 + A1, \field Handle + \type handle + \required-field + A2; \field Algorithm + \note Simple = constant value natural convection (ASHRAE) + \note TARP = variable natural convection based on temperature difference (ASHRAE, Walton) + \note CeilingDiffuser = ACH-based forced and mixed convection correlations + \note for ceiling diffuser configuration with simple natural convection limit + \note AdaptiveConvectionAlgorithm = dynamic selection of convection models based on conditions + \note ASTMC1340 = mixed convection correlations based on heat flow direction, + \note surface tilt angle, surface characteristic length, and air speed past the surface. + \type choice + \default TARP + \key Simple + \key TARP + \key CeilingDiffuser + \key AdaptiveConvectionAlgorithm + \key ASTMC1340 + +OS:SurfaceConvectionAlgorithm:Outside, + \memo Default outside surface heat transfer convection algorithm to be used for all zones + \unique-object + \format singleLine + \min-fields 2 + A1, \field Handle + \type handle + \required-field + A2; \field Algorithm + \note SimpleCombined = Combined radiation and convection coefficient using simple ASHRAE model + \note TARP = correlation from models developed by ASHRAE, Walton, and Sparrow et. al. + \note MoWiTT = correlation from measurements by Klems and Yazdanian for smooth surfaces + \note DOE-2 = correlation from measurements by Klems and Yazdanian for rough surfaces + \note AdaptiveConvectionAlgorithm = dynamic selection of correlations based on conditions + \type choice + \default DOE-2 + \key SimpleCombined + \key TARP + \key MoWiTT + \key DOE-2 + \key AdaptiveConvectionAlgorithm + +OS:Timestep, + \unique-object + \format singleLine + \min-fields 2 + A1, \field Handle + \type handle + \required-field + N1; \field Number of Timesteps per Hour + \note Number in hour: normal validity 4 to 60: 6 suggested + \note Must be evenly divisible into 60 + \note Allowable values include 1, 2, 3, 4, 5, 6, 10, 12, 15, 20, 30, and 60 + \note Normal 6 is mimimum as lower values may cause inaccuracies + \note A minimum value of 20 is suggested for both ConductionFiniteDifference + \note and CombinedHeatAndMoistureFiniteElement surface heat balance alogorithms + \note A minimum of 12 is suggested for simulations involving a Vegetated Roof (Material:RoofVegetation). + \type integer + \minimum 1 + \maximum 60 + \default 6 + +OS:YearDescription, + \unique-object + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Calendar Year + \type integer + A3, \field Day of Week for Start Day + \note Not used if calendar year is given + \note =|Sunday|Monday|Tuesday|Wednesday|Thursday|Friday|Saturday]; + \type choice + \default UseWeatherFile + \key Sunday + \key Monday + \key Tuesday + \key Wednesday + \key Thursday + \key Friday + \key Saturday + \key UseWeatherFile + A4; \field Is Leap Year + \note Not used if calendar year is given + \type choice + \default No + \key Yes + \key No + +OS:ZoneAirContaminantBalance, + \memo Determines which contaminant concentration will be simulates. + \unique-object + \format singleLine + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Carbon Dioxide Concentration + \note If Yes, CO2 simulation will be performed. + \type choice + \default No + \key Yes + \key No + A3; \field Outdoor Carbon Dioxide Schedule Name + \note Schedule values should be in parts per million (ppm) + \type object-list + \object-list ScheduleNames + +OS:ZoneAirHeatBalanceAlgorithm, + \memo Controls the zone/space air heat balance. + \unique-object + \format singleLine + \min-fields 4 + A1, \field Handle + \type handle + \required-field + A2, \field Algorithm + \note Determines which algorithm will be used to solve the air heat balance + \type choice + \default ThirdOrderBackwardDifference + \key ThirdOrderBackwardDifference + \key AnalyticalSolution + \key EulerMethod + A3, \field Do Space Heat Balance for Sizing + \note If yes, space heat balance will be calculated and reported during sizing. + \type choice + \key No + \key Yes + \default No + A4; \field Do Space Heat Balance for Simulation + \note If yes, space heat balance will be calculated and reported during simulation. + \type choice + \key No + \key Yes + \default No + +OS:ZoneAirMassFlowConservation, + \memo Enforces the zone air mass flow balance by adjusting zone mixing object flow rates. + \memo The infiltration object mass flow rate may also be adjusted or may add infiltration + \memo air flow to the base infiltration air flow for source zones only. + \unique-object + A1, \field Handle + \type handle + \required-field + A2, \field Adjust Zone Mixing and Return For Air Mass Flow Balance + \type choice + \key AdjustMixingOnly + \key AdjustReturnOnly + \key AdjustMixingThenReturn + \key AdjustReturnThenMixing + \key None + \default None + A3, \field Infiltration Balancing Method + \type choice + \key AddInfiltrationFlow + \key AdjustInfiltrationFlow + \key None + \default AddInfiltrationFlow + A4; \field Infiltration Balancing Zones + \type choice + \key MixingSourceZonesOnly + \key AllZones + \default MixingSourceZonesOnly + +OS:ZoneCapacitanceMultiplier:ResearchSpecial, + \memo Multiplier altering the relative capacitance of the air compared to an empty zone + \unique-object + \format singleLine + \min-fields 4 + A1, \field Handle + \type handle + \required-field + N1, \field Temperature Capacity Multiplier + \note Used to alter the capacitance of zone air with respect to heat or temperature + \type real + \minimum> 0 + \default 1.0 + N2, \field Humidity Capacity Multiplier + \note Used to alter the capacitance of zone air with respect to moisture or humidity ratio + \type real + \minimum> 0 + \default 1.0 + N3; \field Carbon Dioxide Capacity Multiplier + \note Used to alter the capacitance of zone air with respect to zone air contaminant concentration + \type real + \minimum> 0 + \default 1.0 + +OS:RadianceParameters, + \memo Radiance simulation parameters + \unique-object + A1, \field Handle + \type handle + \required-field + N1, \field Accumulated Rays per Record + \note accumulated rays per record, -c option to rcontrib + \note The -c option tells rcontrib how many rays to accumulate for each + \note record. The default value is 1, meaning a full record will be produced + \note for each input ray. For values greater than 1, contributions will be + \note averaged together over the given number of input rays. + \type integer + \minimum 1 + \default 1 + N2, \field Direct Threshold + \note direct sampling threshold, -dt option to rtrace/rpict. Sets the direct threshold to frac. + \note Shadow testing will stop when the potential contribution of at least the next and at most + \note all remaining light source samples is less than this fraction of the accumulated value. + \note The remaining light source contributions are approximated statistically. A value of zero + \note means that all light source samples will be tested for shadow. + \type real + \minimum 0.0 + \default 0.0 + N3, \field Direct Certainty + \note direct certainty, -dc option to rtrace/rpict. + \note Sets the direct certainty to frac. A value of one guarantees that the absolute + \note accuracy of the direct calculation will be equal to or better than that given + \note in the -dt specification. A value of zero only insures that all shadow lines + \note resulting in a contrast change greater than the -dt specification will be calculated. + \type real + \minimum 0.0 + \default 1.0 + N4, \field Direct Jitter + \note direct jitter, -dj option to rtrace/rpict. + \note Sets the direct certainty to frac. A value of one guarantees that the absolute + \note accuracy of the direct calculation will be equal to or better than that given + \note in the -dt specification. A value of zero only insures that all shadow lines + \note resulting in a contrast change greater than the -dt specification will be calculated. + \type real + \minimum 0.0 + \default 1.0 + N5, \field Direct Pretest + \note direct jitter, -dp option to rtrace/rpict. + \note Set the secondary source presampling density to D. This is the number of + \note samples per steradian that will be used to determine ahead of time whether + \note or not it is worth following shadow rays through all the reflections and/or + \note transmissions associated with a secondary source path. A value of 0 means that + \note the full secondary source path will always be tested for shadows if it is tested at all. + \type real + \minimum 0.0 + \default 1.0 + N6, \field Ambient Bounces VMX + \note ambient bounces, -ab option to rtrace/rpict. + \note Set the number of ambient bounces to N. This is the maximum number of diffuse + \note bounces computed by the indirect calculation. A value of zero implies no indirect calculation. + \note This is for view matrix (VMX) calculations with rcontrib. + \type integer + \minimum 0 + \default 6 + N7, \field Ambient Bounces DMX + \note ambient bounces, -ab option to rtrace/rpict. + \note Set the number of ambient bounces to N. This is the maximum number of diffuse + \note bounces computed by the indirect calculation. A value of zero implies no indirect calculation. + \note This is for daylight matrix (DMX) calculations with rcontrib, and classic renderings with rpict. + \type integer + \minimum 0 + \default 2 + N8, \field Ambient Divisions VMX + \note ambient bounces, -ad option to rtrace/rpict. + \note Set the number of ambient divisions to N. The error in the Monte Carlo + \note calculation of indirect illuminance will be inversely proportional to the + \note square root of this number. A value of zero implies no indirect calculation. + \note This is for view matrix (VMX) calculations with rcontrib. + \type integer + \minimum 0 + \default 4050 + N9, \field Ambient Divisions DMX + \note ambient bounces, -ad option to rtrace/rpict. + \note Set the number of ambient divisions to N. The error in the Monte Carlo + \note calculation of indirect illuminance will be inversely proportional to the + \note square root of this number. A value of zero implies no indirect calculation. + \note This is for daylight matrix (DMX) calculations with rcontrib, and classic renderings with rpict. + \type integer + \minimum 0 + \default 512 + N10, \field Ambient Supersamples + \note ambient supersamples, -as option to rtrace/rpict. + \note Set the number of ambient divisions to N. The error in the Monte Carlo + \note calculation of indirect illuminance will be inversely proportional to the + \note square root of this number. A value of zero implies no indirect calculation. + \type integer + \minimum 0 + \default 256 + N11, \field Limit Weight VMX + \note limit weight, -lw option to rtrace/rpict. + \note Limit the weight of each ray to a minimum of frac. During ray-tracing, a + \note record is kept of the estimated contribution (weight) a ray would have in + \note the image. If this weight is less than the specified minimum and the -lr + \note setting (above) is positive, the ray is not traced. Otherwise, Russian + \note roulette is used to continue rays with a probability equal to the ray weight + \note divided by the given frac. (Ideally, this value is the -ad value^-1 for VMX calcs) + \type real + \minimum 0.0 + \default 0.001 + N12, \field Limit Weight DMX + \note limit weight, -lw option to rtrace/rpict. + \note Limit the weight of each ray to a minimum of frac. During ray-tracing, a + \note record is kept of the estimated contribution (weight) a ray would have in + \note the image. If this weight is less than the specified minimum and the -lr + \note setting (above) is positive, the ray is not traced. Otherwise, Russian + \note roulette is used to continue rays with a probability equal to the ray weight + \note divided by the given frac. + \type real + \default 0.001 + N13, \field Klems Sampling Density + \note number of rays per outgoing Klems direction, -c option to rcontrib. + \note Sets the Klems sampling density for daylight matrix calculations. + \type integer + \default 500 + A2; \field Sky Discretization Resolution + \note number of rays per outgoing Klems direction, -m:n option to rcontrib. + \note Sets sky discretization resolution for daylight coefficient calculations. + \type choice + \default 146 + \key 146 + \key 578 + \key 2306 + +\group OpenStudio Site + +OS:ClimateZones, + \unique-object + \extensible:4 + A1, \field Handle + \type handle + \required-field + A2, \field Climate Zone Institution Name + \type alpha + \begin-extensible + \default ASHRAE + A3, \field Climate Zone Document Name + \type alpha + \default ANSI/ASHRAE Standard 169 + N1, \field Climate Zone Document Year + \type integer + \minimum 0 + \default 2006 + A5; \field Climate Zone Value + \type alpha + \required-field + +OS:Site, + \unique-object + \min-fields 7 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + N1, \field Latitude + \note + is North, - is South, degree minutes represented in decimal (i.e. 30 minutes is .5) + \type real + \units deg + \minimum -90 + \maximum 90 + \default 0.0 + N2, \field Longitude + \note - is West, + is East, degree minutes represented in decimal (i.e. 30 minutes is .5) + \type real + \units deg + \minimum -180 + \maximum 180 + \default 0.0 + N3, \field Time Zone + \note basic these limits on the WorldTimeZone Map (2003) + \note Time relative to GMT. Decimal hours. + \type real + \units hr + \minimum -12 + \maximum 14 + \default 0.0 + N4, \field Elevation + \type real + \units m + \minimum -300 + \maximum< 8900 + \default 0.0 + A3; \field Terrain + \note Country=FlatOpenCountry | Suburbs=CountryTownsSuburbs | City=CityCenter | Ocean=body of water (5km) | Urban=Urban-Industrial-Forest + \type choice + \default Suburbs + \key Country + \key Suburbs + \key City + \key Ocean + \key Urban + +OS:Site:GroundTemperature:BuildingSurface, + \memo These temperatures are specifically for those surfaces that have the outside environment + \memo of "Ground". Documentation about what values these should be is located in the + \memo Auxiliary programs document (Ground Heat Transfer) as well as the InputOutput Reference. + \memo CAUTION - Do not use the "undisturbed" ground temperatures from the weather data. + \memo These values are too extreme for the soil under a conditioned building. + \memo For best results, use the Slab or Basement program to calculate custom monthly + \memo average ground temperatures (see Auxiliary Programs). For typical commercial + \memo buildings in the USA, a reasonable default value is 2C less than the average indoor space temperature. + \unique-object + \format singleLine + \min-fields 13 + A1, \field Handle + \type handle + \required-field + N1, \field January Ground Temperature + \type real + \units C + \default 18 + N2, \field February Ground Temperature + \type real + \units C + \default 18 + N3, \field March Ground Temperature + \type real + \units C + \default 18 + N4, \field April Ground Temperature + \type real + \units C + \default 18 + N5, \field May Ground Temperature + \type real + \units C + \default 18 + N6, \field June Ground Temperature + \type real + \units C + \default 18 + N7, \field July Ground Temperature + \type real + \units C + \default 18 + N8, \field August Ground Temperature + \type real + \units C + \default 18 + N9, \field September Ground Temperature + \type real + \units C + \default 18 + N10, \field October Ground Temperature + \type real + \units C + \default 18 + N11, \field November Ground Temperature + \type real + \units C + \default 18 + N12; \field December Ground Temperature + \type real + \units C + \default 18 + +OS:Site:GroundTemperature:FCfactorMethod, + \memo These temperatures are specifically for underground walls and ground floors + \memo defined with the C-factor and F-factor methods, and should be close to the + \memo monthly average outdoor air temperature delayed by 3 months for the location. + \unique-object + \min-fields 13 + \format singleLine + A1, \field Handle + \type handle + \required-field + N1 , \field January Ground Temperature + \units C + \type real + \default 13 + N2 , \field February Ground Temperature + \units C + \type real + \default 13 + N3 , \field March Ground Temperature + \units C + \type real + \default 13 + N4 , \field April Ground Temperature + \units C + \type real + \default 13 + N5 , \field May Ground Temperature + \units C + \type real + \default 13 + N6 , \field June Ground Temperature + \units C + \type real + \default 13 + N7 , \field July Ground Temperature + \units C + \type real + \default 13 + N8 , \field August Ground Temperature + \units C + \type real + \default 13 + N9 , \field September Ground Temperature + \units C + \type real + \default 13 + N10, \field October Ground Temperature + \units C + \type real + \default 13 + N11, \field November Ground Temperature + \units C + \type real + \default 13 + N12; \field December Ground Temperature + \units C + \type real + \default 13 + +OS:Site:GroundTemperature:Shallow, + \memo These temperatures are specifically for the Surface Ground Heat Exchanger and + \memo should probably be close to the average outdoor air temperature for the location. + \memo They are not used in other models. + \unique-object + \min-fields 13 + \format singleLine + A1, \field Handle + \type handle + \required-field + N1 , \field January Surface Ground Temperature + \units C + \type real + \default 13 + N2 , \field February Surface Ground Temperature + \units C + \type real + \default 13 + N3 , \field March Surface Ground Temperature + \units C + \type real + \default 13 + N4 , \field April Surface Ground Temperature + \units C + \type real + \default 13 + N5 , \field May Surface Ground Temperature + \units C + \type real + \default 13 + N6 , \field June Surface Ground Temperature + \units C + \type real + \default 13 + N7 , \field July Surface Ground Temperature + \units C + \type real + \default 13 + N8 , \field August Surface Ground Temperature + \units C + \type real + \default 13 + N9 , \field September Surface Ground Temperature + \units C + \type real + \default 13 + N10, \field October Surface Ground Temperature + \units C + \type real + \default 13 + N11, \field November Surface Ground Temperature + \units C + \type real + \default 13 + N12; \field December Surface Ground Temperature + \units C + \type real + \default 13 + +OS:Site:GroundTemperature:Deep, + \memo These temperatures are specifically for the ground heat exchangers that would use + \memo "deep" (3-4 m depth) ground temperatures for their heat source. + \memo They are not used in other models. + \unique-object + \min-fields 13 + \format singleLine + A1, \field Handle + \type handle + \required-field + N1 , \field January Deep Ground Temperature + \units C + \type real + \default 16 + N2 , \field February Deep Ground Temperature + \units C + \type real + \default 16 + N3 , \field March Deep Ground Temperature + \units C + \type real + \default 16 + N4 , \field April Deep Ground Temperature + \units C + \type real + \default 16 + N5 , \field May Deep Ground Temperature + \units C + \type real + \default 16 + N6 , \field June Deep Ground Temperature + \units C + \type real + \default 16 + N7 , \field July Deep Ground Temperature + \units C + \type real + \default 16 + N8 , \field August Deep Ground Temperature + \units C + \type real + \default 16 + N9 , \field September Deep Ground Temperature + \units C + \type real + \default 16 + N10, \field October Deep Ground Temperature + \units C + \type real + \default 16 + N11, \field November Deep Ground Temperature + \units C + \type real + \default 16 + N12; \field December Deep Ground Temperature + \units C + \type real + \default 16 + +OS:Site:GroundTemperature:Undisturbed:KusudaAchenbach, + \memo Undisturbed ground temperature object using the + \memo Kusuda-Achenbach 1965 correlation. + \min-fields 8 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \required-field + \reference UndisturbedGroundTempModels + N1, \field Soil Thermal Conductivity + \required-field + \type real + \units W/m-K + \minimum> 0.0 + N2, \field Soil Density + \required-field + \type real + \units kg/m3 + \minimum> 0.0 + N3, \field Soil Specific Heat + \required-field + \type real + \units J/kg-K + \minimum> 0.0 + N4, \field Average Soil Surface Temperature + \type real + \units C + \note Annual average surface temperature + \note If left blank the Site:GroundTemperature:Shallow object must be included in the input + \note The soil temperature, amplitude, and phase shift must all be included or omitted together + N5, \field Average Amplitude of Surface Temperature + \type real + \units deltaC + \minimum 0 + \note Annual average surface temperature variation from average. + \note If left blank the Site:GroundTemperature:Shallow object must be included in the input + \note The soil temperature, amplitude, and phase shift must all be included or omitted together + N6; \field Phase Shift of Minimum Surface Temperature + \type real + \units days + \minimum 0 + \maximum< 365 + \note The phase shift of minimum surface temperature, or the day + \note of the year when the minimum surface temperature occurs. + \note If left blank the Site:GroundTemperature:Shallow object must be included in the input + \note The soil temperature, amplitude, and phase shift must all be included or omitted together + +OS:Site:GroundTemperature:Undisturbed:Xing, + \memo Undisturbed ground temperature object using the + \memo Xing 2014 2 harmonic parameter model. + \min-fields 10 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \required-field + \reference UndisturbedGroundTempModels + N1, \field Soil Thermal Conductivity + \required-field + \type real + \units W/m-K + \minimum> 0.0 + N2, \field Soil Density + \required-field + \type real + \units kg/m3 + \minimum> 0.0 + N3, \field Soil Specific Heat + \required-field + \type real + \units J/kg-K + \minimum> 0.0 + N4, \field Average Soil Surface Temperature + \required-field + \type real + \units C + N5, \field Soil Surface Temperature Amplitude 1 + \required-field + \type real + \units deltaC + N6, \field Soil Surface Temperature Amplitude 2 + \required-field + \type real + \units deltaC + N7, \field Phase Shift of Temperature Amplitude 1 + \required-field + \type real + \units days + \maximum< 365 + N8; \field Phase Shift of Temperature Amplitude 2 + \required-field + \type real + \units days + \maximum< 365 + +OS:Site:GroundReflectance, + \unique-object + \min-fields 13 + \format singleLine + A1, \field Handle + \type handle + \required-field + N1 , \field January Ground Reflectance + \default 0.2 + \type real + \minimum 0.0 + \maximum 1.0 + \units dimensionless + N2 , \field February Ground Reflectance + \default 0.2 + \type real + \minimum 0.0 + \maximum 1.0 + \units dimensionless + N3 , \field March Ground Reflectance + \default 0.2 + \type real + \minimum 0.0 + \maximum 1.0 + \units dimensionless + N4 , \field April Ground Reflectance + \default 0.2 + \type real + \minimum 0.0 + \maximum 1.0 + \units dimensionless + N5 , \field May Ground Reflectance + \default 0.2 + \type real + \minimum 0.0 + \maximum 1.0 + \units dimensionless + N6 , \field June Ground Reflectance + \default 0.2 + \type real + \minimum 0.0 + \maximum 1.0 + \units dimensionless + N7 , \field July Ground Reflectance + \default 0.2 + \type real + \minimum 0.0 + \maximum 1.0 + \units dimensionless + N8 , \field August Ground Reflectance + \default 0.2 + \type real + \minimum 0.0 + \maximum 1.0 + \units dimensionless + N9 , \field September Ground Reflectance + \default 0.2 + \type real + \minimum 0.0 + \maximum 1.0 + \units dimensionless + N10 , \field October Ground Reflectance + \default 0.2 + \type real + \minimum 0.0 + \maximum 1.0 + \units dimensionless + N11 , \field November Ground Reflectance + \default 0.2 + \type real + \minimum 0.0 + \maximum 1.0 + \units dimensionless + N12 ; \field December Ground Reflectance + \default 0.2 + \type real + \minimum 0.0 + \maximum 1.0 + \units dimensionless + +OS:Site:WaterMainsTemperature, + \unique-object + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Calculation Method + \type choice + \required-field + \key Schedule + \key Correlation + \key CorrelationFromWeatherFile + \note If calculation method is CorrelationFromWeatherFile, the two numeric input + \note fields are ignored. Instead, EnergyPlus calculates them from weather file. + A3, \field Temperature Schedule Name + \type object-list + \object-list ScheduleNames + N1, \field Annual Average Outdoor Air Temperature + \type real + \units C + N2; \field Maximum Difference In Monthly Average Outdoor Air Temperatures + \type real + \units deltaC + \minimum 0 + +OS:SizingPeriod:DesignDay, + \min-fields 20 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference DesignDays + \reference RunPeriodsAndDesignDays + N1, \field Maximum Dry-Bulb Temperature + \note This field is required when field "Dry-Bulb Temperature Range Modifier Type" + \note is not "TemperatureProfileSchedule". + \type real + \units C + \minimum -90 + \maximum 70 + \default 23.0 + N2, \field Daily Dry-Bulb Temperature Range + \note Must still produce appropriate maximum dry bulb (within range) + \note This field is not needed if Dry-Bulb Temperature Range Modifier Type + \note is "delta". + \type real + \units deltaC + \minimum 0 + \default 0.0 + N3, \field Barometric Pressure + \note This field's value is also checked against the calculated "standard barometric pressure" + \note for the location. If out of range (>10%), then is replaced by standard value. + \type real + \units Pa + \ip-units inHg + \minimum 31000 + \maximum 120000 + \default 31000.0 + N4, \field Wind Speed + \type real + \units m/s + \ip-units miles/hr + \minimum 0 + \maximum 40 + \default 0.0 + N5, \field Wind Direction + \note North=0.0 East=90.0 + \note 0 and 360 are the same direction. + \type real + \units deg + \minimum 0 + \maximum 360 + \default 0.0 + N6, \field Sky Clearness + \note Only used if Sky Model Indicator = ASHRAEClearSky + \note 0.0 is totally unclear, 1.0 is totally clear + \type real + \minimum 0 + \maximum 1.2 + \default 0.0 + A3, \field Rain Indicator + \note Yes is raining (all day), No is not raining + \type choice + \key Yes + \key No + \default No + A4, \field Snow Indicator + \type choice + \key Yes + \key No + \default No + \note Yes is Snow on Ground, No is no Snow on Grou + N7, \field Day of Month + \note must be valid for Month field + \type integer + \minimum 1 + \maximum 31 + \default 1 + N8, \field Month + \type integer + \minimum 1 + \maximum 12 + \default 1 + A5, \field Day Type + \note Day Type selects the schedules appropriate for this design day + \type choice + \default SummerDesignDay + \key Sunday + \key Monday + \key Tuesday + \key Wednesday + \key Thursday + \key Friday + \key Saturday + \key Holiday + \key SummerDesignDay + \key WinterDesignDay + \key CustomDay1 + \key CustomDay2 + A6, \field Daylight Saving Time Indicator + \note Yes -- use schedules modified for Daylight Saving Time Schedules. + \note No - do not use schedules modified for Daylight Saving Time Schedules + \type choice + \key Yes + \key No + \default No + A7, \field Humidity Condition Type + \note values/schedules indicated here and in subsequent fields create the humidity + \note values in the 24 hour design day conditions profile. + \type choice + \default WetBulb + \key WetBulb + \key DewPoint + \key HumidityRatio + \key Enthalpy + \key RelativeHumiditySchedule + \key WetBulbProfileMultiplierSchedule + \key WetBulbProfileDifferenceSchedule + \key WetBulbProfileDefaultMultipliers + A8, \field Humidity Condition Day Schedule Name + \note Only used when Humidity Condition Type is "RelativeHumiditySchedule", + \note "WetBulbProfileMultiplierSchedule", or "WetBulbProfileDifferenceSchedule" + \note For type "RelativeHumiditySchedule", the hour/time interval values should specify + \note relative humidity (percent) from 0.0 to 100.0. + \note For type "WetBulbProfileMultiplierSchedule" the hour/time interval values should specify + \note the fraction (0-1) of the wet-bulb temperature range to be subtracted from the + \note maximum wet-bulb temperature for each timestep in the day (units = Fraction) + \note For type "WetBulbProfileDifferenceSchedule" the values should specify a number to be subtracted + \note from the maximum wet-bulb temperature for each timestep in the day. (units = deltaC) + \type object-list + \object-list DayScheduleNames + N9, \field Wetbulb or DewPoint at Maximum Dry-Bulb + \note Wetbulb or dewpoint temperature coincident with the maximum temperature. + \note Required only if field Humidity Condition Type is "Wetbulb", "Dewpoint", + \note "WetBulbProfileMultiplierSchedule", "WetBulbProfileDifferenceSchedule", + \note or "WetBulbProfileDefaultMultipliers" + \type real + \units C + N10, \field Humidity Ratio at Maximum Dry-Bulb + \note Humidity ratio coincident with the maximum temperature (constant humidity ratio throughout day). + \note Required only if field Humidity Condition Type is "HumidityRatio". + \type real + \units kgWater/kgDryAir + N11, \field Enthalpy at Maximum Dry-Bulb + \note Enthalpy coincident with the maximum temperature. + \note Required only if field Humidity Condition Type is "Enthalpy". + \type real + \units J/kg + A9, \field Dry-Bulb Temperature Range Modifier Type + \note Type of modifier to the dry-bulb temperature calculated for the timestep + \type choice + \default DefaultMultipliers + \key MultiplierSchedule + \key DifferenceSchedule + \key TemperatureProfileSchedule + \key DefaultMultipliers + A10, \field Dry-Bulb Temperature Range Modifier Day Schedule Name + \note Only used when previous field is "MultiplierSchedule", "DifferenceSchedule" or + \note "TemperatureProfileSchedule". + \note For type "MultiplierSchedule" the hour/time interval values should specify + \note the fraction (0-1) of the dry-bulb temperature range to be subtracted + \note from the maximum dry-bulb temperature for each timestep in the day + \note For type "DifferenceSchedule" the values should specify a number to be subtracted + \note from the maximum dry-bulb temperature for each timestep in the day. + \note Note that numbers in the difference schedule cannot be negative as that + \note would result in a higher maximum than the maximum previously specified. + \note For type "TemperatureProfileSchedule" the values should specify the actual dry-bulb + \note temperature for each timestep in the day. + \type object-list + \object-list DayScheduleNames + A11, \field Solar Model Indicator + \type choice + \default ASHRAEClearSky + \key ASHRAEClearSky + \key ZhangHuang + \key Schedule + \key ASHRAETau + \key ASHRAETau2017 + A12, \field Beam Solar Day Schedule Name + \note if Solar Model Indicator = Schedule, then beam schedule name (for day) + \type object-list + \object-list DayScheduleNames + A13, \field Diffuse Solar Day Schedule Name + \note if Solar Model Indicator = Schedule, then diffuse schedule name (for day) + \type object-list + \object-list DayScheduleNames + N12, \field ASHRAE Clear Sky Optical Depth for Beam Irradiance + \units dimensionless + \note Required if Solar Model Indicator = ASHRAETau or ASHRAETau2017 + \note ASHRAETau2017 solar model can be used with 2013 and 2017 HOF matching taub + \minimum 0 + \maximum 1.2 + \default 0 + N13, \field ASHRAE Clear Sky Optical Depth for Diffuse Irradiance + \units dimensionless + \note required if solar model indicator = ashraetau or ashraetau2017 + \note ashraetau2017 solar model can be used with 2013 and 2017 hof matching taud + \minimum 0 + \maximum 3 + \default 0 + N14, \field Daily Wet-Bulb Temperature Range + \note Required only if Humidity Indicating Type = "WetbulbProfileMultiplierSchedule" or "WetBulbProfileDefaultMultipliers" + \type real + \units deltaC + N15, \field Maximum Number Warmup Days + \note If used this design day will be run with a custom limit on the maximum number of days that are repeated for warmup. + \note Limiting the number of warmup days can improve run time. + \type integer + A14; \field Begin Environment Reset Mode + \note If used this can control if you want the thermal history to be reset at the beginning of the design day. + \note When using a series of similar design days, this field can be used to retain warmup state from the previous design day. + \type choice + \key FullResetAtBeginEnvironment + \key SuppressAllBeginEnvironmentResets + \default FullResetAtBeginEnvironment + +OS:SizingPeriod:WeatherFileConditionType, + \memo Use a weather file period for design sizing calculations. + \memo EPW weather files are created with typical and extreme periods + \memo created heuristically from the weather file data. For more + \memo details on these periods, see AuxiliaryPrograms document. + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \note user supplied name for reporting + \type alpha + \required-field + \reference DesignDays + \reference RunPeriodsAndDesignDays + A3, \field Period Selection + \note Following is a list of all possible types of Extreme and Typical periods that + \note might be identified in the Weather File. Not all possible types are available + \note for all weather files. + \type choice + \required-field + \retaincase + \key SummerExtreme + \key SummerTypical + \key WinterExtreme + \key WinterTypical + \key AutumnTypical + \key SpringTypical + \key WetSeason + \key DrySeason + \key NoDrySeason + \key NoWetSeason + \key TropicalHot + \key TropicalCold + \key NoDrySeasonMax + \key NoDrySeasonMin + \key NoWetSeasonMax + \key NoWetSeasonMin + A4, \field Day of Week for Start Day + \note =[|Sunday|Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|SummerDesignDay|WinterDesignDay| + \note |CustomDay1|CustomDay2]; + \note if you use SummerDesignDay or WinterDesignDay or the CustomDays then this will apply + \note to the whole period; other days (i.e., Monday) will signify a start day and + \note normal sequence ofsubsequent days + \type choice + \default Monday + \key Sunday + \key Monday + \key Tuesday + \key Wednesday + \key Thursday + \key Friday + \key Saturday + \key SummerDesignDay + \key WinterDesignDay + \key CustomDay1 + \key CustomDay2 + A5, \field Use Weather File Daylight Saving Period + \note If yes or blank, use daylight saving period as specified on Weatherfile. + \note If no, do not use the daylight saving period as specified on the Weatherfile. + \type choice + \default Yes + \key Yes + \key No + A6; \field Use Weather File Rain and Snow Indicators + \type choice + \default Yes + \key Yes + \key No + +OS:SizingPeriod:WeatherFileDays, + \memo Use a weather file period for design sizing calculations. + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \note user supplied name for reporting + \type alpha + \required-field + \reference DesignDays + \reference RunPeriodsAndDesignDays + N1, \field Begin Month + \type integer + \required-field + \minimum 1 + \maximum 12 + N2, \field Begin Day of Month + \type integer + \required-field + \minimum 1 + \maximum 31 + N3, \field End Month + \type integer + \required-field + \minimum 1 + \maximum 12 + N4, \field End Day of Month + \type integer + \required-field + \minimum 1 + \maximum 31 + A3, \field Day of Week for Start Day + \note =[|Sunday|Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|SummerDesignDay|WinterDesignDay| + \note |CustomDay1|CustomDay2]; + \note if you use SummerDesignDay or WinterDesignDay or the CustomDays then this will apply + \note to the whole period; other days (i.e., Monday) will signify a start day and + \note normal sequence ofsubsequent days + \type choice + \default Monday + \key Sunday + \key Monday + \key Tuesday + \key Wednesday + \key Thursday + \key Friday + \key Saturday + \key SummerDesignDay + \key WinterDesignDay + \key CustomDay1 + \key CustomDay2 + A4, \field Use Weather File Daylight Saving Period + \note If yes or blank, use daylight saving period as specified on Weatherfile. + \note If no, do not use the daylight saving period as specified on the Weatherfile. + \type choice + \default Yes + \key Yes + \key No + A5; \field Use Weather File Rain and Snow Indicators + \type choice + \default Yes + \key Yes + \key No + +OS:WeatherFile, + \unique-object + \url-object + \min-fields 12 + \memo OS:WeatherFile object uniquely identifies a weather file for lookup in a database + A1, \field Handle + \type handle + \required-field + A2, \field City + \type alpha + \required-field + A3, \field State Province Region + \type alpha + \required-field + A4, \field Country + \type alpha + \required-field + A5, \field Data Source + \type alpha + \required-field + A6, \field WMO Number + \type alpha + \required-field + N1, \field Latitude + \note + is North, - is South, degree minutes represented in decimal (i.e. 30 minutes is .5) + \type real + \required-field + \units deg + \minimum -90 + \maximum 90 + N2, \field Longitude + \note - is West, + is East, degree minutes represented in decimal (i.e. 30 minutes is .5) + \type real + \required-field + \units deg + \minimum -180 + \maximum 180 + N3, \field Time Zone + \note Time relative to GMT. Decimal hours. + \note basic these limits on the WorldTimeZone Map (2003) + \type real + \required-field + \units hr + \minimum -12 + \maximum 14 + N4, \field Elevation + \type real + \units m + \minimum -300 + \maximum< 8900 + \default 0.0 + A7, \field Url + \retaincase + \type url + A8, \field Checksum + \type alpha + A9, \field Start Date Actual Year + \type integer + A10; \field Start Day of Week + \type choice + \key Sunday + \key Monday + \key Tuesday + \key Wednesday + \key Thursday + \key Friday + \key Saturday + +OS:WeatherProperty:SkyTemperature, + \memo This object is used to override internal sky temperature calculations. + \memo NOTE: not actually used in OpenStudio Model API + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \note blank in this field will apply to all run periods (that is, all objects= + \note SizingPeriod:WeatherFileDays, SizingPeriod:WeatherFileConditionType or RunPeriod + \note otherwise, this name must match one of the environment object names. + \type object-list + \object-list RunPeriodsAndDesignDays + A3, \field Calculation Type + \note The field indicates that the sky temperature will be imported from external schedules or calculated by alternative methods other than default. + \type choice + \required-field + \key ClarkAllen + \key Brunt + \key Idso + \key BerdahlMartin + \key ScheduleValue + \key DifferenceScheduleDryBulbValue + \key DifferenceScheduleDewPointValue + A4, \field Schedule Name + \note if name matches a SizingPeriod:DesignDay, put in a day schedule of this name + \note if name is for a SizingPeriod:WeatherFileDays, SizingPeriod:WeatherFileConditionType or + \note RunPeriod, put in a full year schedule that covers the appropriate days. + \note Required if Calculation Type is ScheduleValue, DifferenceScheduleDryBulbValue or DifferenceScheduleDewPointValue. + \type object-list + \required-field + \object-list ScheduleAndDayScheduleNames + A5; \field Use Weather File Horizontal IR + \note If yes or blank, use Horizontal IR values from weather file when present, otherwise use the specified sky model. + \note If no, always use the specified sky model and ignore the horizontal IR values from the weather file. + \note For Calculation Type = ScheduleValue, DifferenceScheduleDryBulbValue or DifferenceScheduleDewPointValue, this field is ignored and the scheduled values are used. + \type choice + \required-field + \key Yes + \key No + +\group OpenStudio Resources + +OS:AdditionalProperties, + \min-fields 2 + \extensible:3 + A1, \field Handle + \type handle + \required-field + A2, \field Object Name + \type object-list + \required-field + \object-list AllObjects + A3, \field Feature Name + \type alpha + \begin-extensible + \required-field + A4, \field Feature Data Type + \type choice + \key String + \key Double + \key Boolean + \key Integer + \required-field + A5; \field Feature Value + \type alpha + \required-field + +OS:BuildingStory, + \min-fields 7 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference BuildingStoryNames + \reference SpaceAndSpaceGroupNames + N1, \field Nominal Z Coordinate + \type real + \units m + N2, \field Nominal Floor to Floor Height + \type real + \units m + \minimum> 0 + A3, \field Default Construction Set Name + \type object-list + \object-list DefaultConstructionSetNames + A4, \field Default Schedule Set Name + \type object-list + \object-list DefaultScheduleSetNames + A5, \field Group Rendering Name + \type object-list + \object-list GroupRenderingNames + N3; \field Nominal Floor to Ceiling Height + \type real + \units m + \minimum> 0 + +OS:BuildingUnit, + \min-fields 4 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \reference BuildingUnitNames + \required-field + A3, \field Rendering Color + \type object-list + \object-list GroupRenderingNames + A4; \field Building Unit Type + \type choice + \key Residential + \key NonResidential + \default Residential + +OS:DefaultConstructionSet, + \min-fields 12 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference DefaultConstructionSetNames + A3, \field Default Exterior Surface Constructions Name + \type object-list + \object-list DefaultSurfaceConstructionsNames + A4, \field Default Interior Surface Constructions Name + \type object-list + \object-list DefaultSurfaceConstructionsNames + A5, \field Default Ground Contact Surface Constructions Name + \type object-list + \object-list DefaultSurfaceConstructionsNames + A6, \field Default Exterior SubSurface Constructions Name + \type object-list + \object-list DefaultSubSurfaceConstructionsNames + A7, \field Default Interior SubSurface Constructions Name + \type object-list + \object-list DefaultSubSurfaceConstructionsNames + A8, \field Interior Partition Construction Name + \type object-list + \object-list ConstructionNames + A9, \field Space Shading Construction Name + \type object-list + \object-list ConstructionNames + A10, \field Building Shading Construction Name + \type object-list + \object-list ConstructionNames + A11, \field Site Shading Construction Name + \type object-list + \object-list ConstructionNames + A12; \field Adiabatic Surface Construction Name + \type object-list + \object-list ConstructionNames + +OS:DefaultScheduleSet, + \min-fields 12 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference DefaultScheduleSetNames + A3, \field Hours of Operation Schedule Name + \type object-list + \object-list ScheduleNames + A4, \field Number of People Schedule Name + \type object-list + \object-list ScheduleNames + A5, \field People Activity Level Schedule Name + \type object-list + \object-list ScheduleNames + A6, \field Lighting Schedule Name + \type object-list + \object-list ScheduleNames + A7, \field Electric Equipment Schedule Name + \type object-list + \object-list ScheduleNames + A8, \field Gas Equipment Schedule Name + \type object-list + \object-list ScheduleNames + A9, \field Hot Water Equipment Schedule Name + \type object-list + \object-list ScheduleNames + A10, \field Infiltration Schedule Name + \type object-list + \object-list ScheduleNames + A11, \field Steam Equipment Schedule Name + \type object-list + \object-list ScheduleNames + A12; \field Other Equipment Schedule Name + \type object-list + \object-list ScheduleNames + +OS:DefaultSubSurfaceConstructions, + \min-fields 10 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference DefaultSubSurfaceConstructionsNames + A3, \field Fixed Window Construction Name + \type object-list + \object-list ConstructionNames + A4, \field Operable Window Construction Name + \type object-list + \object-list ConstructionNames + A5, \field Door Construction Name + \type object-list + \object-list ConstructionNames + A6, \field Glass Door Construction Name + \type object-list + \object-list ConstructionNames + A7, \field Overhead Door Construction Name + \type object-list + \object-list ConstructionNames + A8, \field Skylight Construction Name + \type object-list + \object-list ConstructionNames + A9, \field Tubular Daylight Dome Construction Name + \type object-list + \object-list ConstructionNames + A10; \field Tubular Daylight Diffuser Construction Name + \type object-list + \object-list ConstructionNames + +OS:DefaultSurfaceConstructions, + \min-fields 5 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference DefaultSurfaceConstructionsNames + A3, \field Floor Construction Name + \type object-list + \object-list ConstructionNames + A4, \field Wall Construction Name + \type object-list + \object-list ConstructionNames + A5; \field Roof Ceiling Construction Name + \type object-list + \object-list ConstructionNames + +OS:Rendering:Color, + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference AllRenderingNames + \reference SurfaceRenderingNames + \reference GroupRenderingNames + N1, \field Rendering Red Value + \type integer + \required-field + \minimum 0 + \maximum 255 + N2, \field Rendering Green Value + \type integer + \required-field + \minimum 0 + \maximum 255 + N3, \field Rendering Blue Value + \type integer + \required-field + \minimum 0 + \maximum 255 + N4; \field Rendering Alpha Value + \type integer + \minimum 0 + \maximum 255 + \default 255 + +OS:SpaceType, + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference SpaceTypeNames + \reference SpaceAndSpaceTypeNames + \reference SpaceAndSpaceGroupNames + A3, \field Default Construction Set Name + \type object-list + \object-list DefaultConstructionSetNames + A4, \field Default Schedule Set Name + \type object-list + \object-list DefaultScheduleSetNames + A5, \field Group Rendering Name + \type object-list + \object-list GroupRenderingNames + A6, \field Design Specification Outdoor Air Object Name + \type object-list + \object-list DesignSpecificationOutdoorAirNames + A7, \field Standards Template + \type alpha + \note This is a freeform field used to identify the energy standard template for standards. + \note Standards applied to this model will use this field to determine correct levels for lighting, occupancy, etc. + \note More information can be found at https://github.com/NREL/openstudio-standards. + A8, \field Standards Building Type + \type alpha + \note This is a freeform field used to identify the building type for standards. + \note Standards applied to this model will use this field to determine correct levels for lighting, occupancy, etc. + \note More information can be found at https://github.com/NREL/openstudio-standards. + A9; \field Standards Space Type + \type alpha + \note This is a freeform field used to identify the space type for standards. + \note Standards applied to this model will use this field to determine correct levels for lighting, occupancy, etc. + \note More information can be found at https://github.com/NREL/openstudio-standards. + +OS:ModelObjectList, + \min-fields 1 + \extensible:1 Just duplicate last field and comments (changing numbering, please) + A1, \field Handle + \type Handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference ModelObjectLists + A3; \field Model Object 1 + \begin-extensible + \type object-list + \object-list AllObjects + +\group OpenStudio Materials + +OS:Material, + \memo Regular materials described with full set of thermal properties + \min-fields 7 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference MaterialNames + \reference MaterialWithPropertyNames + A3, \field Roughness + \type choice + \required-field + \key VeryRough + \key Rough + \key MediumRough + \key MediumSmooth + \key Smooth + \key VerySmooth + N1, \field Thickness + \type real + \required-field + \units m + \ip-units in + \minimum> 0 + N2, \field Conductivity + \type real + \required-field + \units W/m-K + \ip-units Btu-in/hr-ft2-R + \minimum> 0 + N3, \field Density + \type real + \required-field + \units kg/m3 + \minimum> 0 + N4, \field Specific Heat + \type real + \required-field + \units J/kg-K + \ip-units Btu/lb-R + \minimum 100 + N5, \field Thermal Absorptance + \type real + \minimum> 0 + \maximum 0.99999 + \default .9 + N6, \field Solar Absorptance + \type real + \minimum 0 + \maximum 1 + \default .7 + N7; \field Visible Absorptance + \type real + \minimum 0 + \maximum 1 + \default .7 + +OS:Material:AirGap, + \memo Air Space in Opaque Construction + \min-fields 3 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference MaterialNames + N1; \field Thermal Resistance + \type real + \units m2-K/W + \minimum> 0 + +OS:Material:InfraredTransparent, + \memo Special infrared transparent material. Similar to a Material:Nomass with low thermal resistance. + \memo High absorptance in both wavelengths. + \memo Area will be doubled internally to make internal radiant exchange accurate. + \memo Should be only material in single layer surface construction. + \memo All thermal properties are set internally. User needs only to supply name. + \memo Cannot be used with ConductionFiniteDifference solution algorithms + \min-fields 2 + A1, \field Handle + \type handle + \required-field + A2; \field Name + \type alpha + \required-field + \reference MaterialNames + +OS:Material:NoMass, + \memo Regular materials properties described whose principal description is R (Thermal Resistance) + \min-fields 4 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference MaterialNames + \reference MaterialWithPropertyNames + A3, \field Roughness + \type choice + \required-field + \key VeryRough + \key Rough + \key MediumRough + \key MediumSmooth + \key Smooth + \key VerySmooth + N1, \field Thermal Resistance + \type real + \required-field + \units m2-K/W + \minimum 0.001 + N2, \field Thermal Absorptance + \type real + \minimum> 0 + \maximum 0.99999 + \default .9 + N3, \field Solar Absorptance + \type real + \minimum 0 + \maximum 1 + \default .7 + N4; \field Visible Absorptance + \type real + \minimum 0 + \maximum 1 + \default .7 + +OS:Material:RoofVegetation, + \memo EcoRoof model, plant layer plus soil layer + \memo Implemented by Portland State University + \memo (Sailor et al., January, 2007) + \memo only one material must be referenced per simulation though the same EcoRoof material could be + \memo used in multiple constructions. New moisture redistribution scheme (2010) requires higher + \memo number of timesteps per hour (minimum 12 recommended). + \min-fields 19 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference MaterialNames + N1, \field Height of Plants + \note The ecoroof module is designed for short plants and shrubs. + \type real + \units m + \minimum> 0.005 + \maximum 1 + \default .2 + N2, \field Leaf Area Index + \note Entire surface is assumed covered, so decrease LAI accordingly. + \type real + \units dimensionless + \minimum> 0.001 + \maximum 5 + \default 1.0 + N3, \field Leaf Reflectivity + \note Leaf reflectivity (albedo) is typically 0.18-0.25 + \type real + \units dimensionless + \minimum 0.05 + \maximum 0.5 + \default 0.22 + N4, \field Leaf Emissivity + \type real + \minimum 0.8 + \maximum 1 + \default 0.95 + N5, \field Minimum Stomatal Resistance + \note This depends upon plant type + \type real + \units s/m + \minimum 50 + \maximum 300 + \default 180.0 + A3, \field Soil Layer Name + \type alpha + \default Green Roof Soil + A4, \field Roughness + \type choice + \default MediumRough + \key VeryRough + \key MediumRough + \key Rough + \key Smooth + \key MediumSmooth + \key VerySmooth + N6, \field Thickness + \note thickness of the soil layer of the EcoRoof + \note Soil depths of 0.15m (6in) and 0.30m (12in) are common. + \type real + \units m + \ip-units in + \minimum> 0.05 + \maximum 0.7 + \default 0.1 + N7, \field Conductivity of Dry Soil + \note Thermal conductivity of dry soil. + \note Typical ecoroof soils range from 0.3 to 0.5 + \type real + \units W/m-K + \ip-units Btu-in/hr-ft2-R + \minimum 0.2 + \maximum 1.5 + \default 0.35 + N8, \field Density of Dry Soil + \note Density of dry soil (the code modifies this as the soil becomes moist) + \note Typical ecoroof soils range from 400 to 1000 (dry to wet) + \type real + \units kg/m3 + \minimum 300 + \maximum 2000 + \default 1100.0 + N9, \field Specific Heat of Dry Soil + \note Specific heat of dry soil + \type real + \units J/kg-K + \ip-units Btu/lb-R + \minimum> 500 + \maximum 2000 + \default 1200.0 + N10, \field Thermal Absorptance + \note Soil emissivity is typically in range of 0.90 to 0.98 + \type real + \minimum> 0.8 + \maximum 1 + \default .9 + N11, \field Solar Absorptance + \note Solar absorptance of dry soil (1-albedo) is typically 0.60 to 0.85 + \note corresponding to a dry albedo of 0.15 to 0.40 + \type real + \minimum 0.4 + \maximum 0.9 + \default .70 + N12, \field Visible Absorptance + \type real + \minimum> 0.5 + \maximum 1 + \default .75 + N13, \field Saturation Volumetric Moisture Content of the Soil Layer + \note Maximum moisture content is typically less than 0.5 + \type real + \minimum> 0.1 + \maximum 0.5 + \default 0.3 + N14, \field Residual Volumetric Moisture Content of the Soil Layer + \type real + \minimum 0.01 + \maximum 0.1 + \default 0.01 + N15, \field Initial Volumetric Moisture Content of the Soil Layer + \type real + \minimum> 0.05 + \maximum 0.5 + \default 0.1 + A5; \field Moisture Diffusion Calculation Method + \note Advanced calculation requires increased number of timesteps (recommended >20). + \type choice + \default Advanced + \key Simple + \key Advanced + +OS:WindowMaterial:Blind, + \memo Window blind thermal properties + \min-fields 30 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference MaterialNames + \reference WindowShadesScreensAndBlinds + A3, \field Slat Orientation + \type choice + \default Horizontal + \key Horizontal + \key Vertical + N1, \field Slat Width + \type real + \default 0.025 + \units m + \ip-units in + \minimum> 0 + \maximum 1 + N2, \field Slat Separation + \note Distance between adjacent slat faces + \type real + \default 0.01875 + \units m + \ip-units in + \minimum> 0 + \maximum 1 + N3, \field Slat Thickness + \note Distance between top and bottom surfaces of slat + \note Slat is assumed to be rectangular in cross section and flat + \type real + \units m + \ip-units in + \minimum> 0 + \maximum 0.1 + \default 0.001 + N4, \field Slat Angle + \note If WindowProperty:ShadingControl for the window that incorporates this blind + \note has Type of Slat Angle Control for Blinds = FixedSlatAngle, + \note then this is the fixed value of the slat angle; + \note If WindowProperty:ShadingControl for the window that incorporates this blind + \note has Type of Slat Angle Control for Blinds = BlockBeamSolar, + \note then this is the slat angle when slat angle control + \note is not in effect (e.g., when there is no beam solar on the blind); + \note Not used if WindowProperty:ShadingControl for the window that incorporates this blind + \note has Type of Slat Angle Control for Blinds = ScheduledSlatAngle. + \type real + \units deg + \minimum 0 + \maximum 180 + \default 45 + N5, \field Slat Conductivity + \note default is for aluminum + \type real + \units W/m-K + \ip-units Btu-in/hr-ft2-R + \minimum> 0 + \default 221.0 + N6, \field Slat Beam Solar Transmittance + \type real + \minimum 0 + \maximum< 1 + \default 0.0 + N7, \field Front Side Slat Beam Solar Reflectance + \type real + \default 0.5 + \minimum 0 + \maximum< 1 + N8, \field Back Side Slat Beam Solar Reflectance + \type real + \default 0.5 + \minimum 0 + \maximum< 1 + N9, \field Slat Diffuse Solar Transmittance + \note Must equal "Slat beam solar transmittance" + \type real + \minimum 0 + \maximum< 1 + \default 0.0 + N10, \field Front Side Slat Diffuse Solar Reflectance + \note Must equal "Front Side Slat Beam Solar Reflectance" + \type real + \default 0.5 + \minimum 0 + \maximum< 1 + N11, \field Back Side Slat Diffuse Solar Reflectance + \note Must equal "Back Side Slat Beam Solar Reflectance" + \type real + \default 0.5 + \minimum 0 + \maximum< 1 + N12, \field Slat Beam Visible Transmittance + \note Required for detailed daylighting calculation + \type real + \default 0.0 + \minimum 0 + \maximum< 1 + N13, \field Front Side Slat Beam Visible Reflectance + \note Required for detailed daylighting calculation + \type real + \default 0.5 + \minimum 0 + \maximum< 1 + N14, \field Back Side Slat Beam Visible Reflectance + \note Required for detailed daylighting calculation + \type real + \default 0.5 + \minimum 0 + \maximum< 1 + N15, \field Slat Diffuse Visible Transmittance + \note Used only for detailed daylighting calculation + \note Must equal "Slat Beam Visible Transmittance" + \type real + \minimum 0 + \maximum< 1 + \default 0.0 + N16, \field Front Side Slat Diffuse Visible Reflectance + \note Required for detailed daylighting calculation + \note Must equal "Front Side Slat Beam Visible Reflectance" + \type real + \default 0.5 + \minimum 0 + \maximum< 1 + N17, \field Back Side Slat Diffuse Visible Reflectance + \note Required for detailed daylighting calculation + \note Must equal "Back Side Slat Beam Visible Reflectance" + \type real + \default 0.5 + \minimum 0 + \maximum< 1 + N18, \field Slat Infrared Hemispherical Transmittance + \type real + \minimum 0 + \maximum< 1 + \default 0.0 + N19, \field Front Side Slat Infrared Hemispherical Emissivity + \type real + \minimum 0 + \maximum< 1 + \default 0.9 + N20, \field Back Side Slat Infrared Hemispherical Emissivity + \type real + \minimum 0 + \maximum< 1 + \default 0.9 + N21, \field Blind to Glass Distance + \type real + \units m + \ip-units in + \minimum 0.01 + \maximum 1 + \default 0.050 + N22, \field Blind Top Opening Multiplier + \type real + \minimum 0 + \maximum 1 + \default 0.5 + N23, \field Blind Bottom Opening Multiplier + \type real + \minimum 0 + \maximum 1 + \default 0.5 + N24, \field Blind Left Side Opening Multiplier + \type real + \minimum 0 + \maximum 1 + \default 0.5 + N25, \field Blind Right Side Opening Multiplier + \type real + \minimum 0 + \maximum 1 + \default 0.5 + N26, \field Minimum Slat Angle + \note Used only if WindowProperty:ShadingControl for the window that incorporates + \note this blind varies the slat angle (i.e., WindowProperty:ShadingControl with + \note Type of Slat Angle Control for Blinds = ScheduledSlatAngle + \note or BlockBeamSolar) + \type real + \units deg + \minimum 0 + \maximum 180 + \default 0 + N27; \field Maximum Slat Angle + \note Used only if WindowProperty:ShadingControl for the window that incorporates + \note this blind varies the slat angle (i.e., WindowProperty:ShadingControl with + \note Type of Slat Angle Control for Blinds = ScheduledSlatAngle + \note or BlockBeamSolar) + \type real + \units deg + \minimum 0 + \maximum 180 + \default 180 + +OS:WindowMaterial:DaylightRedirectionDevice, + \memo This object is not in EnergyPlus, this represents a film or louver which redirects daylighting. + \min-fields 2 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference MaterialNames + \reference WindowShadesScreensAndBlinds + A3; \field Daylight Redirection Device Type + \type choice + \default Louver + \key Louver + \key Film + +OS:WindowMaterial:Gas, + \memo Gas material properties that are used in Windows or Glass Doors + \min-fields 4 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference MaterialNames + A3, \field Gas Type + \type choice + \required-field + \key Air + \key Argon + \key Krypton + \key Xenon + \key Custom + N1, \field Thickness + \type real + \required-field + \units m + \ip-units in + \minimum> 0 + N2, \field Conductivity Coefficient A + \note Used only if Gas Type = Custom + \type real + \units W/m-K + \ip-units Btu-in/hr-ft2-R + N3, \field Conductivity Coefficient B + \note Used only if Gas Type = Custom + \type real + \units W/m-K2 + \ip-units Btu-in/hr-ft2-R2 + N4, \field Conductivity Coefficient C + \note Used only if Gas Type = Custom + \type real + \units W/m-K3 + \ip-units Btu-in/hr-ft2-R3 + N5, \field Viscosity Coefficient A + \note Used only if Gas Type = Custom + \type real + \units g/m-s + \minimum> 0 + N6, \field Viscosity Coefficient B + \note Used only if Gas Type = Custom + \type real + \units g/m-s-K + N7, \field Viscosity Coefficient C + \note Used only if Gas Type = Custom + \type real + \units g/m-s-K2 + N8, \field Specific Heat Coefficient A + \note Used only if Gas Type = Custom + \type real + \units J/kg-K + \ip-units Btu/lb-R + \minimum> 0 + N9, \field Specific Heat Coefficient B + \note Used only if Gas Type = Custom + \type real + \units J/kg-K2 + \ip-units Btu/lb-R2 + N10, \field Specific Heat Coefficient C + \note Used only if Gas Type = Custom + \type real + \units J/kg-K3 + \ip-units Btu/lb-R3 + N11, \field Molecular Weight + \note Used only if Gas Type = Custom + \type real + \minimum 20 + \maximum 200 + N12; \field Specific Heat Ratio + \type real + \note Used only if Gas Type = Custom + \minimum >1.0 + +OS:WindowMaterial:GasMixture, + \memo Gas mixtures that are used in Windows or Glass Doors + \min-fields 8 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference MaterialNames + N1, \field Thickness + \type real + \required-field + \units m + \minimum> 0 + N2, \field Number of Gases in Mixture + \type integer + \required-field + \minimum 1 + \maximum 4 + A3, \field Gas 1 Type + \type choice + \required-field + \key Air + \key Argon + \key Krypton + \key Xenon + N3, \field Gas 1 Fraction + \type real + \required-field + \minimum> 0 + \maximum 1 + A4, \field Gas 2 Type + \type choice + \required-field + \key Air + \key Argon + \key Krypton + \key Xenon + N4, \field Gas 2 Fraction + \type real + \required-field + \minimum> 0 + \maximum 1 + A5, \field Gas 3 Type + \type choice + \key Air + \key Argon + \key Krypton + \key Xenon + N5, \field Gas 3 Fraction + \type real + \minimum> 0 + \maximum 1 + A6, \field Gas 4 Type + \type choice + \key Air + \key Argon + \key Krypton + \key Xenon + N6; \field Gas 4 Fraction + \type real + \minimum> 0 + \maximum 1 + +OS:WindowMaterial:Glazing, + \memo Glass material properties for Windows or Glass Doors + \memo Transmittance/Reflectance input method. + \min-fields 15 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference MaterialNames + \reference GlazingMaterialNames + A3, \field Optical Data Type + \type choice + \required-field + \key SpectralAverage + \key Spectral + A4, \field Window Glass Spectral Data Set Name + \note Used only when Optical Data Type = Spectral + \type object-list + \object-list SpectralDataSets + N1, \field Thickness + \type real + \required-field + \units m + \ip-units in + \minimum> 0 + N2, \field Solar Transmittance at Normal Incidence + \note Used only when Optical Data Type = SpectralAverage + \type real + \minimum 0 + \maximum 1 + N3, \field Front Side Solar Reflectance at Normal Incidence + \note Used only when Optical Data Type = SpectralAverage + \note Front Side is side closest to outdoor air + \type real + \minimum 0 + \maximum 1 + N4, \field Back Side Solar Reflectance at Normal Incidence + \note Used only when Optical Data Type = SpectralAverage + \note Back Side is side closest to zone air + \type real + \minimum 0 + \maximum 1 + N5, \field Visible Transmittance at Normal Incidence + \note Used only when Optical Data Type = SpectralAverage + \type real + \minimum 0 + \maximum 1 + N6, \field Front Side Visible Reflectance at Normal Incidence + \note Used only when Optical Data Type = SpectralAverage + \type real + \minimum 0 + \maximum 1 + N7, \field Back Side Visible Reflectance at Normal Incidence + \note Used only when Optical Data Type = SpectralAverage + \type real + \minimum 0 + \maximum 1 + N8, \field Infrared Transmittance at Normal Incidence + \type real + \minimum 0 + \maximum 1 + \default 0.0 + N9, \field Front Side Infrared Hemispherical Emissivity + \type real + \minimum> 0 + \maximum< 1 + \default 0.84 + N10, \field Back Side Infrared Hemispherical Emissivity + \type real + \minimum> 0 + \maximum< 1 + \default 0.84 + N11, \field Conductivity + \type real + \units W/m-K + \ip-units Btu-in/hr-ft2-R + \minimum> 0 + \default 0.9 + N12, \field Dirt Correction Factor for Solar and Visible Transmittance + \type real + \minimum> 0 + \maximum 1 + \default 1.0 + A5; \field Solar Diffusing + \type choice + \default No + \key No + \key Yes + +OS:WindowMaterial:GlazingGroup:Thermochromic, + \memo thermochromic glass at different temperatures + \extensible:2 + \min-fields 4 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference MaterialNames + \reference GlazingMaterialNames + N1, \field Optical Data Temperature + \type real + \required-field + \begin-extensible + \units C + \ip-units F + A3; \field Window Material Glazing Name + \type object-list + \required-field + \object-list GlazingMaterialNames + +OS:WindowMaterial:Glazing:RefractionExtinctionMethod, + \memo Glass material properties for Windows or Glass Doors + \memo Index of Refraction/Extinction Coefficient input method + \memo Not to be used for coated glass + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference MaterialNames + \reference GlazingMaterialNames + N1, \field Thickness + \type real + \required-field + \units m + \ip-units in + \minimum> 0 + N2, \field Solar Index of Refraction + \type real + \required-field + \minimum> 1 + N3, \field Solar Extinction Coefficient + \type real + \required-field + \units 1/m + \minimum> 0 + N4, \field Visible Index of Refraction + \type real + \required-field + \minimum> 1 + N5, \field Visible Extinction Coefficient + \type real + \required-field + \units 1/m + \minimum> 0 + N6, \field Infrared Transmittance at Normal Incidence + \type real + \minimum 0 + \maximum< 1 + \default 0.0 + N7, \field Infrared Hemispherical Emissivity + \note Emissivity of front and back side assumed equal + \type real + \minimum> 0 + \maximum< 1 + \default 0.84 + N8, \field Conductivity + \type real + \units W/m-K + \ip-units Btu-in/hr-ft2-R + \minimum> 0 + \default 0.9 + N9, \field Dirt Correction Factor for Solar and Visible Transmittance + \type real + \minimum> 0 + \maximum 1 + \default 1.0 + A3; \field Solar Diffusing + \type choice + \default No + \key No + \key Yes + +OS:WindowMaterial:Screen, + \memo Window screen physical properties. Can only be located on the exterior side of a window construction. + \min-fields 10 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \note Enter a unique name for this window screen material. + \type alpha + \required-field + \reference MaterialNames + \reference WindowShadesScreensAndBlinds + A3, \field Reflected Beam Transmittance Accounting Method + \note Select the method used to account for the beam solar reflected off the material surface. + \type choice + \default ModelAsDiffuse + \key DoNotModel + \key ModelAsDirectBeam + \key ModelAsDiffuse + N1, \field Diffuse Solar Reflectance + \note Diffuse reflectance of the screen material over the entire solar radiation spectrum. + \note Assumed to be the same for both sides of the screen. + \type real + \default 0.08 + \units dimensionless + \minimum 0 + \maximum< 1 + N2, \field Diffuse Visible Reflectance + \note Diffuse visible reflectance of the screen material averaged over the solar spectrum + \note and weighted by the response of the human eye. + \note Assumed to be the same for both sides of the screen. + \type real + \default 0.08 + \units dimensionless + \minimum 0 + \maximum< 1 + N3, \field Thermal Hemispherical Emissivity + \note Long-wave emissivity of the screen material. + \note Assumed to be the same for both sides of the screen. + \type real + \units dimensionless + \minimum> 0 + \maximum< 1 + \default 0.9 + N4, \field Conductivity + \note Thermal conductivity of the screen material. + \note Default is for aluminum. + \type real + \units W/m-K + \ip-units Btu-in/hr-ft2-R + \minimum> 0 + \default 221.0 + N5, \field Screen Material Spacing + \note Spacing assumed to be the same in both directions. + \type real + \default 0.00157 + \units m + \ip-units in + \minimum> 0 + N6, \field Screen Material Diameter + \note Diameter assumed to be the same in both directions. + \type real + \default 0.000381 + \units m + \ip-units in + \minimum> 0 + N7, \field Screen to Glass Distance + \note Distance from the window screen to the adjacent glass surface. + \type real + \units m + \ip-units in + \minimum 0.001 + \maximum 1 + \default 0.025 + N8, \field Top Opening Multiplier + \note Effective area for air flow at the top of the screen divided by the perpendicular + \note area between the glass and the top of the screen. + \type real + \units dimensionless + \minimum 0 + \maximum 1 + \default 0.0 + N9, \field Bottom Opening Multiplier + \note Effective area for air flow at the bottom of the screen divided by the perpendicular + \note area between the glass and the bottom of the screen. + \type real + \units dimensionless + \minimum 0 + \maximum 1 + \default 0.0 + N10, \field Left Side Opening Multiplier + \note Effective area for air flow at the left side of the screen divided by the perpendicular + \note area between the glass and the left side of the screen. + \type real + \units dimensionless + \minimum 0 + \maximum 1 + \default 0.0 + N11, \field Right Side Opening Multiplier + \note Effective area for air flow at the right side of the screen divided by the perpendicular + \note area between the glass and the right side of the screen. + \type real + \units dimensionless + \minimum 0 + \maximum 1 + \default 0.0 + N12; \field Angle of Resolution for Screen Transmittance Output Map + \note Select the resolution of azimuth and altitude angles for the screen transmittance map. + \note A value of 0 means no transmittance map will be generated. + \note Valid values for this field are 0, 1, 2, 3 and 5. + \type choice + \units deg + \default 0 + \key 0 + \key 1 + \key 2 + \key 3 + \key 5 + +OS:WindowMaterial:Shade, + \memo Window shade thermal properties + \min-fields 16 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference MaterialNames + \reference WindowShadesScreensAndBlinds + N1, \field Solar Transmittance + \note Assumed independent of incidence angle + \type real + \default 0.4 + \units dimensionless + \minimum 0 + \maximum< 1 + N2, \field Solar Reflectance + \note Assumed same for both sides + \note Assumed independent of incidence angle + \type real + \default 0.5 + \units dimensionless + \minimum 0 + \maximum< 1 + N3, \field Visible Transmittance + \note Assumed independent of incidence angle + \type real + \default 0.4 + \units dimensionless + \minimum 0 + \maximum< 1 + N4, \field Visible Reflectance + \note Assumed same for both sides + \note Assumed independent of incidence angle + \type real + \default 0.5 + \units dimensionless + \minimum 0 + \maximum< 1 + N5, \field Thermal Hemispherical Emissivity + \type real + \default 0.9 + \units dimensionless + \minimum> 0 + \maximum< 1 + N6, \field Thermal Transmittance + \type real + \default 0.0 + \units dimensionless + \minimum 0 + \maximum< 1 + N7, \field Thickness + \type real + \default 0.005 + \units m + \ip-units in + \minimum> 0 + N8, \field Conductivity + \type real + \default 0.1 + \units W/m-K + \ip-units Btu-in/hr-ft2-R + \minimum> 0 + N9, \field Shade to Glass Distance + \type real + \units m + \ip-units in + \minimum 0.001 + \maximum 1 + \default 0.050 + N10, \field Top Opening Multiplier + \type real + \minimum 0 + \maximum 1 + \default 0.0 + N11, \field Bottom Opening Multiplier + \type real + \minimum 0 + \maximum 1 + \default 0.0 + N12, \field Left-Side Opening Multiplier + \type real + \minimum 0 + \maximum 1 + \default 0.0 + N13, \field Right-Side Opening Multiplier + \type real + \minimum 0 + \maximum 1 + \default 0.0 + N14; \field Airflow Permeability + \type real + \units dimensionless + \minimum 0 + \maximum 0.8 + \default 0.0 + +OS:WindowMaterial:SimpleGlazingSystem, + \memo Alternate method of describing windows + \memo This window material object is used to define an entire glazing system + \memo using simple performance parameters. + \min-fields 4 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference MaterialNames + \reference GlazingMaterialNames + N1, \field U-Factor + \note Enter U-Factor including film coefficients + \type real + \required-field + \units W/m2-K + \minimum> 0 + N2, \field Solar Heat Gain Coefficient + \note SHGC at Normal Incidence + \type real + \required-field + \minimum> 0 + \maximum< 1 + N3; \field Visible Transmittance + \note VT at Normal Incidence + \note optional + \type real + \minimum> 0 + \maximum< 1 + +OS:StandardsInformation:Material, + \min-fields 2 + A1, \field Handle + \type handle + \required-field + A2, \field Material Name + \type object-list + \required-field + \object-list MaterialNames + A3, \field Material Standard + \note This is a freeform field used to identify the standard which specifies this material. + \note More information can be found at https://github.com/NREL/openstudio-standards. + \type alpha + A4, \field Material Standard Source + \note This is a freeform field used to identify the table or section in the standard which specifies this material. + \note More information can be found at https://github.com/NREL/openstudio-standards. + \type alpha + A5, \field Standards Category + \note This is a freeform field used to identify the category of this material, e.g. 'Plastering Materials' 'Composite', or 'Roofing'. + \note More information can be found at https://github.com/NREL/openstudio-standards. + \type alpha + A6, \field Standards Identifier + \note This is a freeform field used to identify the id of this material within a standard. + \note More information can be found at https://github.com/NREL/openstudio-standards. + \type alpha + A7, \field Composite Framing Material + \note This is a freeform field used to identify the framing material for a composite layer. + \note More information can be found at https://github.com/NREL/openstudio-standards. + \type alpha + A8, \field Composite Framing Configuration + \note This is a freeform field used to identify the framing configuration for a composite layer. + \note More information can be found at https://github.com/NREL/openstudio-standards. + \type alpha + A9, \field Composite Framing Depth + \note This is a freeform field used to identify the framing depth for a composite layer. + \note More information can be found at https://github.com/NREL/openstudio-standards. + \type alpha + A10, \field Composite Framing Size + \note This is a freeform field used to identify the framing size for a composite layer. + \note More information can be found at https://github.com/NREL/openstudio-standards. + \type alpha + A11; \field Composite Cavity Insulation + \note This is a freeform field used to identify the cavity insulation for a composite layer. + \note More information can be found at https://github.com/NREL/openstudio-standards. + \type alpha + +OS:MaterialProperty:GlazingSpectralData, + \memo Name is followed by up to 800 sets of normal-incidence measured values of + \memo [wavelength, transmittance, front reflectance, back reflectance] for wavelengths + \memo covering the solar spectrum (from about 0.25 to 2.5 microns) + \format Spectral + \extensible:4 + \min-fields 1 + \max-fields 3201 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \required-field + \reference SpectralDataSets + N1, \field Wavelength + \begin-extensible + \type real + \units micron + N2, \field Transmittance + N3, \field Front Reflectance + N4; \field Back Reflectance + +OS:MaterialProperty:MoisturePenetrationDepth:Settings, + \memo Additional properties for moisture using EMPD procedure + \memo HeatBalanceAlgorithm choice=MoisturePenetrationDepthConductionTransferFunction only + \memo Has no effect with other HeatBalanceAlgorithm solution algorithms + \min-fields 11 + A1, \field Handle + \type handle + \required-field + A2, \field Material Name + \required-field + \type object-list + \object-list MaterialWithPropertyNames + \note Material Name that the moisture properties will be added to. + \note Additional material properties required to perform the EMPD model. + \note Effective Mean Penetration Depth (EMPD) + N1, \field Water Vapor Diffusion Resistance Factor + \required-field + \units dimensionless + \minimum 0.0 + \type real + \note Ratio of water vapor permeability of stagnant air to water vapor + \note permeability of material + N2, \field Moisture Equation Coefficient a + \required-field + \units dimensionless + \type real + N3, \field Moisture Equation Coefficient b + \required-field + \units dimensionless + \type real + N4, \field Moisture Equation Coefficient c + \required-field + \units dimensionless + \type real + N5, \field Moisture Equation Coefficient d + \required-field + \units dimensionless + \type real + N6, \field Surface Layer Penetration Depth + \units m + \ip-units in + \type real + \minimum> 0 + \autocalculatable + \default autocalculate + N7, \field Deep Layer Penetration Depth + \units m + \ip-units in + \type real + \minimum 0 + \autocalculatable + \default autocalculate + N8, \field Coating Layer Thickness + \required-field + \type real + \units m + \ip-units in + \minimum 0 + N9; \field Coating Layer Water Vapor Diffusion Resistance Factor + \required-field + \type real + \units dimensionless + \minimum 0 + \note The coating's resistance to water vapor diffusion relative to the + \note resistance to water vapor diffusion in stagnant air + \note (see Water Vapor Diffusion Resistance Factor above). + +OS:MaterialProperty:PhaseChange, + \memo Additional properties for temperature dependent thermal conductivity + \memo and enthalpy for Phase Change Materials (PCM) + \memo HeatBalanceAlgorithm = CondFD(ConductionFiniteDifference) solution algorithm only. + \memo Constructions with this should use the detailed CondFD process. + \memo Has no effect with other HeatBalanceAlgorithm solution algorithms + \extensible:2 + \max-fields 35 + A1, \field Handle + \type handle + \required-field + A2, \field Material Name + \required-field + \type object-list + \object-list MaterialWithPropertyNames + \note Regular Material Name to which the additional properties will be added. + \note this the material name for the basic material properties. + N1, \field Temperature Coefficient for Thermal Conductivity + \note The base temperature is 20C. + \note This is the thermal conductivity change per degree excursion from 20C. + \note This variable conductivity function is overridden by the VariableThermalConductivity object, if present. + \units W/m-K2 + \type real + \default 0.0 + N2, \field Temperature + \required-field + \note for Temperature-enthalpy function + \units C + \type real + \begin-extensible + N3; \field Enthalpy + \required-field + \note for Temperature-enthalpy function corresponding to temperature 1 + \units J/kg + +OS:MaterialProperty:PhaseChangeHysteresis, + \memo Additional properties for temperature dependent thermal conductivity + \memo and enthalpy for Phase Change Materials (PCM) with separate melting and freezing curves. + \memo HeatBalanceAlgorithm = CondFD (ConductionFiniteDifference) solution algorithm only. + \memo Constructions with this should use the detailed CondFD process. + \memo Has no effect with other HeatBalanceAlgorithm solution algorithms. + A1, \field Handle + \type handle + \required-field + A2, \field Material Name + \required-field + \type object-list + \object-list MaterialWithPropertyNames + \note Regular Material Name to which the additional properties will be added. + \note this the material name for the basic material properties. + N1, \field Latent Heat during the Entire Phase Change Process + \note The total latent heat absorbed or rejected during the transition from solid to liquid, or back + \required-field + \units J/kg + \type real + \minimum> 0 + N2, \field Liquid State Thermal Conductivity + \note The thermal conductivity used by this material when the material is fully liquid + \required-field + \units W/m-K + \type real + \minimum> 0 + N3, \field Liquid State Density + \note The density used by this material when the material is fully liquid + \required-field + \units kg/m3 + \type real + \minimum> 0 + N4, \field Liquid State Specific Heat + \note The constant specific heat used for the fully melted (liquid) state + \required-field + \units J/kg-K + \type real + \minimum> 0 + N5, \field High Temperature Difference of Melting Curve + \note The total melting range of the material is the sum of low and high temperature difference of melting curve. + \required-field + \units deltaC + \type real + \minimum> 0 + N6, \field Peak Melting Temperature + \note The temperature at which the melting curve peaks + \required-field + \units C + \type real + \minimum> 0 + N7, \field Low Temperature Difference of Melting Curve + \note The total melting range of the material is the sum of low and high temperature difference of melting curve. + \required-field + \units deltaC + \type real + \minimum> 0 + N8, \field Solid State Thermal Conductivity + \note The thermal conductivity used by this material when the material is fully solid + \required-field + \units W/m-K + \type real + \minimum> 0 + N9, \field Solid State Density + \note The density used by this material when the material is fully solid + \required-field + \units kg/m3 + \type real + \minimum> 0 + N10, \field Solid State Specific Heat + \note The constant specific heat used for the fully frozen (crystallized) state + \required-field + \units J/kg-K + \type real + \minimum> 0 + N11, \field High Temperature Difference of Freezing Curve + \note The total freezing range of the material is the sum of low and high temperature difference of freezing curve. + \required-field + \units deltaC + \type real + \minimum> 0 + N12, \field Peak Freezing Temperature + \note The temperature at which the freezing curve peaks + \required-field + \units C + \type real + \minimum> 0 + N13; \field Low Temperature Difference of Freezing Curve + \note The total freezing range of the material is the sum of low and high temperature difference of freezing curve. + \required-field + \units deltaC + \type real + \minimum> 0 + +\group OpenStudio Constructions + +OS:Construction, + \memo Start with outside layer and work your way to the inside layer + \memo Up to 10 layers total, 8 for windows + \memo Enter the material name for each layer + \extensible:1 + \min-fields 4 + \max-fields 13 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference ConstructionNames + A3, \field Surface Rendering Name + \type object-list + \object-list SurfaceRenderingNames + A4; \field Layer + \type object-list + \required-field + \begin-extensible + \object-list MaterialNames + +OS:Construction:CfactorUndergroundWall, + \memo Alternate method of describing underground wall constructions + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference ConstructionNames + N1, \field C-Factor + \note Enter C-Factor without film coefficients or soil + \type real + \required-field + \units W/m2-K + \minimum> 0 + N2, \field Height + \note Enter height of the underground wall + \type real + \required-field + \units m + \minimum> 0 + A3; \field Surface Rendering Name + \type object-list + \object-list SurfaceRenderingNames + +OS:Construction:FfactorGroundFloor, + \memo Alternate method of describing slab-on-grade or underground floor constructions + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference ConstructionNames + N1, \field F-Factor + \type real + \required-field + \units W/m-K + \ip-units Btu/h-ft-F + \minimum> 0 + N2, \field Area + \note Enter area of the floor + \type real + \required-field + \units m2 + \minimum> 0 + N3, \field PerimeterExposed + \note Enter exposed perimeter of the floor + \type real + \required-field + \units m + \minimum 0 + A3; \field Surface Rendering Name + \type object-list + \object-list SurfaceRenderingNames + +OS:Construction:InternalSource, + \memo Start with outside layer and work your way to the inside Layer + \memo Up to 10 layers total + \memo Enter the material name for each layer + \extensible:1 + \min-fields 9 + \max-fields 18 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference ConstructionNames + N1, \field Source Present After Layer Number + \note refers to the list of materials which follows + \type integer + \default 1 + \minimum 1 + \maximum 10 + N2, \field Temperature Calculation Requested After Layer Number + \note refers to the list of materials which follows + \type integer + \default 1 + \minimum 1 + \maximum 10 + N3, \field Dimensions for the CTF Calculation + \note 1 = 1-dimensional calculation, 2 = 2-dimensional calculation + \type integer + \default 1 + \minimum 1 + \maximum 2 + N4, \field Tube Spacing + \note uniform spacing between tubes or resistance wires in direction + \note perpendicular to main intended direction of heat transfer + \type real + \default 0.154 + \units m + \minimum 0.01 + \maximum 1.0 + N5 , \field Two-Dimensional Temperature Calculation Position + \minimum 0.0 + \maximum 1.0 + \default 0.0 + \units dimensionless + \note used in conjunction with field Temperature Calculation Requested After Layer Number + \note this field is the location perpendicular to the main direction of heat transfer + \note 0.0 means in line with the tubing, 1.0 means at the midpoint between two adjacent pipes + \note this field is ignored for 1-D calculations + A3, \field Surface Rendering Name + \type object-list + \object-list SurfaceRenderingNames + A4; \field Layer + \type object-list + \required-field + \begin-extensible + \object-list MaterialNames + +OS:Construction:AirBoundary, + \memo Indicates an open boundary between two zones. It may be used for base surfaces and fenestration surfaces. + \memo When this construction type is used, the Outside Boundary Condition of the surface + \memo (or the base surface of a fenestration surface) must be either Surface or Zone. + \memo A base surface with OS:Construction:AirBoundary cannot hold any fenestration surfaces. + A1, \field Handle + \type handle + \required-field + A2, \field Name + \required-field + \type alpha + \reference ConstructionNames + A3, \field Air Exchange Method + \note This field controls how air exchange is modeled across this boundary. + \type choice + \key None + \key SimpleMixing + \default None + N1, \field Simple Mixing Air Changes per Hour + \note If the Air Exchange Method is SimpleMixing then this field specifies the air changes per hour + \note using the volume of the smaller zone as the basis. + \note If an AirflowNetwork simulation is active this field is ignored. + \units 1/hr + \type real + \minimum 0 + \default 0.5 + A4, \field Simple Mixing Schedule Name + \note If the Air Exchange Method is SimpleMixing then this field specifies the air exchange schedule. + \note If this field is blank, the schedule is always 1.0. + \note If an AirflowNetwork simulation is active this field is ignored. + \type object-list + \object-list ScheduleNames + A5; \field Surface Rendering Name + \type object-list + \object-list SurfaceRenderingNames + +OS:Construction:WindowDataFile, + \memo Initiates search of the Window5 data file for a window called Name. + \url-object + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference ConstructionNames + A3, \field Url + \retaincase + \retaincase + \type url + A4; \field Surface Rendering Name + \type object-list + \object-list SurfaceRenderingNames + +OS:StandardsInformation:Construction, + \min-fields 2 + A1, \field Handle + \type handle + \required-field + A2, \field Construction Name + \type object-list + \required-field + \object-list ConstructionNames + A3, \field Intended Surface Type + \type choice + \key AtticFloor + \key AtticWall + \key AtticRoof + \key DemisingFloor + \key DemisingWall + \key DemisingRoof + \key ExteriorFloor + \key ExteriorWall + \key ExteriorRoof + \key ExteriorWindow + \key ExteriorDoor + \key GlassDoor + \key GroundContactFloor + \key GroundContactWall + \key GroundContactRoof + \key InteriorFloor + \key InteriorWall + \key InteriorCeiling + \key InteriorPartition + \key InteriorWindow + \key InteriorDoor + \key OverheadDoor + \key Skylight + \key TubularDaylightDome + \key TubularDaylightDiffuser + A4, \field Standards Construction Type + \note This is a freeform field used to identify the construction type for standards. + \note Standards applied to this model will use this field to determine correct constructions. + \note More information can be found at https://github.com/NREL/openstudio-standards. + \type alpha + N1, \field Perturbable Layer + \note If the construction is layered, this is the index (starting at 0) + \note of the layer whose thickness can be adjusted to meet a u-factor + \note requirement. + \type integer + A5, \field Perturbable Layer Type + \type choice + \default Not Applicable + \key Not Applicable + \key Insulation + \key Other + A6, \field Other Perturbable Layer Type + \type alpha + A7, \field Construction Standard + \note This is a freeform field used to identify the standard which specifies this construction. + \type alpha + A8, \field Construction Standard Source + \note This is a freeform field used to identify the table or section of the standard which specifies this construction. + \type alpha + A9, \field Fenestration Type + \note Specific type of fenestration that this construction represents. + \type choice + \key Fixed Window + \key Operable Window + \key Curtain Wall + \key Glazed Door + \key Glass Skylight with Curb + \key Plastic Skylight with Curb + \key Glass Skylight without Curb + \key Plastic Skylight without Curb + \key Swinging Door + \key Non-Swinging Door + A10,\field Fenestration Assembly Context + \note Where is this fenestration assembled. + \type choice + \key Manufactured + \key Field Fabricated + \key Site Built + A11,\field Fenestration Number of Panes + \note Number of panes for this fenestration construction. + \note BCL taxonomy term 'Construction Assembly.Fenestration.Window.Number of Panes' + \type choice + \key Single Pane + \key Double Pane + \key Triple Pane + \key Quadruple Pane + \key Glass Block + A12,\field Fenestration Frame Type + \note Type of framing for this fenestration construction. + \type choice + \key Metal Framing + \key Metal Framing with Thermal Break + \key Non-Metal Framing + A13,\field Fenestration Divider Type + \note Type of divider for this fenestration construction. + \type choice + \key True Divided Lite + \key Between Panes < 7/16" + \key Between Panes >= 7/16" + A14,\field Fenestration Tint + \note Tint of this fenestration construction. + \note BCL taxonomy term 'Construction Assembly.Fenestration.Window.Tint' + \type choice + \key Clear + \key Bronze + \key Grey + \key Green + \key Blue + \key Tinted + A15,\field Fenestration Gas Fill + \note Type of gas used between panes of this fenestration construction. + \note BCL taxonomy term 'Construction Assembly.Fenestration.Window.Gas Fill' + \type choice + \key Air + \key Argon + \key Krypton + A16;\field Fenestration Low Emissivity Coating + \note Does this fenestration construction include a low-e coating. + \type choice + \key True + \key False + +\group OpenStudio Space Load Definitions + +OS:InternalMass:Definition, + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference InternalMassDefinitionNames + \reference SpaceComponentDefinitionNames + A3, \field Construction Name + \note Leave blank to match with default construction + \type object-list + \object-list ConstructionNames + A4, \field Design Level Calculation Method + \note Choices: SurfaceArea => Surface Area -- simply enter surface area + \note SurfaceArea/Area => Surface Area per Space Floor Area -- enter the number to apply. Value * Floor Area = Surface Area + \note SurfaceArea/Person => Surface Area per Person -- enter the number to apply. Value * Occupants = Surface Area + \type choice + \required-field + \key SurfaceArea + \key SurfaceArea/Area + \key SurfaceArea/Person + N1, \field Surface Area + \type real + \units m2 + \ip-units ft2 + \minimum 0 + N2, \field Surface Area per Space Floor Area + \type real + \units dimensionless + \ip-units dimensionless + \minimum 0 + N3; \field Surface Area per Person + \type real + \units m2/person + \ip-units ft2/person + \minimum 0 + +OS:People:Definition, + \extensible:1 + \min-fields 1 + \max-fields 16 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference PeopleDefinitionNames + \reference SpaceComponentDefinitionNames + A3, \field Number of People Calculation Method + \note The entered calculation method is used to create the maximum number of people + \note for this set of attributes (i.e. sensible fraction, schedule, etc) + \note Choices: People -- simply enter number of occupants. + \note People per Space Floor Area -- enter the number to apply. Value * Floor Area = Number of people + \note Space Floor Area per Person -- enter the number to apply. Floor Area / Value = Number of people + \type choice + \required-field + \key People + \key People/Area + \key Area/Person + N1, \field Number of People + \type real + \units people + \minimum 0 + N2, \field People per Space Floor Area + \type real + \units person/m2 + \minimum 0 + N3, \field Space Floor Area per Person + \type real + \units m2/person + \minimum 0 + N4, \field Fraction Radiant + \type real + \required-field + \minimum 0 + \maximum 1 + N5, \field Sensible Heat Fraction + \note if input, overrides program calculated sensible/latent split + \type real + \autocalculatable + \minimum 0 + \maximum 1 + \default autocalculate + N6, \field Carbon Dioxide Generation Rate + \note CO2 generation rate per unit of activity level. + \note The default value is obtained from ASHRAE Std 62.1 at 0.0084 cfm/met/person over + \note the general adult population. + \type real + \units m3/s-W + \minimum 0 + \maximum 3.82e-07 + \default 3.82E-8 + A4, \field Enable ASHRAE 55 Comfort Warnings + \type choice + \default No + \key Yes + \key No + A5, \field Mean Radiant Temperature Calculation Type + \note optional (only required for thermal comfort runs) + \type choice + \default EnclosureAveraged + \key EnclosureAveraged + \key SurfaceWeighted + \key AngleFactor + A6; \field Thermal Comfort Model Type + \note optional (only needed for people thermal comfort results reporting) + \type choice + \begin-extensible + \key Fanger + \key Pierce + \key KSU + \key AdaptiveASH55 + \key AdaptiveCEN15251 + \key CoolingEffectASH55 + \key AnkleDraftASH55 + +OS:Lights:Definition, + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference LightsDefinitionNames + \reference SpaceComponentDefinitionNames + A3, \field Design Level Calculation Method + \note The entered calculation method is used to create the maximum amount of lights + \note for this set of attributes + \note Choices: LightingLevel => Lighting Level -- simply enter watts of lights + \note Watts/Area => Watts per Space Floor Area -- enter the number to apply. Value * Floor Area = Lights + \note Watts/Person => Watts per Person -- enter the number to apply. Value * Occupants = Lights + \type choice + \required-field + \key LightingLevel + \key Watts/Area + \key Watts/Person + N1, \field Lighting Level + \type real + \units W + \ip-units W + \minimum 0 + N2, \field Watts per Space Floor Area + \type real + \units W/m2 + \ip-units W/ft2 + \minimum 0 + N3, \field Watts per Person + \type real + \units W/person + \ip-units W/person + \minimum 0 + N4, \field Fraction Radiant + \type real + \minimum 0 + \maximum 1 + \default 0.0 + N5, \field Fraction Visible + \type real + \minimum 0 + \maximum 1 + \default 0.0 + N6, \field Return Air Fraction + \note Used only for sizing calculation if return-air-fraction + \note coefficients are specified. + \type real + \minimum 0 + \maximum 1 + \default 0.0 + A4, \field Return Air Fraction Calculated from Plenum Temperature + \type choice + \default No + \key Yes + \key No + N7, \field Return Air Fraction Function of Plenum Temperature Coefficient 1 + \note Used only if Return Air Fraction Is Calculated from Plenum Temperature = Yes + \note Equation is Return Air Fraction = Coefficient#1 - Coefficient#2 X PlenumTemp(degC) + \type real + \minimum 0 + \default 0.0 + N8; \field Return Air Fraction Function of Plenum Temperature Coefficient 2 + \note Used only if Return Air Fraction Is Calculated from Plenum Temperature = Yes + \note Equation is Return Air Fraction = Coefficient#1 - Coefficient#2 X PlenumTemp(degC) + \type real + \units 1/K + \minimum 0 + \default 0.0 + +OS:Luminaire:Definition, + \url-object + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference LuminaireDefinitionNames + \reference SpaceComponentDefinitionNames + A3, \field IES File Path + \retaincase + \retaincase + \type url + N1, \field Lighting Power + \type real + \units W + \ip-units W + \minimum 0 + \default 0 + N2, \field Fraction Radiant + \type real + \minimum 0 + \maximum 1 + \default 0 + N3, \field Fraction Visible + \type real + \minimum 0 + \maximum 1 + \default 0 + N4, \field Return Air Fraction + \note Used only for sizing calculation if return-air-fraction + \note coefficients are specified. + \type real + \minimum 0 + \maximum 1 + \default 0 + A4, \field Return Air Fraction Calculated from Plenum Temperature + \type choice + \default No + \key Yes + \key No + N5, \field Return Air Fraction Function of Plenum Temperature Coefficient 1 + \note Used only if Return Air Fraction Is Calculated from Plenum Temperature = Yes + \note Equation is Return Air Fraction = Coefficient#1 - Coefficient#2 X PlenumTemp(degC) + \type real + \minimum 0 + \default 0.0 + N6; \field Return Air Fraction Function of Plenum Temperature Coefficient 2 + \note Used only if Return Air Fraction Is Calculated from Plenum Temperature = Yes + \note Equation is Return Air Fraction = Coefficient#1 - Coefficient#2 X PlenumTemp(degC) + \type real + \units 1/K + \minimum 0 + \default 0.0 + +OS:ElectricEquipment:Definition, + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference ElectricEquipmentDefinitionNames + \reference SpaceComponentDefinitionNames + A3, \field Design Level Calculation Method + \note The entered calculation method is used to create the maximum amount of electric equipment + \note for this set of attributes + \note Choices: EquipmentLevel => Equipment Level -- simply enter watts of equipment + \note Watts/Area => Watts per Space Floor Area -- enter the number to apply. Value * Floor Area = Equipment Level + \note Watts/Person => Watts per Person -- enter the number to apply. Value * Occupants = Equipment Level + \type choice + \required-field + \key EquipmentLevel + \key Watts/Area + \key Watts/Person + N1, \field Design Level + \type real + \units W + \ip-units W + \minimum 0 + N2, \field Watts per Space Floor Area + \type real + \units W/m2 + \ip-units W/ft2 + \minimum 0 + N3, \field Watts per Person + \type real + \units W/person + \ip-units W/person + \minimum 0 + N4, \field Fraction Latent + \type real + \minimum 0 + \maximum 1 + \default 0.0 + N5, \field Fraction Radiant + \type real + \minimum 0 + \maximum 1 + \default 0.0 + N6; \field Fraction Lost + \type real + \minimum 0 + \maximum 1 + \default 0.0 + +OS:ElectricEquipment:ITE:AirCooled:Definition, + \memo This object describes air-cooled electric information technology equipment (ITE) which has + \memo variable power consumption as a function of loading and temperature. + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2 , \field Name + \required-field + \type alpha + \reference ElectricEquipmentITEAirCooledDefinitionNames + \reference SpaceComponentDefinitionNames + A3 , \field Air Flow Calculation Method + \note The specified method is used to calculate the IT inlet temperature and zone return + \note air temperature. If FlowFromSystem is chosen, the zone is assumed to be well-mixed. + \note If FlowControlWithApproachTemperatures is chosen, Supply and Return approach temperature + \note should be defined to indicate the temperature difference due to the air distribution. When + \note FlowControlWithApproachTemperatures is chosen, the inputs of Air Inlet Connection Type, Design Recirculation Fraction + \note and Recirculation Function of Loading and Supply Temperature Curve Name are ignored. For multiple + \note ITE objects defined for one zone, the same calculation method should apply. + \note The FlowControlWithApproachTemperatures only applies to ITE zones with single duct VAV terminal unit. + \note Other return air heat gains from window or lights are not allowed when FlowControlWithApproachTemperatures is chosen. + \type choice + \key FlowFromSystem + \key FlowControlWithApproachTemperatures + \default FlowFromSystem + A4 , \field Design Power Input Calculation Method + \note The entered calculation method is used to specify the design power input + \note Watts/Unit => Watts per Unit -- Design Power = Watts per Unit * Number of Units + \note Watts/Area => Watts per Space Floor Area -- Design Power = Watts per Space Floor Area * Floor Area + \type choice + \key Watts/Unit + \key Watts/Area + \default Watts/Unit + N1 , \field Watts per Unit + \type real + \units W + \ip-units W + \minimum 0 + N2 , \field Watts per Space Floor Area + \type real + \units W/m2 + \ip-units W/ft2 + \minimum 0 + A5 , \field CPU Power Input Function of Loading and Air Temperature Curve Name + \note The name of a two-variable curve or table lookup object which modifies the CPU power + \note input as a function of CPU loading (x) and air inlet node temperature (y). + \note This curve (table) should equal 1.0 at design conditions (CPU loading = 1.0 and + \note Design Entering Air Temperature). + \note A default curve named “Data Center Servers Power fLoadTemp” is assigned. + \type object-list + \required-field + \object-list BivariateFunctions + N3 , \field Design Fan Power Input Fraction + \note The fraction of the total power input at design conditions which is for the cooling fan(s) + \type real + \minimum 0.0 + \maximum 1.0 + \default 0.0 + N4, \field Design Fan Air Flow Rate per Power Input + \note The cooling fan air flow rate per total electric power input at design conditions + \type real + \required-field + \units m3/s-W + \ip-units (ft3/min)/(Btu/h) + \minimum 0.0 + A6 , \field Air Flow Function of Loading and Air Temperature Curve Name + \note The name of a two-variable curve or table lookup object which modifies the cooling + \note air flow rate as a function of CPU loading (x) and air inlet node temperature (y). + \note This curve (table) should equal 1.0 at design conditions (CPU loading = 1.0 and + \note Design Entering Air Temperature). + \note A default curve named “Data Center Servers Power fLoadTemp” is assigned. + \type object-list + \required-field + \object-list BivariateFunctions + A7 , \field Fan Power Input Function of Flow Curve Name + \note The name of a single-variable curve or table lookup object which modifies the cooling + \note fan power as a function of flow fraction (x). + \note This curve (table) should equal 1.0 at a flow fraction of 1.0. + \note A default curve named “ECM FanPower fFlow” is assigned. + \type object-list + \required-field + \object-list UnivariateFunctions + N5, \field Design Entering Air Temperature + \note The entering air temperature at design conditions. + \type real + \units C + \ip-units F + \default 15.0 + A8, \field Environmental Class + \note Specifies the allowable operating conditions for the air inlet conditions. + \note Used for reporting time outside allowable conditions. + \type choice + \key None + \key A1 + \key A2 + \key A3 + \key A4 + \key B + \key C + \key H1 + \default None + A9, \field Air Inlet Connection Type + \note Specifies the type of connection between the zone and the ITE air inlet node. + \note AdjustedSupply = ITE inlet temperature will be the current Supply Air Node temperature + \note adjusted by the current recirculation fraction. + \note All heat output is added to the zone air heat balance as a convective gain. + \note ZoneAirNode = ITE air inlet condition is the average zone condition. + \note All heat output is added to the zone air heat balance as a convective gain. + \note RoomAirModel = ITE air inlet and outlet are connected to room air model nodes. + \note This field is only used when Air Flow Calculation Method is FlowFromSystem. + \type choice + \key AdjustedSupply + \key ZoneAirNode + \default AdjustedSupply + N6, \field Design Recirculation Fraction + \note The recirculation fraction for this equipment at design conditions. This field is used only + \note if the Air Node Connection Type = AdjustedSupply. The default is 0.0 (no recirculation). + \note This field is only used when Air Flow Calculation Method is FlowFromSystem. + \type real + \minimum 0.0 + \maximum 0.5 + \default 0.0 + A10, \field Recirculation Function of Loading and Supply Temperature Curve Name + \note The name of a two-variable curve or table lookup object which modifies the recirculation + \note fraction as a function of CPU loading (x) and supply air node temperature (y). + \note This curve (table) should equal 1.0 at design conditions (CPU loading = 1.0 and + \note Design Entering Air Temperature).This field is used only if the + \note Air Node Connection Type = AdjustedSupply. If this curve is left blank, then the curve + \note is assumed to always equal 1.0. + \note This field is only used when Air Flow Calculation Method is FlowFromSystem. + \type object-list + \object-list BivariateFunctions + N7 , \field Design Electric Power Supply Efficiency + \note The efficiency of the power supply system serving this ITE + \type real + \minimum> 0.0 + \maximum 1.0 + \default 1.0 + A11, \field Electric Power Supply Efficiency Function of Part Load Ratio Curve Name + \note The name of a single-variable curve or table lookup object which modifies the electric + \note power supply efficiency as a function of part-load ratio (x). + \note This curve (table) should equal 1.0 at full load (PLR = 1.0). + \note If this curve is left blank, then the curve is assumed to always equal 1.0. + \type object-list + \object-list UnivariateFunctions + N8 , \field Fraction of Electric Power Supply Losses to Zone + \note Fraction of the electric power supply losses which are a heat gain to the zone + \note If this field is <1.0, the remainder of the losses are assumed to be lost to the outdoors. + \type real + \minimum 0.0 + \maximum 1.0 + \default 1.0 + N9, \field Supply Temperature Difference + \note The difference of the IT inlet temperature from the AHU supply air temperature. + \note Either Supply Temperature Difference or Supply Temperature Difference Schedule is required if Air Flow Calculation Method is set to FlowControlWithApproachTemperatures. + \note This field is ignored when Air Flow Calculation Method is FlowFromSystem. + \type real + \units deltaC + \ip-units F + \default 5.0 + A12, \field Supply Temperature Difference Schedule + \note The difference schedule of the IT inlet temperature from the AHU supply air temperature. + \note Either Supply Temperature Difference or Supply Temperature Difference Schedule is required if Air Flow Calculation Method is set to FlowControlWithApproachTemperatures. + \note This field is ignored when Air Flow Calculation Method is FlowFromSystem. + \type object-list + \object-list ScheduleNames + N10, \field Return Temperature Difference + \note The difference of the the actual AHU return air temperature to the IT equipment outlet temperature. + \note Either Return Temperature Difference or Return Temperature Difference Schedule is required if Air Flow Calculation Method is set to FlowControlWithApproachTemperatures. + \note This field is ignored when Air Flow Calculation Method is FlowFromSystem. + \type real + \units deltaC + \ip-units F + \default 2.0 + A13; \field Return Temperature Difference Schedule + \note The difference schedule of the actual AHU return air temperature to the IT equipment outlet temperature. + \note Either Return Temperature Difference or Return Temperature Difference Schedule is required if Air Flow Calculation Method is set to FlowControlWithApproachTemperatures. + \note This field is ignored when Air Flow Calculation Method is FlowFromSystem. + \type object-list + \object-list ScheduleNames + + +OS:GasEquipment:Definition, + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference GasEquipmentDefinitionNames + \reference SpaceComponentDefinitionNames + A3, \field Design Level Calculation Method + \note The entered calculation method is used to create the maximum amount of gas equipment + \note for this set of attributes + \note Choices: EquipmentLevel => Equipment Level -- simply enter watts of equipment + \note Watts/Area => Watts per Space Floor Area -- enter the number to apply. Value * Floor Area = Equipment Level + \note Watts/Person => Watts per Person -- enter the number to apply. Value * Occupants = Equipment Level + \type choice + \required-field + \key EquipmentLevel + \key Watts/Area + \key Watts/Person + N1, \field Design Level + \type real + \units W + \ip-units Btu/h + \minimum 0 + N2, \field Watts per Space Floor Area + \type real + \units W/m2 + \minimum 0 + N3, \field Watts per Person + \type real + \units W/Person + \minimum 0 + N4, \field Fraction Latent + \type real + \minimum 0 + \maximum 1 + \default 0.0 + N5, \field Fraction Radiant + \type real + \minimum 0 + \maximum 1 + \default 0.0 + N6, \field Fraction Lost + \type real + \minimum 0 + \maximum 1 + \default 0.0 + N7; \field Carbon Dioxide Generation Rate + \note CO2 generation rate per unit of power input + \note The default value assumes the equipment is fully vented. + \note For unvented equipment, a suggested value is 3.45E-8 m3/s-W. This value is + \note converted from a natural gas CO2 emission rate of 117 lbs CO2 per million Btu. + \note The maximum value assumes to be 10 times of the recommended value. + \type real + \units m3/s-W + \minimum 0 + \maximum 4e-07 + \default 0.0 + +OS:HotWaterEquipment:Definition, + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference HotWaterEquipmentDefinitionNames + \reference SpaceComponentDefinitionNames + A3, \field Design Level Calculation Method + \note The entered calculation method is used to create the maximum amount of hot water equipment + \note for this set of attributes + \note Choices: Equipment Level -- simply enter watts of equipment + \note Watts/Area - Watts per Space Floor Area -- enter the number to apply. Value * Floor Area = Equipment Level + \note Watts/Person - Watts per Person -- enter the number to apply. Value * Occupants = Equipment Level + \type choice + \required-field + \key EquipmentLevel + \key Watts/Area + \key Watts/Person + N1, \field Design Level + \type real + \units W + \ip-units Btu/h + \minimum 0 + N2, \field Watts per Space Floor Area + \type real + \units W/m2 + \minimum 0 + N3, \field Watts per Person + \type real + \units W/Person + \minimum 0 + N4, \field Fraction Latent + \type real + \minimum 0 + \maximum 1 + \default 0.0 + N5, \field Fraction Radiant + \type real + \minimum 0 + \maximum 1 + \default 0.0 + N6; \field Fraction Lost + \type real + \minimum 0 + \maximum 1 + \default 0.0 + +OS:SteamEquipment:Definition, + \memo Sets internal gains for steam equipment in the space. + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference SteamEquipmentDefinitionNames + \reference SpaceComponentDefinitionNames + A3, \field Design Level Calculation Method + \note The entered calculation method is used to create the maximum amount of steam equipment + \note for this set of attributes + \note Choices: Equipment Level -- simply enter watts of equipment + \note Watts/Area - Watts per Space Floor Area -- enter the number to apply. Value * Floor Area = Equipment Level + \note Watts/Person - Watts per Person -- enter the number to apply. Value * Occupants = Equipment Level + \type choice + \default EquipmentLevel + \key EquipmentLevel + \key Watts/Area + \key Watts/Person + N1, \field Design Level + \type real + \units W + \ip-units Btu/h + \minimum 0 + N2, \field Watts per Space Floor Area + \type real + \units W/m2 + \minimum 0 + N3, \field Watts per Person + \type real + \units W/Person + \minimum 0 + N4, \field Fraction Latent + \type real + \minimum 0 + \maximum 1 + \default 0.0 + N5, \field Fraction Radiant + \type real + \minimum 0 + \maximum 1 + \default 0.0 + N6; \field Fraction Lost + \type real + \minimum 0 + \maximum 1 + \default 0.0 + +OS:OtherEquipment:Definition, + \memo Sets internal gains or losses for "other" equipment in the space. + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference OtherEquipmentDefinitionNames + \reference SpaceComponentDefinitionNames + A3, \field Design Level Calculation Method + \note The entered calculation method is used to create the maximum amount of other equipment. + \note to set a loss, use a negative value in the following fields. + \note for this set of attributes + \note Choices: Equipment Level -- simply enter watts of equipment + \note Watts/Area - Watts per Space Floor Area -- enter the number to apply. Value * Floor Area = Equipment Level + \note Watts/Person - Watts per Person -- enter the number to apply. Value * Occupants = Equipment Level + \type choice + \default EquipmentLevel + \key EquipmentLevel + \key Watts/Area + \key Watts/Person + N1, \field Design Level + \type real + \units W + \ip-units W + N2, \field Watts per Space Floor Area + \type real + \units W/m2 + \minimum 0 + N3, \field Watts per Person + \type real + \units W/Person + \minimum 0 + N4, \field Fraction Latent + \type real + \minimum 0 + \maximum 1 + \default 0.0 + N5, \field Fraction Radiant + \type real + \minimum 0 + \maximum 1 + \default 0.0 + N6; \field Fraction Lost + \type real + \minimum 0 + \maximum 1 + \default 0.0 + +\group OpenStudio Exterior Equipment Definitions + +OS:Exterior:Lights:Definition, + \memo only used for Meter type reporting, does not affect building loads + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference ExteriorLightsDefinitionNames + \reference ExteriorEquipmentDefinitionNames + N1; \field Design Level + \type real + \required-field + \units W + \ip-units W + \minimum 0 + +OS:Exterior:FuelEquipment:Definition, + \memo only used for Meter type reporting, does not affect building loads + A1, \field Handle + \type handle + \required-field + A2, \field Name + \required-field + \type alpha + \reference ExteriorFuelEquipmentDefinitionNames + \reference ExteriorEquipmentDefinitionNames + N1; \field Design Level + \required-field + \units W + \type real + \minimum 0 + \ip-units W + +OS:Exterior:WaterEquipment:Definition, + \memo only used for Meter type reporting, does not affect building loads + A1, \field Handle + \type handle + \required-field + A2, \field Name + \required-field + \type alpha + \reference ExteriorWaterEquipmentDefinitionNames + \reference ExteriorEquipmentDefinitionNames + N1; \field Design Level + \required-field + \units m3/s + \ip-units gal/min + \type real + \minimum 0 + +\group OpenStudio Schedules + +OS:Schedule:Compact, + \memo Irregular object. Does not follow the usual definition for fields. Fields A3... are: + \memo Through: Date + \memo For: Applicable days (ref: Schedule:Week:Compact) + \memo Interpolate: Yes/No (ref: Schedule:Day:Interval) -- optional, if not used will be "No" + \memo Until: