From 9c93603b9734aa0f1a55e2ea6430ad3be1acf015 Mon Sep 17 00:00:00 2001 From: kbenne Date: Wed, 25 Jan 2017 11:13:10 -0600 Subject: [PATCH] Add 2.0.0 IDD --- .../idd/versions/2_0_0/OpenStudio.idd | 27191 ++++++++++++++++ 1 file changed, 27191 insertions(+) create mode 100644 openstudiocore/src/utilities/idd/versions/2_0_0/OpenStudio.idd diff --git a/openstudiocore/src/utilities/idd/versions/2_0_0/OpenStudio.idd b/openstudiocore/src/utilities/idd/versions/2_0_0/OpenStudio.idd new file mode 100644 index 00000000000..de8cc32fb32 --- /dev/null +++ b/openstudiocore/src/utilities/idd/versions/2_0_0/OpenStudio.idd @@ -0,0 +1,27191 @@ +!IDD_Version 2.0.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 0.7.5 + +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 + \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 + A1, \field Handle + \type handle + \required-field + N1, \field Calculation Frequency + \note 0=Use Default Periodic Calculation| calculate every day + \note only really applicable to RunPeriods + \note warning issued if >31 + \type integer + \minimum 1 + \default 20 + N2, \field Maximum Figures in Shadow Overlap Calculations + \note Number of allowable figures in shadow overlap calculations + \type integer + \minimum 200 + \default 15000 + A2, \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 + A3; \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 + +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 + 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 6. + \type integer + \minimum> 0 + \default 6 + +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 + \type choice + \default TARP + \key Simple + \key TARP + \key CeilingDiffuser + \key AdaptiveConvectionAlgorithm + +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 Determines which algorithm will be used to solve the zone air heat balance. + \unique-object + \format singleLine + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2; \field Algorithm + \type choice + \default ThirdOrderBackwardDifference + \key ThirdOrderBackwardDifference + \key AnalyticalSolution + \key EulerMethod + +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 For Zone Air Mass Flow Balance + \type choice + \key Yes + \key No + \default No + 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 + \min-fields 7 + A1, \field Handle + \type handle + \required-field + A2, \field Active Institution + \deprecated + \type alpha + \default ASHRAE + N1, \field Active Year + \deprecated + \type integer + \minimum 0 + \default 2006 + A3, \field Climate Zone Institution Name + \type alpha + \begin-extensible + \default ASHRAE + A4, \field Climate Zone Document Name + \type alpha + \default ANSI/ASHRAE Standard 169 + N2, \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: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 + 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 16 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + \required-field + \reference DesignDays + \reference RunPeriodsAndDesignDays + N1, \field Maximum Dry-Bulb Temperature + \type real + \units C + \minimum -70 + \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 Humidity Indicating Conditions at Maximum Dry-Bulb + \note this will be a wet-bulb, dewpoint, humidity ratio, or enthalpy coincident with the + \note maximum temperature depending on the value of the field + \note Humidity Indicating Type + \note required-field if Humidity Indicating Day Schedule is not used + \type real + N4, \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 + N5, \field Wind Speed + \type real + \units m/s + \ip-units miles/hr + \minimum 0 + \maximum 40 + \default 0.0 + N6, \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 + N7, \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 + N8, \field Rain Indicator + \note 1 is raining, 0 is not + \type integer + \minimum 0 + \maximum 1 + \default 0 + N9, \field Snow Indicator + \note 1 is Snow on Ground, 0 is no Snow on Ground + \type integer + \minimum 0 + \maximum 1 + \default 0 + N10, \field Day of Month + \note must be valid for Month field + \type integer + \minimum 1 + \maximum 31 + \default 1 + N11, \field Month + \type integer + \minimum 1 + \maximum 12 + \default 1 + A3, \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 + N12, \field Daylight Saving Time Indicator + \note 1=Yes, 0=No + \type integer + \minimum 0 + \maximum 1 + \default 0 + A4, \field Humidity Indicating Type + \note What Field "Humidity Indicating Conditions at Maximum Dry-Bulb" is. + \note Units for WetBulb, DewPoint, WetBulbProfilexxx [C] + \note Units for Humidity-Ratio [] + \note Units for Enthalpy [kJ/kg] + \type choice + \default WetBulb + \key WetBulb + \key DewPoint + \key HumidityRatio + \key Enthalpy + \key Schedule + \key WetBulbProfileMultiplierSchedule + \key WetBulbProfileDifferenceSchedule + \key WetBulbProfileDefaultMultipliers + A5, \field Humidity Indicating Day Schedule Name + \note only used when previous field is "Schedule", "WetBulbProfileMultiplierSchedule", or "WetBulbProfileDifferenceSchedule" + \note For type "Schedule", 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 + \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. + \type object-list + \object-list DayScheduleNames + A6, \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 DefaultMultipliers + A7, \field Dry-Bulb Temperature Range Modifier Schedule Name + \note Only used when previous field is "MultiplierSchedule" or "DifferenceSchedule". + \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. + \type object-list + \object-list DayScheduleNames + A8, \field Solar Model Indicator + \type choice + \default ASHRAEClearSky + \key ASHRAEClearSky + \key ZhangHuang + \key Schedule + \key ASHRAETau + A9, \field Beam Solar Day Schedule Name + \note if Solar Model Indicator = Schedule, then beam schedule name (for day) + \type object-list + \object-list DayScheduleNames + A10, \field Diffuse Solar Day Schedule Name + \note if Solar Model Indicator = Schedule, then diffuse schedule name (for day) + \type object-list + \object-list DayScheduleNames + N13, \field ASHRAE Taub + \note Required if Solar Model Indicator = ASHRAETau + \type real + \units dimensionless + \minimum 0 + \maximum 1 + \default 0 + N14, \field ASHRAE Taud + \note Required if Solar Model Indicator = ASHRAETau + \type real + \units dimensionless + \minimum 0 + \maximum 3 + \default 0 + N15; \field Daily Wet-Bulb Temperature Range + \note Required only if Humidity Indicating Type = "WetbulbProfileMultiplierSchedule" or "WetBulbProfileDefaultMultipliers" + \type real + \units deltaC + +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:UtilityCost:Charge:Block, + \extensible:2 + \min-fields 1 + \max-fields 38 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \note Charge Variable Name + \note This is the name associated with the UtilityCost:Charge:Block object and will appear in the report. + \note In addition the results of the UtilityCost:Charge:Block are stored in a variable with the same name. + \note That way the results may be used for further calculation. + \type alpha + A3, \field Tariff Name + \type alpha + A4, \field Source Variable + \note The name of the source used by the UtilityCost:Charge:Block. This is usually the name of the variable + \note holding the energy or demand but may also be the name of any variable including the subtotal or basis if + \note other charges are based on those. + \type alpha + A5, \field Season + \note If this is set to annual the calculations are performed for the UtilityCost:Charge:Block for the entire + \note year (all months) otherwise it is calculated only for those months in the season defined. + \type choice + \key Annual + \key Summer + \key Winter + \key Spring + \key Fall + A6, \field Category Variable Name + \note This field shows where the charge should be added. The reason to enter this field appropriately is so + \note that the charge gets reported in a reasonable category. The charge automatically gets added to the + \note variable that is the category. + \type choice + \key EnergyCharges + \key DemandCharges + \key ServiceCharges + \key Basis + \key Adjustment + \key Surcharge + \key Subtotal + \key Taxes + \key Total + \key NotIncluded + A7, \field Remaining Into Variable + \note If the blocks do not use all of the energy or demand from the source some energy and demand remains + \note then the remaining amount should be assigned to a variable. If no variable is assigned and some amount + \note of energy or demand is not used in the block structure a warning will be issued. + \type alpha + A8, \field Block Size Multiplier Value or Variable Name + \note The sizes of the blocks are usually used directly but if a value or a variable is entered here the block + \note sizes entered in the rest of the charge are first multiplied by the entered value prior to being used. + \note This is common for rates that are kWh/kW rates and in that case the variable that holds the monthly + \note total electric demand would be entered. If no value is entered a default value of one is assumed so + \note that the block sizes remain exactly as entered. This field is unusual for the EnergyPlus syntax because + \note it can be either a number or a name of a variable. + \type alpha + A9, \field Block Size Value or Variable Name + \note The size of the block of the charges is entered here. For most rates that use multiple blocks this will + \note be the value for the block size. Using remaining may be used when the remaining amount should be included + \note in that block. This field is unusual because it can be either a number or a name of a variable. + \type alpha + \begin-extensible + A10; \field Block Cost per Unit Value or Variable Name + \note The cost of the block. This field is unusual for the EnergyPlus syntax because it can be either a number + \note or a name of a variable. + \type alpha + +OS:UtilityCost:Charge:Simple, + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \note Charge Variable Name + \note This is the name associated with the UtilityCost:Charge:Simple object and will appear in the report. + \note In addition the results of the UtilityCost:Charge:Simple calculation are stored in a variable with the + \note same name. That way the results may be used for further calculation. Spaces are not significant in + \note Charge variable names. They are removed during the utility bill calculation process. + \type alpha + A3, \field Tariff Name + \type alpha + A4, \field Source Variable + \note The name of the source used by the UtilityCost:Charge:Simple. This is usually the name of the variable + \note holding the energy or demand but may also be the name of any variable including the subtotal or basis + \note if other charges are based on those. + \type alpha + A5, \field Season + \note If this is set to annual the calculations are performed for the UtilityCost:Charge:Simple for the entire + \note year (all months) otherwise it is calculated only for those months in the season defined. + \type choice + \key Annual + \key Summer + \key Winter + \key Spring + \key Fall + A6, \field Category Variable Name + \note This field shows where the charge should be added. The reason to enter this field appropriately is so + \note that the charge gets reported in a reasonable category. The charge automatically gets added to the + \note variable that is the category. + \type choice + \key EnergyCharges + \key DemandCharges + \key ServiceCharges + \key Basis + \key Adjustment + \key Surcharge + \key Subtotal + \key Taxes + \key Total + \key NotIncluded + A7; \field Cost per Unit Value or Variable Name + \note This field contains either a single number or the name of a variable. The number is multiplied with + \note all of the energy or demand or other source that is specified in the source field. If a variable is + \note used then the monthly values of the variable are multiplied against the variable specified in the + \note source field. This field makes it easy to include a simple charge without specifying block sizes. + \note This is a good way to include a tax or cost adjustment. + \type alpha + +OS:UtilityCost:Computation, + \extensible:1 + \min-fields 1 + \max-fields 33 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + A3, \field Tariff Name + \type alpha + A4; \field Compute Step + \note Contain a simple language that describes the steps used in the computation process similar to a + \note programming language. + \type alpha + \begin-extensible + +OS:UtilityCost:Qualify, + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \note Displayed in the report if the tariff does not qualify + \type alpha + A3, \field Tariff Name + \note The name of the UtilityCost:Tariff that is associated with this UtilityCost:Qualify. + \type alpha + A4, \field Variable Name + \note The name of the variable used. For energy and demand the automatically created variables totalEnergy + \note and totalDemand should be used respectively. + \type alpha + A5, \field Qualify Type + \type choice + \key Minimum + \key Maximum + A6, \field Threshold Value or Variable Name + \note The minimum or maximum value for the qualify. If the variable has values that are less than this value + \note when the qualify type is minimum then the tariff may be disqualified. If the variable has values that + \note are greater than this value when the qualify type is maximum then the tariff may be disqualified. + \type alpha + A7, \field Season + \note If the UtilityCost:Qualify only applies to a season enter the season name. If this field is left blank + \note it defaults to Annual. + \type choice + \key Annual + \key Summer + \key Winter + \key Spring + \key Fall + A8, \field Threshold Test + \note Uses the number in Number of Months in one of two different ways depending on the Threshold Test. If + \note the Threshold Test is set to Count then the qualification is based on the count of the total number + \note of months per year. If the Threshold Test is set to consecutive then the qualification is based on + \note a consecutive number of months. + \type choice + \key Count + \key Consecutive + N1; \field Number of Months + \note A number from 1 to 12. If no value entered 12 is assumed when the qualify type is minimum and 1 when + \note the qualify type is maximum. This is the number of months that the threshold test applies to determine + \note if the rate qualifies or not. If the season is less than 12 months (if it is not annual) then the + \note value is automatically reduced to the number of months of the seaon. + \type real + \minimum 1 + \maximum 12 + +OS:UtilityCost:Ratchet, + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \note Ratchet Variable Name + \note The name of the ratchet and the name of the result of this single ratchet. + \type alpha + A3, \field Tariff Name + \type alpha + A4, \field Baseline Source Variable + \note When the ratcheted value exceeds the baseline value for a month the ratcheted value is used but when the + \note baseline value is greater then the ratcheted value the baseline value is used. Usually the electric + \note demand charge is used. The baseline source variable can be the results of another ratchet object. This + \note allows utility tariffs that have multiple ratchets to be modeled. + \type alpha + A5, \field Adjustment Source Variable + \note The variable that the ratchet is calculated from. It is often but not always the same as the baseline + \note source variable. The ratcheting calculations using offset and multiplier are using the values from the + \note adjustment source variable. If left blank the adjustment source variable is the same as the baseline + \note source variable. + \type alpha + A6, \field Season From + \note The name of the season that is being examined. The maximum value for all of the months in the named + \note season is what is used with the multiplier and offset. This is most commonly Summer or Annual. When + \note Monthly is used the adjustment source variable is used directly for all months. + \type choice + \key Annual + \key Summer + \key Winter + \key Spring + \key Fall + \key Monthly + A7, \field Season To + \note The name of the season when the ratchet would be calculated. This is most commonly Winter. The ratchet + \note only is applied to the months in the named season. The resulting variable for months not in the Season To + \note selection will contain the values as appear in the baseline source variable. + \type choice + \key Annual + \key Summer + \key Winter + \key Spring + \key Fall + A8, \field Multiplier Value or Variable Name + \note Often the ratchet has a clause such as "the current month demand or 90% of the summer month demand". For + \note this case a value of 0.9 would be entered here as the multiplier. This value may be left blank if no + \note multiplier is needed and a value of one will be used as a default. + \type alpha + A9; \field Offset Value or Variable Name + \note A less common strategy is to say that the ratchet must be all demand greater than a value in this case + \note an offset that is added to the demand may be entered here. If entered it is common for the offset value + \note to be negative representing that the demand be reduced. If no value is entered it is assumed to be + \note zero and not affect the ratchet. + \type alpha + +OS:UtilityCost:Tariff, + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \note The name of the tariff. Tariffs are sometimes called rates. The name is used in identifying + \note the output results and in associating all of the charges and other objects that make up a tariff. + \type alpha + \required-field + A3, \field Output Meter Name + \note The name of any standard meter or custom meter or but usually set to either Electricity:Facility or Gas:Facility + \type alpha + \required-field + A4, \field Conversion Factor Choice + \note A choice that allows several different predefined conversion factors to be used; otherwise user + \note defined conversion factors are used as defined in the next two fields. + \type choice + \key UserDefined + \key kWh + \key Therm + \key MMBtu + \key MJ + \key kBtu + \key MCF + \key CCF + N1, \field Energy Conversion Factor + \note Is a multiplier used to convert energy into the units specified by the utility in their tariff. If + \note left blank it defaults to 1 (no conversion). This field should will be used only if Conversion Factor + \note Choice is set to UserDefined. Within EnergyPlus energy always has units of J (joules). For + \note conversion from J to kWh use the value of 0.0000002778. This is also used for all objects that + \note reference the UtilityCost:Tariff. + \type real + N2, \field Demand Conversion Factor + \note Is a multiplier used to convert demand into the units specified by the utility in their tariff. If + \note left blank it defaults to 1 (no conversion). This field should will be used only if Conversion + \note Factor Choice is set to UserDefined. Within EnergyPlus demand always has units of J/s (joules/sec) + \note which equivalent to W (watts). For conversion from W to kW use the value of 0.001. This is also used + \note for all objects that reference the UtilityCost:Tariff. + \type real + A5, \field Time of Use Period Schedule Name + \note The name of the schedule that defines the time-of-use periods that occur each day. The values for the + \note different variables are: 1 for Peak. 2 for Shoulder. 3 for OffPeak. 4 for MidPeak. + \type object-list + \object-list ScheduleNames + A6, \field Season Schedule Name + \note The name of a schedule that defines the seasons. The schedule values are: 1 for Winter. 2 for Spring. + \note 3 for Summer. 4 for Autumn. + \type object-list + \object-list ScheduleNames + A7, \field Month Schedule Name + \note The name of the schedule that defines the billing periods of the year. Normally this entry is allowed + \note to default and a schedule will be internally used that has the breaks between billing periods occurring + \note at the same time as the breaks between months i.e. at midnight prior to the first day of the month. + \note If other billing periods are used such as two month cycles or a single bill for an entire season such + \note as some natural gas companies do in the summer then the month schedule may be used to redefine it. + \note Make sure that the month schedule and season schedule are consistent otherwise an error will be issued. + \type object-list + \object-list ScheduleNames + A8, \field Demand Window Length + \note The determination of demand can vary by utility. Some utilities use the peak instantaneous demand + \note measured but most use a fifteen minute average demand or a one hour average demand. Some gas utilities + \note measure demand as the use during the peak day or peak week. + \type choice + \key QuarterHour + \key HalfHour + \key FullHour + \key Day + \key Week + A9, \field Monthly Charge or Variable Name + \note The fixed monthly service charge that many utilities have. The entry may be numeric and gets added to + \note the ServiceCharges variable or if a variable name is entered here its values for each month are used. + \type alpha + A10, \field Minimum Monthly Charge or Variable Name + \note The minimum total charge for the tariff or if a variable name is entered here its + \note values for each month are used. + \type alpha + A11, \field Real Time Pricing Charge Schedule Name + \note Used with real time pricing rates. The name of a schedule that contains the cost of + \note energy for that particular time period of the year. Real time rates can be modeled using a charge + \note schedule with the actual real time prices entered in the schedule. + \type alpha + A12, \field Customer Baseline Load Schedule Name + \note Used with real time pricing rates. The name of a schedule that contains the baseline + \note energy use for the customer. Many real time rates apply the charges as a credit or debit only to the + \note difference between the baseline use and the actual use. + \type alpha + A13, \field Group Name + \note The group name of the tariff such as distribution transmission supplier etc. If more than one tariff + \note with the same group name is present and qualifies only the lowest cost tariff is used. Usually the group + \note name field is left blank which results in all tariffs using the same meter variable being compared and + \note the lowest cost one being selected. + \type alpha + A14; \field Buy Or Sell + \note Sets whether the tariff is used for buying selling or both to the utility. This + \note should be allowed to default to buyFromUtility unless a power generation system is included in the + \note building that may generate more power than the building needs during the year + \type choice + \key BuyFromUtility + \key SellToUtility + \key NetMetering + +OS:UtilityCost:Variable, + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2, \field Name + \type alpha + A3, \field Tariff Name + \type alpha + A4, \field Variable Type + \type choice + \key Energy + \key Power + \key Dimensionless + \key Currency + N1, \field January Value + \type real + N2, \field February Value + \type real + N3, \field March Value + \type real + N4, \field April Value + \type real + N5, \field May Value + \type real + N6, \field June Value + \type real + N7, \field July Value + \type real + N8, \field August Value + \type real + N9, \field September Value + \type real + N10, \field October Value + \type real + N11, \field November Value + \type real + N12; \field December Value + \type real + +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 + +OS:WeatherProperty:SkyTemperature, + \memo This object is used to override internal sky temperature calculations. + \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 + \type choice + \required-field + \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. + \type object-list + \required-field + \object-list ScheduleAndDayScheduleNames + +\group OpenStudio Resources + +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 + \extensible:3 + 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 + A5, \field Building Unit Feature Name + \type alpha + \begin-extensible + \required-field + A6, \field Building Unit Feature Data Type + \type choice + \key String + \key Double + \key Boolean + \key Integer + \required-field + A7; \field Building Unit Feature Value + \type alpha + \required-field + +OS:DefaultConstructionSet, + \min-fields 11 + 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 + +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 + 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 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. + A8; \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 + 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 + \maximum 3 + 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> 0 + 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:AirWall, + \min-fields 1 + A1, \field Handle + \type handle + \required-field + A2; \field Name + \type alpha + \required-field + \reference MaterialNames + +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 + 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 + \note Note that the effective upper limit for U-factor is 5.8 W/m2-K + \type real + \required-field + \units W/m2-K + \minimum> 0 + \maximum 7 + 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 + +\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, 8 for windows + \memo Enter the material name for each layer + \extensible:1 + \min-fields 8 + \max-fields 17 + 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 + N2, \field Temperature Calculation Requested After Layer Number + \note refers to the list of materials which follows + \type integer + \default 1 + \minimum 1 + 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 + 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: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 ZoneAveraged + \key ZoneAveraged + \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 + +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: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 + +\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: