honeybee-openstudio 2.0.3 → 2.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: df00142e35c53ffa6e706d3e99b9e5a99b1466a6963677d478d6c1b34dec8424
4
- data.tar.gz: 697e61773ee5e76c64e21ad711b434c7c13cd592fd669cd92e506a7895f89511
3
+ metadata.gz: 556c04533c8e2c3cc024c7b75383a804588e4369e6e8db76b77602d984c6dca6
4
+ data.tar.gz: 8512e5b6b1080918a818c1248a86ef068b800cb356255ac883048b557fec13cc
5
5
  SHA512:
6
- metadata.gz: 46586662b09ef02607e8a616b3541f0fcaf974469d5b762229029241cce79a87e615fdd77d9c6a5ad2fa75458dc651ef679e3873d830bc8d47f494ab7068cf76
7
- data.tar.gz: d8f1ab3659d344ab93db52c9aca8fd8e3b1b6badb494bf1be8790f57d4663d97e4a79a5784dbeb184f9e7fb01c676efb6ed72a80b1139e2047b02ad1b3ffd36e
6
+ metadata.gz: 0342b2c5a72be7bcc359e74b25dbb116eba914d8132aa0a64a16e50186be4c80e3cfd2b572f0254cbb16d39997759dbeb880cda8aec0465e1c8ed6dbb7ac18d1
7
+ data.tar.gz: d8101490818d69e82aea715576aab197975ba040640083f7962f44429f256efab0cd641d2ede529b919b5779ef1625b769ace8cab192348fa21b2c9799d8f171
@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
4
 
5
5
  Gem::Specification.new do |spec|
6
6
  spec.name = 'honeybee-openstudio'
7
- spec.version = '2.0.3'
7
+ spec.version = '2.1.0'
8
8
  spec.authors = ['Tanushree Charan', 'Dan Macumber', 'Chris Mackey', 'Mostapha Sadeghipour Roudsari']
9
9
  spec.email = ['tanushree.charan@nrel.gov', 'chris@ladybug.tools']
10
10
 
@@ -51,6 +51,7 @@ require 'from_honeybee/hvac/ideal_air'
51
51
  # import the construction objects
52
52
  require 'from_honeybee/construction/opaque'
53
53
  require 'from_honeybee/construction/window'
54
+ require 'from_honeybee/construction/windowshade'
54
55
  require 'from_honeybee/construction/shade'
55
56
  require 'from_honeybee/construction/air'
56
57
 
@@ -3,7 +3,7 @@
3
3
  "servers": [],
4
4
  "info": {
5
5
  "description": "This is the documentation for Honeybee model schema.",
6
- "version": "0.0.1",
6
+ "version": "1.32.0",
7
7
  "title": "Honeybee Model Schema",
8
8
  "contact": {
9
9
  "name": "Ladybug Tools",
@@ -618,6 +618,26 @@
618
618
  "name": "windowconstructionabridged_model",
619
619
  "x-displayName": "WindowConstructionAbridged",
620
620
  "description": "<SchemaDefinition schemaRef=\"#/components/schemas/WindowConstructionAbridged\" />\n"
621
+ },
622
+ {
623
+ "name": "windowconstructionshade_model",
624
+ "x-displayName": "WindowConstructionShade",
625
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/WindowConstructionShade\" />\n"
626
+ },
627
+ {
628
+ "name": "shadelocation_model",
629
+ "x-displayName": "ShadeLocation",
630
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ShadeLocation\" />\n"
631
+ },
632
+ {
633
+ "name": "controltype_model",
634
+ "x-displayName": "ControlType",
635
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ControlType\" />\n"
636
+ },
637
+ {
638
+ "name": "windowconstructionshadeabridged_model",
639
+ "x-displayName": "WindowConstructionShadeAbridged",
640
+ "description": "<SchemaDefinition schemaRef=\"#/components/schemas/WindowConstructionShadeAbridged\" />\n"
621
641
  }
622
642
  ],
623
643
  "x-tagGroups": [
@@ -640,6 +660,7 @@
640
660
  "bsdf_model",
641
661
  "constructionset_model",
642
662
  "constructionsetabridged_model",
663
+ "controltype_model",
643
664
  "door_model",
644
665
  "doorconstructionset_model",
645
666
  "doorconstructionsetabridged_model",
@@ -725,6 +746,7 @@
725
746
  "shade_model",
726
747
  "shadeconstruction_model",
727
748
  "shadeenergypropertiesabridged_model",
749
+ "shadelocation_model",
728
750
  "shademodifierset_model",
729
751
  "shademodifiersetabridged_model",
730
752
  "shadepropertiesabridged_model",
@@ -742,7 +764,9 @@
742
764
  "wallmodifierset_model",
743
765
  "wallmodifiersetabridged_model",
744
766
  "windowconstruction_model",
745
- "windowconstructionabridged_model"
767
+ "windowconstructionabridged_model",
768
+ "windowconstructionshade_model",
769
+ "windowconstructionshadeabridged_model"
746
770
  ]
747
771
  }
748
772
  ],
@@ -960,12 +984,12 @@
960
984
  "properties": {
961
985
  "boundary_condition_objects": {
962
986
  "title": "Boundary Condition Objects",
963
- "description": "A list of up to 3 object identifiers that are adjacent to this one. The first object is always the one that is immediately adjacet and is of the same object type (Face, Aperture, Door). When this boundary condition is applied to a Face, the second object in the tuple will be the parent Room of the adjacent object. When the boundary condition is applied to a sub-face (Door or Aperture), the second object will be the parent Face of the adjacent sub-face and the third object will be the parent Room of the adjacent sub-face.",
964
- "min_tems": 2,
987
+ "description": "A list of up to 3 object identifiers that are adjacent to this one. The first object is always the one that is immediately adjacent and is of the same object type (Face, Aperture, Door). When this boundary condition is applied to a Face, the second object in the tuple will be the parent Room of the adjacent object. When the boundary condition is applied to a sub-face (Door or Aperture), the second object will be the parent Face of the adjacent sub-face and the third object will be the parent Room of the adjacent sub-face.",
965
988
  "type": "array",
966
989
  "items": {
967
990
  "type": "string"
968
991
  },
992
+ "minItems": 2,
969
993
  "maxItems": 3
970
994
  },
971
995
  "type": {
@@ -1002,7 +1026,7 @@
1002
1026
  },
1003
1027
  "transmittance_schedule": {
1004
1028
  "title": "Transmittance Schedule",
1005
- "description": "Identifier of a schedule to set the transmittance of the shade, which can vary throughout the simulation. If None, the shade will be completely opauqe.",
1029
+ "description": "Identifier of a schedule to set the transmittance of the shade, which can vary throughout the simulation. If None, the shade will be completely opaque.",
1006
1030
  "maxLength": 100,
1007
1031
  "minLength": 1,
1008
1032
  "type": "string"
@@ -2640,7 +2664,7 @@
2640
2664
  },
2641
2665
  "operable_construction": {
2642
2666
  "title": "Operable Construction",
2643
- "description": "Identifier for a WindowConstruction for all apertures with an Outdoors boundary condition and True is_operable property..",
2667
+ "description": "Identifier for a WindowConstruction for all apertures with an Outdoors boundary condition and True is_operable property.",
2644
2668
  "maxLength": 100,
2645
2669
  "minLength": 1,
2646
2670
  "type": "string"
@@ -2976,7 +3000,7 @@
2976
3000
  },
2977
3001
  "layers": {
2978
3002
  "title": "Layers",
2979
- "description": "List of strings for material identifiers. The order of the materials is from exterior to interior.",
3003
+ "description": "List of strings for opaque material identifiers. The order of the materials is from exterior to interior.",
2980
3004
  "minLength": 1,
2981
3005
  "maxLength": 100,
2982
3006
  "type": "array",
@@ -2990,7 +3014,7 @@
2990
3014
  },
2991
3015
  "materials": {
2992
3016
  "title": "Materials",
2993
- "description": "List of materials. The order of the materials is from outside to inside.",
3017
+ "description": "List of opaque materials. The order of the materials is from outside to inside.",
2994
3018
  "type": "array",
2995
3019
  "items": {
2996
3020
  "anyOf": [
@@ -3151,6 +3175,199 @@
3151
3175
  },
3152
3176
  "additionalProperties": false
3153
3177
  },
3178
+ "EnergyWindowMaterialSimpleGlazSys": {
3179
+ "title": "EnergyWindowMaterialSimpleGlazSys",
3180
+ "description": "Describe an entire glazing system rather than individual layers.\n\nUsed when only very limited information is available on the glazing layers or when\nspecific performance levels are being targeted.",
3181
+ "type": "object",
3182
+ "properties": {
3183
+ "identifier": {
3184
+ "title": "Identifier",
3185
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
3186
+ "maxLength": 100,
3187
+ "minLength": 1,
3188
+ "type": "string"
3189
+ },
3190
+ "u_factor": {
3191
+ "title": "U Factor",
3192
+ "description": "Used to describe the value for window system U-Factor, or overall heat transfer coefficient in W/(m2-K).",
3193
+ "exclusiveMinimum": 0,
3194
+ "maximum": 5.8,
3195
+ "type": "number",
3196
+ "format": "double"
3197
+ },
3198
+ "shgc": {
3199
+ "title": "Shgc",
3200
+ "description": "Unitless quantity describing Solar Heat Gain Coefficient for normal incidence and vertical orientation.",
3201
+ "exclusiveMinimum": 0,
3202
+ "exclusiveMaximum": 1,
3203
+ "type": "number",
3204
+ "format": "double"
3205
+ },
3206
+ "display_name": {
3207
+ "title": "Display Name",
3208
+ "description": "Display name of the object with no character restrictions.",
3209
+ "type": "string"
3210
+ },
3211
+ "type": {
3212
+ "title": "Type",
3213
+ "default": "EnergyWindowMaterialSimpleGlazSys",
3214
+ "pattern": "^EnergyWindowMaterialSimpleGlazSys$",
3215
+ "type": "string",
3216
+ "readOnly": true
3217
+ },
3218
+ "vt": {
3219
+ "title": "Vt",
3220
+ "description": "The fraction of visible light falling on the window that makes it through the glass at normal incidence.",
3221
+ "default": 0.54,
3222
+ "exclusiveMinimum": 0,
3223
+ "exclusiveMaximum": 1,
3224
+ "type": "number",
3225
+ "format": "double"
3226
+ }
3227
+ },
3228
+ "required": [
3229
+ "identifier",
3230
+ "u_factor",
3231
+ "shgc"
3232
+ ],
3233
+ "additionalProperties": false
3234
+ },
3235
+ "EnergyWindowMaterialGlazing": {
3236
+ "title": "EnergyWindowMaterialGlazing",
3237
+ "description": "Describe a single glass pane corresponding to a layer in a window construction.",
3238
+ "type": "object",
3239
+ "properties": {
3240
+ "identifier": {
3241
+ "title": "Identifier",
3242
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
3243
+ "maxLength": 100,
3244
+ "minLength": 1,
3245
+ "type": "string"
3246
+ },
3247
+ "display_name": {
3248
+ "title": "Display Name",
3249
+ "description": "Display name of the object with no character restrictions.",
3250
+ "type": "string"
3251
+ },
3252
+ "type": {
3253
+ "title": "Type",
3254
+ "default": "EnergyWindowMaterialGlazing",
3255
+ "pattern": "^EnergyWindowMaterialGlazing$",
3256
+ "type": "string",
3257
+ "readOnly": true
3258
+ },
3259
+ "thickness": {
3260
+ "title": "Thickness",
3261
+ "description": "The surface-to-surface of the glass in meters. Default value is 0.003.",
3262
+ "default": 0.003,
3263
+ "exclusiveMinimum": 0,
3264
+ "type": "number",
3265
+ "format": "double"
3266
+ },
3267
+ "solar_transmittance": {
3268
+ "title": "Solar Transmittance",
3269
+ "description": "Transmittance of solar radiation through the glass at normal incidence. Default value is 0.85 for clear glass.",
3270
+ "default": 0.85,
3271
+ "minimum": 0,
3272
+ "maximum": 1,
3273
+ "type": "number",
3274
+ "format": "double"
3275
+ },
3276
+ "solar_reflectance": {
3277
+ "title": "Solar Reflectance",
3278
+ "description": "Reflectance of solar radiation off of the front side of the glass at normal incidence, averaged over the solar spectrum. Default value is 0.075 for clear glass.",
3279
+ "default": 0.075,
3280
+ "minimum": 0,
3281
+ "maximum": 1,
3282
+ "type": "number",
3283
+ "format": "double"
3284
+ },
3285
+ "solar_reflectance_back": {
3286
+ "title": "Solar Reflectance Back",
3287
+ "description": "Reflectance of solar radiation off of the back side of the glass at normal incidence, averaged over the solar spectrum.",
3288
+ "type": "number",
3289
+ "format": "double"
3290
+ },
3291
+ "visible_transmittance": {
3292
+ "title": "Visible Transmittance",
3293
+ "description": "Transmittance of visible light through the glass at normal incidence. Default value is 0.9 for clear glass.",
3294
+ "default": 0.9,
3295
+ "minimum": 0,
3296
+ "maximum": 1,
3297
+ "type": "number",
3298
+ "format": "double"
3299
+ },
3300
+ "visible_reflectance": {
3301
+ "title": "Visible Reflectance",
3302
+ "description": "Reflectance of visible light off of the front side of the glass at normal incidence. Default value is 0.075 for clear glass.",
3303
+ "default": 0.075,
3304
+ "minimum": 0,
3305
+ "maximum": 1,
3306
+ "type": "number",
3307
+ "format": "double"
3308
+ },
3309
+ "visible_reflectance_back": {
3310
+ "title": "Visible Reflectance Back",
3311
+ "description": "Reflectance of visible light off of the back side of the glass at normal incidence averaged over the solar spectrum and weighted by the response of the human eye.",
3312
+ "minimum": 0,
3313
+ "maximum": 1,
3314
+ "type": "number",
3315
+ "format": "double"
3316
+ },
3317
+ "infrared_transmittance": {
3318
+ "title": "Infrared Transmittance",
3319
+ "description": "Long-wave transmittance at normal incidence.",
3320
+ "default": 0,
3321
+ "minimum": 0,
3322
+ "maximum": 1,
3323
+ "type": "number",
3324
+ "format": "double"
3325
+ },
3326
+ "emissivity": {
3327
+ "title": "Emissivity",
3328
+ "description": "Infrared hemispherical emissivity of the front (outward facing) side of the glass. Default value is 0.84, which is typical for clear glass without a low-e coating.",
3329
+ "default": 0.84,
3330
+ "minimum": 0,
3331
+ "maximum": 1,
3332
+ "type": "number",
3333
+ "format": "double"
3334
+ },
3335
+ "emissivity_back": {
3336
+ "title": "Emissivity Back",
3337
+ "description": "Infrared hemispherical emissivity of the back (inward facing) side of the glass. Default value is 0.84, which is typical for clear glass without a low-e coating.",
3338
+ "default": 0.84,
3339
+ "minimum": 0,
3340
+ "maximum": 1,
3341
+ "type": "number",
3342
+ "format": "double"
3343
+ },
3344
+ "conductivity": {
3345
+ "title": "Conductivity",
3346
+ "description": "Thermal conductivity of the glass in W/(m-K). Default value is 0.9, which is typical for clear glass without a low-e coating.",
3347
+ "default": 0.9,
3348
+ "exclusiveMinimum": 0,
3349
+ "type": "number",
3350
+ "format": "double"
3351
+ },
3352
+ "dirt_correction": {
3353
+ "title": "Dirt Correction",
3354
+ "description": "Factor that corrects for the presence of dirt on the glass. A default value of 1 indicates the glass is clean.",
3355
+ "default": 1,
3356
+ "type": "number",
3357
+ "format": "double"
3358
+ },
3359
+ "solar_diffusing": {
3360
+ "title": "Solar Diffusing",
3361
+ "description": "Takes values True and False. If False (default), the beam solar radiation incident on the glass is transmitted as beam radiation with no diffuse component.If True, the beam solar radiation incident on the glass is transmitted as hemispherical diffuse radiation with no beam component.",
3362
+ "default": false,
3363
+ "type": "boolean"
3364
+ }
3365
+ },
3366
+ "required": [
3367
+ "identifier"
3368
+ ],
3369
+ "additionalProperties": false
3370
+ },
3154
3371
  "EnergyWindowMaterialGas": {
3155
3372
  "title": "EnergyWindowMaterialGas",
3156
3373
  "description": "Create single layer of gas in a window construction.\n\nCan be combined with EnergyWindowMaterialGlazing to make multi-pane windows.",
@@ -3385,9 +3602,9 @@
3385
3602
  ],
3386
3603
  "additionalProperties": false
3387
3604
  },
3388
- "EnergyWindowMaterialSimpleGlazSys": {
3389
- "title": "EnergyWindowMaterialSimpleGlazSys",
3390
- "description": "Describe an entire glazing system rather than individual layers.\n\nUsed when only very limited information is available on the glazing layers or when\nspecific performance levels are being targeted.",
3605
+ "WindowConstruction": {
3606
+ "title": "WindowConstruction",
3607
+ "description": "Construction for window objects (Aperture, Door).",
3391
3608
  "type": "object",
3392
3609
  "properties": {
3393
3610
  "identifier": {
@@ -3397,54 +3614,180 @@
3397
3614
  "minLength": 1,
3398
3615
  "type": "string"
3399
3616
  },
3400
- "u_factor": {
3401
- "title": "U Factor",
3402
- "description": "Used to describe the value for window system U-Factor, or overall heat transfer coefficient in W/(m2-K).",
3403
- "exclusiveMinimum": 0,
3404
- "maximum": 5.8,
3405
- "type": "number",
3406
- "format": "double"
3407
- },
3408
- "shgc": {
3409
- "title": "Shgc",
3410
- "description": "Unitless quantity describing Solar Heat Gain Coefficient for normal incidence and vertical orientation.",
3411
- "exclusiveMinimum": 0,
3412
- "exclusiveMaximum": 1,
3413
- "type": "number",
3414
- "format": "double"
3415
- },
3416
- "display_name": {
3417
- "title": "Display Name",
3418
- "description": "Display name of the object with no character restrictions.",
3419
- "type": "string"
3420
- },
3421
- "type": {
3422
- "title": "Type",
3423
- "default": "EnergyWindowMaterialSimpleGlazSys",
3424
- "pattern": "^EnergyWindowMaterialSimpleGlazSys$",
3425
- "type": "string",
3426
- "readOnly": true
3617
+ "layers": {
3618
+ "title": "Layers",
3619
+ "description": "List of strings for glazing or gas material identifiers. The order of the materials is from exterior to interior. If a SimpleGlazSys material is used, it must be the only material in the construction. For multi-layered constructions, adjacent glass layers must be separated by one and only one gas layer.",
3620
+ "minLength": 1,
3621
+ "maxLength": 100,
3622
+ "type": "array",
3623
+ "items": {
3624
+ "type": "string",
3625
+ "minLength": 1,
3626
+ "maxLength": 100
3627
+ },
3628
+ "minItems": 1,
3629
+ "maxItems": 8
3427
3630
  },
3428
- "vt": {
3429
- "title": "Vt",
3430
- "description": "The fraction of visible light falling on the window that makes it through the glass at normal incidence.",
3431
- "default": 0.54,
3432
- "exclusiveMinimum": 0,
3433
- "exclusiveMaximum": 1,
3434
- "type": "number",
3435
- "format": "double"
3436
- }
3631
+ "materials": {
3632
+ "title": "Materials",
3633
+ "description": "List of glazing and gas materials. The order of the materials is from outside to inside. If a SimpleGlazSys material is used, it must be the only material in the construction. For multi-layered constructions, adjacent glass layers must be separated by one and only one gas layer.",
3634
+ "type": "array",
3635
+ "items": {
3636
+ "anyOf": [
3637
+ {
3638
+ "$ref": "#/components/schemas/EnergyWindowMaterialSimpleGlazSys"
3639
+ },
3640
+ {
3641
+ "$ref": "#/components/schemas/EnergyWindowMaterialGlazing"
3642
+ },
3643
+ {
3644
+ "$ref": "#/components/schemas/EnergyWindowMaterialGas"
3645
+ },
3646
+ {
3647
+ "$ref": "#/components/schemas/EnergyWindowMaterialGasCustom"
3648
+ },
3649
+ {
3650
+ "$ref": "#/components/schemas/EnergyWindowMaterialGasMixture"
3651
+ }
3652
+ ]
3653
+ },
3654
+ "minItems": 1,
3655
+ "maxItems": 8
3656
+ },
3657
+ "display_name": {
3658
+ "title": "Display Name",
3659
+ "description": "Display name of the object with no character restrictions.",
3660
+ "type": "string"
3661
+ },
3662
+ "type": {
3663
+ "title": "Type",
3664
+ "default": "WindowConstruction",
3665
+ "pattern": "^WindowConstruction$",
3666
+ "type": "string",
3667
+ "readOnly": true
3668
+ }
3437
3669
  },
3438
3670
  "required": [
3439
3671
  "identifier",
3440
- "u_factor",
3441
- "shgc"
3672
+ "layers",
3673
+ "materials"
3442
3674
  ],
3443
3675
  "additionalProperties": false
3444
3676
  },
3445
- "EnergyWindowMaterialBlind": {
3446
- "title": "EnergyWindowMaterialBlind",
3447
- "description": "Window blind material consisting of flat, equally-spaced slats.",
3677
+ "ApertureConstructionSet": {
3678
+ "title": "ApertureConstructionSet",
3679
+ "description": "A set of constructions for aperture assemblies.",
3680
+ "type": "object",
3681
+ "properties": {
3682
+ "type": {
3683
+ "title": "Type",
3684
+ "default": "ApertureConstructionSet",
3685
+ "pattern": "^ApertureConstructionSet$",
3686
+ "type": "string",
3687
+ "readOnly": true
3688
+ },
3689
+ "interior_construction": {
3690
+ "title": "Interior Construction",
3691
+ "description": "A WindowConstruction for apertures with an Outdoors boundary condition, False is_operable property, and a Wall face type for their parent face.",
3692
+ "allOf": [
3693
+ {
3694
+ "$ref": "#/components/schemas/WindowConstruction"
3695
+ }
3696
+ ]
3697
+ },
3698
+ "window_construction": {
3699
+ "title": "Window Construction",
3700
+ "description": "A WindowConstruction for all apertures with a Surface boundary condition.",
3701
+ "allOf": [
3702
+ {
3703
+ "$ref": "#/components/schemas/WindowConstruction"
3704
+ }
3705
+ ]
3706
+ },
3707
+ "skylight_construction": {
3708
+ "title": "Skylight Construction",
3709
+ "description": "A WindowConstruction for apertures with a Outdoors boundary condition, False is_operable property, and a RoofCeiling or Floor face type for their parent face.",
3710
+ "allOf": [
3711
+ {
3712
+ "$ref": "#/components/schemas/WindowConstruction"
3713
+ }
3714
+ ]
3715
+ },
3716
+ "operable_construction": {
3717
+ "title": "Operable Construction",
3718
+ "description": "A WindowConstruction for all apertures with an Outdoors boundary condition and True is_operable property.",
3719
+ "allOf": [
3720
+ {
3721
+ "$ref": "#/components/schemas/WindowConstruction"
3722
+ }
3723
+ ]
3724
+ }
3725
+ },
3726
+ "additionalProperties": false
3727
+ },
3728
+ "DoorConstructionSet": {
3729
+ "title": "DoorConstructionSet",
3730
+ "description": "A set of constructions for door assemblies.",
3731
+ "type": "object",
3732
+ "properties": {
3733
+ "type": {
3734
+ "title": "Type",
3735
+ "default": "DoorConstructionSet",
3736
+ "pattern": "^DoorConstructionSet$",
3737
+ "type": "string",
3738
+ "readOnly": true
3739
+ },
3740
+ "interior_construction": {
3741
+ "title": "Interior Construction",
3742
+ "description": "An OpaqueConstruction for all opaque doors with a Surface boundary condition.",
3743
+ "allOf": [
3744
+ {
3745
+ "$ref": "#/components/schemas/OpaqueConstruction"
3746
+ }
3747
+ ]
3748
+ },
3749
+ "exterior_construction": {
3750
+ "title": "Exterior Construction",
3751
+ "description": "An OpaqueConstruction for opaque doors with an Outdoors boundary condition and a Wall face type for their parent face.",
3752
+ "allOf": [
3753
+ {
3754
+ "$ref": "#/components/schemas/OpaqueConstruction"
3755
+ }
3756
+ ]
3757
+ },
3758
+ "overhead_construction": {
3759
+ "title": "Overhead Construction",
3760
+ "description": "An OpaqueConstruction for opaque doors with an Outdoors boundary condition and a RoofCeiling or Floor type for their parent face.",
3761
+ "allOf": [
3762
+ {
3763
+ "$ref": "#/components/schemas/OpaqueConstruction"
3764
+ }
3765
+ ]
3766
+ },
3767
+ "exterior_glass_construction": {
3768
+ "title": "Exterior Glass Construction",
3769
+ "description": "A WindowConstruction for all glass doors with an Outdoors boundary condition.",
3770
+ "allOf": [
3771
+ {
3772
+ "$ref": "#/components/schemas/WindowConstruction"
3773
+ }
3774
+ ]
3775
+ },
3776
+ "interior_glass_construction": {
3777
+ "title": "Interior Glass Construction",
3778
+ "description": "A WindowConstruction for all glass doors with a Surface boundary condition.",
3779
+ "allOf": [
3780
+ {
3781
+ "$ref": "#/components/schemas/WindowConstruction"
3782
+ }
3783
+ ]
3784
+ }
3785
+ },
3786
+ "additionalProperties": false
3787
+ },
3788
+ "ShadeConstruction": {
3789
+ "title": "ShadeConstruction",
3790
+ "description": "Construction for Shade objects.",
3448
3791
  "type": "object",
3449
3792
  "properties": {
3450
3793
  "identifier": {
@@ -3461,254 +3804,222 @@
3461
3804
  },
3462
3805
  "type": {
3463
3806
  "title": "Type",
3464
- "default": "EnergyWindowMaterialBlind",
3465
- "pattern": "^EnergyWindowMaterialBlind$",
3807
+ "default": "ShadeConstruction",
3808
+ "pattern": "^ShadeConstruction$",
3466
3809
  "type": "string",
3467
3810
  "readOnly": true
3468
3811
  },
3469
- "slat_orientation": {
3470
- "allOf": [
3471
- {
3472
- "$ref": "#/components/schemas/SlatOrientation"
3473
- }
3474
- ],
3475
- "title": "Slat Orientation",
3476
- "default": "Horizontal",
3477
- "type": "string"
3478
- },
3479
- "slat_width": {
3480
- "title": "Slat Width",
3481
- "description": "The width of slat measured from edge to edge in meters.",
3482
- "default": 0.025,
3483
- "exclusiveMinimum": 0,
3812
+ "solar_reflectance": {
3813
+ "title": "Solar Reflectance",
3814
+ "description": "A number for the solar reflectance of the construction.",
3815
+ "default": 0.2,
3816
+ "minimum": 0,
3484
3817
  "maximum": 1,
3485
3818
  "type": "number",
3486
3819
  "format": "double"
3487
3820
  },
3488
- "slat_separation": {
3489
- "title": "Slat Separation",
3490
- "description": "The distance between the front of a slat and the back of the adjacent slat in meters.",
3491
- "default": 0.01875,
3492
- "exclusiveMinimum": 0,
3821
+ "visible_reflectance": {
3822
+ "title": "Visible Reflectance",
3823
+ "description": "A number for the visible reflectance of the construction.",
3824
+ "default": 0.2,
3825
+ "minimum": 0,
3493
3826
  "maximum": 1,
3494
3827
  "type": "number",
3495
3828
  "format": "double"
3496
3829
  },
3497
- "slat_thickness": {
3498
- "title": "Slat Thickness",
3499
- "description": "The distance between the faces of a slat in meters. The default value is 0.001.",
3500
- "default": 0.001,
3501
- "exclusiveMinimum": 0,
3502
- "maximum": 0.1,
3503
- "type": "number",
3504
- "format": "double"
3505
- },
3506
- "slat_angle": {
3507
- "title": "Slat Angle",
3508
- "description": "The angle (degrees) between the glazing outward normal and the slat outward normal where the outward normal points away from the front face of the slat (degrees). The default value is 45.",
3509
- "default": 45,
3510
- "minimum": 0,
3511
- "maximum": 180,
3512
- "type": "number",
3513
- "format": "double"
3830
+ "is_specular": {
3831
+ "title": "Is Specular",
3832
+ "description": "Boolean to note whether the reflection off the shade is diffuse (False) or specular (True). Set to True if the construction is representing a glass facade or a mirror material.",
3833
+ "default": false,
3834
+ "type": "boolean"
3835
+ }
3836
+ },
3837
+ "required": [
3838
+ "identifier"
3839
+ ],
3840
+ "additionalProperties": false
3841
+ },
3842
+ "ScheduleDay": {
3843
+ "title": "ScheduleDay",
3844
+ "description": "Used to describe the daily schedule for a single simulation day.",
3845
+ "type": "object",
3846
+ "properties": {
3847
+ "identifier": {
3848
+ "title": "Identifier",
3849
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
3850
+ "maxLength": 100,
3851
+ "minLength": 1,
3852
+ "type": "string"
3514
3853
  },
3515
- "slat_conductivity": {
3516
- "title": "Slat Conductivity",
3517
- "description": "The thermal conductivity of the slat in W/(m-K). Default value is 221.",
3518
- "default": 221,
3519
- "exclusiveMinimum": 0,
3520
- "type": "number",
3521
- "format": "double"
3854
+ "values": {
3855
+ "title": "Values",
3856
+ "description": "A list of floats or integers for the values of the schedule. The length of this list must match the length of the times list.",
3857
+ "type": "array",
3858
+ "items": {
3859
+ "type": "number",
3860
+ "format": "double"
3861
+ }
3522
3862
  },
3523
- "beam_solar_transmittance": {
3524
- "title": "Beam Solar Transmittance",
3525
- "description": "The beam solar transmittance of the slat, assumed to be independent of angle of incidence on the slat. Any transmitted beam radiation is assumed to be 100% diffuse (i.e., slats are translucent). The default value is 0.",
3526
- "default": 0,
3527
- "exclusiveMaximum": 1,
3528
- "minimum": 0,
3529
- "type": "number",
3530
- "format": "double"
3863
+ "display_name": {
3864
+ "title": "Display Name",
3865
+ "description": "Display name of the object with no character restrictions.",
3866
+ "type": "string"
3531
3867
  },
3532
- "beam_solar_reflectance": {
3533
- "title": "Beam Solar Reflectance",
3534
- "description": "The beam solar reflectance of the front side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.",
3535
- "default": 0.5,
3536
- "exclusiveMaximum": 1,
3537
- "minimum": 0,
3538
- "type": "number",
3539
- "format": "double"
3540
- },
3541
- "beam_solar_reflectance_back": {
3542
- "title": "Beam Solar Reflectance Back",
3543
- "description": "The beam solar reflectance of the back side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.",
3544
- "default": 0.5,
3545
- "exclusiveMaximum": 1,
3546
- "minimum": 0,
3547
- "type": "number",
3548
- "format": "double"
3549
- },
3550
- "diffuse_solar_transmittance": {
3551
- "title": "Diffuse Solar Transmittance",
3552
- "description": "The slat transmittance for hemisperically diffuse solar radiation. Default value is 0.",
3553
- "default": 0,
3554
- "exclusiveMaximum": 1,
3555
- "minimum": 0,
3556
- "type": "number",
3557
- "format": "double"
3558
- },
3559
- "diffuse_solar_reflectance": {
3560
- "title": "Diffuse Solar Reflectance",
3561
- "description": "The front-side slat reflectance for hemispherically diffuse solar radiation. Default value is 0.5.",
3562
- "default": 0.5,
3563
- "exclusiveMaximum": 1,
3564
- "minimum": 0,
3565
- "type": "number",
3566
- "format": "double"
3567
- },
3568
- "diffuse_solar_reflectance_back": {
3569
- "title": "Diffuse Solar Reflectance Back",
3570
- "description": "The back-side slat reflectance for hemispherically diffuse solar radiation. Default value is 0.5.",
3571
- "default": 0.5,
3572
- "exclusiveMaximum": 1,
3573
- "minimum": 0,
3574
- "type": "number",
3575
- "format": "double"
3576
- },
3577
- "beam_visible_transmittance": {
3578
- "title": "Beam Visible Transmittance",
3579
- "description": "The beam visible transmittance of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.",
3580
- "default": 0,
3581
- "exclusiveMaximum": 1,
3582
- "minimum": 0,
3583
- "type": "number",
3584
- "format": "double"
3585
- },
3586
- "beam_visible_reflectance": {
3587
- "title": "Beam Visible Reflectance",
3588
- "description": "The beam visible reflectance on the front side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.",
3589
- "default": 0.5,
3590
- "exclusiveMaximum": 1,
3591
- "minimum": 0,
3592
- "type": "number",
3593
- "format": "double"
3868
+ "type": {
3869
+ "title": "Type",
3870
+ "default": "ScheduleDay",
3871
+ "pattern": "^ScheduleDay$",
3872
+ "type": "string",
3873
+ "readOnly": true
3594
3874
  },
3595
- "beam_visible_reflectance_back": {
3596
- "title": "Beam Visible Reflectance Back",
3597
- "description": "The beam visible reflectance on the back side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.",
3598
- "default": 0.5,
3599
- "exclusiveMaximum": 1,
3600
- "minimum": 0,
3601
- "type": "number",
3602
- "format": "double"
3875
+ "times": {
3876
+ "title": "Times",
3877
+ "description": "A list of lists with each sub-list possesing 2 values for [hour, minute]. The length of the master list must match the length of the values list. Each time in the master list represents the time of day that the corresponding value begins to take effect. For example [(0,0), (9,0), (17,0)] in combination with the values [0, 1, 0] denotes a schedule value of 0 from 0:00 to 9:00, a value of 1 from 9:00 to 17:00 and 0 from 17:00 to the end of the day. Note that this representation of times as the \"time of beginning\" is a different convention than EnergyPlus, which uses \"time until\".",
3878
+ "default": [
3879
+ 0,
3880
+ 0
3881
+ ],
3882
+ "minItems": 2,
3883
+ "maxItems": 2,
3884
+ "type": "array",
3885
+ "items": {
3886
+ "type": "array",
3887
+ "items": {
3888
+ "type": "integer",
3889
+ "format": "int32"
3890
+ },
3891
+ "minItems": 2,
3892
+ "maxItems": 2
3893
+ }
3603
3894
  },
3604
- "diffuse_visible_transmittance": {
3605
- "title": "Diffuse Visible Transmittance",
3606
- "description": "The slat transmittance for hemispherically diffuse visible radiation. This value should equal \u201cSlat Beam Visible Transmittance.\u201d",
3607
- "default": 0,
3608
- "exclusiveMaximum": 1,
3609
- "minimum": 0,
3610
- "type": "number",
3611
- "format": "double"
3895
+ "interpolate": {
3896
+ "title": "Interpolate",
3897
+ "description": "Boolean to note whether values in between times should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corresponding to them.",
3898
+ "default": false,
3899
+ "type": "boolean"
3900
+ }
3901
+ },
3902
+ "required": [
3903
+ "identifier",
3904
+ "values"
3905
+ ],
3906
+ "additionalProperties": false
3907
+ },
3908
+ "ScheduleRuleAbridged": {
3909
+ "title": "ScheduleRuleAbridged",
3910
+ "description": "Schedule rule including a ScheduleDay and when it should be applied..",
3911
+ "type": "object",
3912
+ "properties": {
3913
+ "schedule_day": {
3914
+ "title": "Schedule Day",
3915
+ "description": "The identifier of a ScheduleDay object associated with this rule.",
3916
+ "maxLength": 100,
3917
+ "minLength": 1,
3918
+ "type": "string"
3612
3919
  },
3613
- "diffuse_visible_reflectance": {
3614
- "title": "Diffuse Visible Reflectance",
3615
- "description": "The front-side slat reflectance for hemispherically diffuse visible radiation. This value should equal \u201cFront Side Slat Beam Visible Reflectance.\u201d Default value is 0.5.",
3616
- "default": 0.5,
3617
- "exclusiveMaximum": 1,
3618
- "minimum": 0,
3619
- "type": "number",
3620
- "format": "double"
3920
+ "type": {
3921
+ "title": "Type",
3922
+ "default": "ScheduleRuleAbridged",
3923
+ "pattern": "^ScheduleRuleAbridged$",
3924
+ "type": "string",
3925
+ "readOnly": true
3621
3926
  },
3622
- "diffuse_visible_reflectance_back": {
3623
- "title": "Diffuse Visible Reflectance Back",
3624
- "description": "The back-side slat reflectance for hemispherically diffuse visible radiation. This value should equal \u201cBack Side Slat Beam Visible Reflectance. Default value is 0.5.\u201d",
3625
- "default": 0.5,
3626
- "exclusiveMaximum": 1,
3627
- "minimum": 0,
3628
- "type": "number",
3629
- "format": "double"
3927
+ "apply_sunday": {
3928
+ "title": "Apply Sunday",
3929
+ "description": "Boolean noting whether to apply schedule_day on Sundays.",
3930
+ "default": false,
3931
+ "type": "boolean"
3630
3932
  },
3631
- "infrared_transmittance": {
3632
- "title": "Infrared Transmittance",
3633
- "description": "The slat infrared hemispherical transmittance. It is zero for solid metallic, wooden or glass slats, but may be non-zero in some cases such as for thin plastic slats. The default value is 0.",
3634
- "default": 0,
3635
- "exclusiveMaximum": 1,
3636
- "minimum": 0,
3637
- "type": "number",
3638
- "format": "double"
3933
+ "apply_monday": {
3934
+ "title": "Apply Monday",
3935
+ "description": "Boolean noting whether to apply schedule_day on Mondays.",
3936
+ "default": false,
3937
+ "type": "boolean"
3639
3938
  },
3640
- "emissivity": {
3641
- "title": "Emissivity",
3642
- "description": "Front side hemispherical emissivity of the slat. Default is 0.9 for most materials. The default value is 0.9.",
3643
- "default": 0.9,
3644
- "exclusiveMaximum": 1,
3645
- "minimum": 0,
3646
- "type": "number",
3647
- "format": "double"
3939
+ "apply_tuesday": {
3940
+ "title": "Apply Tuesday",
3941
+ "description": "Boolean noting whether to apply schedule_day on Tuesdays.",
3942
+ "default": false,
3943
+ "type": "boolean"
3648
3944
  },
3649
- "emissivity_back": {
3650
- "title": "Emissivity Back",
3651
- "description": "Back side hemispherical emissivity of the slat. Default is 0.9 for most materials. The default value is 0.9.",
3652
- "default": 0.9,
3653
- "exclusiveMaximum": 1,
3654
- "minimum": 0,
3655
- "type": "number",
3656
- "format": "double"
3945
+ "apply_wednesday": {
3946
+ "title": "Apply Wednesday",
3947
+ "description": "Boolean noting whether to apply schedule_day on Wednesdays.",
3948
+ "default": false,
3949
+ "type": "boolean"
3657
3950
  },
3658
- "distance_to_glass": {
3659
- "title": "Distance To Glass",
3660
- "description": "The distance from the mid-plane of the blind to the adjacent glass in meters. The default value is 0.05.",
3661
- "default": 0.05,
3662
- "minimum": 0.01,
3663
- "maximum": 1,
3664
- "type": "number",
3665
- "format": "double"
3951
+ "apply_thursday": {
3952
+ "title": "Apply Thursday",
3953
+ "description": "Boolean noting whether to apply schedule_day on Thursdays.",
3954
+ "default": false,
3955
+ "type": "boolean"
3666
3956
  },
3667
- "top_opening_multiplier": {
3668
- "title": "Top Opening Multiplier",
3669
- "description": "The effective area for air flow at the top of the shade, divided by the horizontal area between glass and shade. The default value is 0.5",
3670
- "default": 0.5,
3671
- "minimum": 0,
3672
- "maximum": 1,
3673
- "type": "number",
3674
- "format": "double"
3957
+ "apply_friday": {
3958
+ "title": "Apply Friday",
3959
+ "description": "Boolean noting whether to apply schedule_day on Fridays.",
3960
+ "default": false,
3961
+ "type": "boolean"
3675
3962
  },
3676
- "bottom_opening_multiplier": {
3677
- "title": "Bottom Opening Multiplier",
3678
- "description": "The effective area for air flow at the bottom of the shade, divided by the horizontal area between glass and shade. The default value is 0.",
3679
- "default": 0.5,
3680
- "minimum": 0,
3681
- "maximum": 1,
3682
- "type": "number",
3683
- "format": "double"
3963
+ "apply_saturday": {
3964
+ "title": "Apply Saturday",
3965
+ "description": "Boolean noting whether to apply schedule_day on Saturdays.",
3966
+ "default": false,
3967
+ "type": "boolean"
3684
3968
  },
3685
- "left_opening_multiplier": {
3686
- "title": "Left Opening Multiplier",
3687
- "description": "The effective area for air flow at the left side of the shade, divided by the vertical area between glass and shade. The default value is 0.5.",
3688
- "default": 0.5,
3689
- "minimum": 0,
3690
- "maximum": 1,
3691
- "type": "number",
3692
- "format": "double"
3969
+ "start_date": {
3970
+ "title": "Start Date",
3971
+ "description": "A list of two integers for [month, day], representing the start date of the period over which the schedule_day will be applied.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).",
3972
+ "default": [
3973
+ 1,
3974
+ 1
3975
+ ],
3976
+ "type": "array",
3977
+ "items": {
3978
+ "type": "integer",
3979
+ "format": "int32"
3980
+ },
3981
+ "minItems": 2,
3982
+ "maxItems": 3
3693
3983
  },
3694
- "right_opening_multiplier": {
3695
- "title": "Right Opening Multiplier",
3696
- "description": "The effective area for air flow at the right side of the shade, divided by the vertical area between glass and shade. The default value is 0.5.",
3697
- "default": 0.5,
3698
- "minimum": 0,
3699
- "maximum": 1,
3700
- "type": "number",
3701
- "format": "double"
3984
+ "end_date": {
3985
+ "title": "End Date",
3986
+ "description": "A list of two integers for [month, day], representing the end date of the period over which the schedule_day will be applied.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).",
3987
+ "default": [
3988
+ 12,
3989
+ 31
3990
+ ],
3991
+ "type": "array",
3992
+ "items": {
3993
+ "type": "integer",
3994
+ "format": "int32"
3995
+ },
3996
+ "minItems": 2,
3997
+ "maxItems": 3
3702
3998
  }
3703
3999
  },
3704
4000
  "required": [
3705
- "identifier"
4001
+ "schedule_day"
3706
4002
  ],
3707
4003
  "additionalProperties": false
3708
4004
  },
3709
- "EnergyWindowMaterialGlazing": {
3710
- "title": "EnergyWindowMaterialGlazing",
3711
- "description": "Describe a single glass pane corresponding to a layer in a window construction.",
4005
+ "NoLimit": {
4006
+ "title": "NoLimit",
4007
+ "description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
4008
+ "type": "object",
4009
+ "properties": {
4010
+ "type": {
4011
+ "title": "Type",
4012
+ "default": "NoLimit",
4013
+ "pattern": "^NoLimit$",
4014
+ "type": "string",
4015
+ "readOnly": true
4016
+ }
4017
+ },
4018
+ "additionalProperties": false
4019
+ },
4020
+ "ScheduleTypeLimit": {
4021
+ "title": "ScheduleTypeLimit",
4022
+ "description": "Specifies the data types and limits for values contained in schedules.",
3712
4023
  "type": "object",
3713
4024
  "properties": {
3714
4025
  "identifier": {
@@ -3725,116 +4036,62 @@
3725
4036
  },
3726
4037
  "type": {
3727
4038
  "title": "Type",
3728
- "default": "EnergyWindowMaterialGlazing",
3729
- "pattern": "^EnergyWindowMaterialGlazing$",
4039
+ "default": "ScheduleTypeLimit",
4040
+ "pattern": "^ScheduleTypeLimit$",
3730
4041
  "type": "string",
3731
4042
  "readOnly": true
3732
4043
  },
3733
- "thickness": {
3734
- "title": "Thickness",
3735
- "description": "The surface-to-surface of the glass in meters. Default value is 0.003.",
3736
- "default": 0.003,
3737
- "exclusiveMinimum": 0,
3738
- "type": "number",
3739
- "format": "double"
3740
- },
3741
- "solar_transmittance": {
3742
- "title": "Solar Transmittance",
3743
- "description": "Transmittance of solar radiation through the glass at normal incidence. Default value is 0.85 for clear glass.",
3744
- "default": 0.85,
3745
- "minimum": 0,
3746
- "maximum": 1,
3747
- "type": "number",
3748
- "format": "double"
3749
- },
3750
- "solar_reflectance": {
3751
- "title": "Solar Reflectance",
3752
- "description": "Reflectance of solar radiation off of the front side of the glass at normal incidence, averaged over the solar spectrum. Default value is 0.075 for clear glass.",
3753
- "default": 0.075,
3754
- "minimum": 0,
3755
- "maximum": 1,
3756
- "type": "number",
3757
- "format": "double"
3758
- },
3759
- "solar_reflectance_back": {
3760
- "title": "Solar Reflectance Back",
3761
- "description": "Reflectance of solar radiation off of the back side of the glass at normal incidence, averaged over the solar spectrum.",
3762
- "type": "number",
3763
- "format": "double"
3764
- },
3765
- "visible_transmittance": {
3766
- "title": "Visible Transmittance",
3767
- "description": "Transmittance of visible light through the glass at normal incidence. Default value is 0.9 for clear glass.",
3768
- "default": 0.9,
3769
- "minimum": 0,
3770
- "maximum": 1,
3771
- "type": "number",
3772
- "format": "double"
3773
- },
3774
- "visible_reflectance": {
3775
- "title": "Visible Reflectance",
3776
- "description": "Reflectance of visible light off of the front side of the glass at normal incidence. Default value is 0.075 for clear glass.",
3777
- "default": 0.075,
3778
- "minimum": 0,
3779
- "maximum": 1,
3780
- "type": "number",
3781
- "format": "double"
3782
- },
3783
- "visible_reflectance_back": {
3784
- "title": "Visible Reflectance Back",
3785
- "description": "Reflectance of visible light off of the back side of the glass at normal incidence averaged over the solar spectrum and weighted by the response of the human eye.",
3786
- "minimum": 0,
3787
- "maximum": 1,
3788
- "type": "number",
3789
- "format": "double"
3790
- },
3791
- "infrared_transmittance": {
3792
- "title": "Infrared Transmittance",
3793
- "description": "Long-wave transmittance at normal incidence.",
3794
- "default": 0,
3795
- "minimum": 0,
3796
- "maximum": 1,
3797
- "type": "number",
3798
- "format": "double"
3799
- },
3800
- "emissivity": {
3801
- "title": "Emissivity",
3802
- "description": "Infrared hemispherical emissivity of the front (outward facing) side of the glass. Default value is 0.84, which is typical for clear glass without a low-e coating.",
3803
- "default": 0.84,
3804
- "minimum": 0,
3805
- "maximum": 1,
3806
- "type": "number",
3807
- "format": "double"
3808
- },
3809
- "emissivity_back": {
3810
- "title": "Emissivity Back",
3811
- "description": "Infrared hemispherical emissivity of the back (inward facing) side of the glass. Default value is 0.84, which is typical for clear glass without a low-e coating.",
3812
- "default": 0.84,
3813
- "minimum": 0,
3814
- "maximum": 1,
3815
- "type": "number",
3816
- "format": "double"
3817
- },
3818
- "conductivity": {
3819
- "title": "Conductivity",
3820
- "description": "Thermal conductivity of the glass in W/(m-K). Default value is 0.9, which is typical for clear glass without a low-e coating.",
3821
- "default": 0.9,
3822
- "exclusiveMinimum": 0,
3823
- "type": "number",
3824
- "format": "double"
4044
+ "lower_limit": {
4045
+ "title": "Lower Limit",
4046
+ "description": "Lower limit for the schedule type or NoLimit.",
4047
+ "default": {
4048
+ "type": "NoLimit"
4049
+ },
4050
+ "anyOf": [
4051
+ {
4052
+ "$ref": "#/components/schemas/NoLimit"
4053
+ },
4054
+ {
4055
+ "type": "number",
4056
+ "format": "double"
4057
+ }
4058
+ ]
3825
4059
  },
3826
- "dirt_correction": {
3827
- "title": "Dirt Correction",
3828
- "description": "Factor that corrects for the presence of dirt on the glass. A default value of 1 indicates the glass is clean.",
3829
- "default": 1,
3830
- "type": "number",
3831
- "format": "double"
4060
+ "upper_limit": {
4061
+ "title": "Upper Limit",
4062
+ "description": "Upper limit for the schedule type or NoLimit.",
4063
+ "default": {
4064
+ "type": "NoLimit"
4065
+ },
4066
+ "anyOf": [
4067
+ {
4068
+ "$ref": "#/components/schemas/NoLimit"
4069
+ },
4070
+ {
4071
+ "type": "number",
4072
+ "format": "double"
4073
+ }
4074
+ ]
3832
4075
  },
3833
- "solar_diffusing": {
3834
- "title": "Solar Diffusing",
3835
- "description": "Takes values True and False. If False (default), the beam solar radiation incident on the glass is transmitted as beam radiation with no diffuse component.If True, the beam solar radiation incident on the glass is transmitted as hemispherical diffuse radiation with no beam component.",
3836
- "default": false,
3837
- "type": "boolean"
4076
+ "numeric_type": {
4077
+ "allOf": [
4078
+ {
4079
+ "$ref": "#/components/schemas/ScheduleNumericType"
4080
+ }
4081
+ ],
4082
+ "title": "Numeric Type",
4083
+ "default": "Continuous",
4084
+ "type": "string"
4085
+ },
4086
+ "unit_type": {
4087
+ "allOf": [
4088
+ {
4089
+ "$ref": "#/components/schemas/ScheduleUnitType"
4090
+ }
4091
+ ],
4092
+ "title": "Unit Type",
4093
+ "default": "Dimensionless",
4094
+ "type": "string"
3838
4095
  }
3839
4096
  },
3840
4097
  "required": [
@@ -3842,9 +4099,9 @@
3842
4099
  ],
3843
4100
  "additionalProperties": false
3844
4101
  },
3845
- "EnergyWindowMaterialShade": {
3846
- "title": "EnergyWindowMaterialShade",
3847
- "description": "This object specifies the properties of window shade materials.",
4102
+ "ScheduleRuleset": {
4103
+ "title": "ScheduleRuleset",
4104
+ "description": "Used to define a schedule for a default day, further described by ScheduleRule.",
3848
4105
  "type": "object",
3849
4106
  "properties": {
3850
4107
  "identifier": {
@@ -3854,6 +4111,21 @@
3854
4111
  "minLength": 1,
3855
4112
  "type": "string"
3856
4113
  },
4114
+ "day_schedules": {
4115
+ "title": "Day Schedules",
4116
+ "description": "A list of ScheduleDays that are referenced in the other keys of this ScheduleRulesetAbridged.",
4117
+ "type": "array",
4118
+ "items": {
4119
+ "$ref": "#/components/schemas/ScheduleDay"
4120
+ }
4121
+ },
4122
+ "default_day_schedule": {
4123
+ "title": "Default Day Schedule",
4124
+ "description": "An identifier for the ScheduleDay that will be used for all days when no ScheduleRule is applied. This ScheduleDay must be in the day_schedules.",
4125
+ "maxLength": 100,
4126
+ "minLength": 1,
4127
+ "type": "string"
4128
+ },
3857
4129
  "display_name": {
3858
4130
  "title": "Display Name",
3859
4131
  "description": "Display name of the object with no character restrictions.",
@@ -3861,144 +4133,146 @@
3861
4133
  },
3862
4134
  "type": {
3863
4135
  "title": "Type",
3864
- "default": "EnergyWindowMaterialShade",
3865
- "pattern": "^EnergyWindowMaterialShade$",
4136
+ "default": "ScheduleRuleset",
4137
+ "pattern": "^ScheduleRuleset$",
3866
4138
  "type": "string",
3867
4139
  "readOnly": true
3868
4140
  },
3869
- "solar_transmittance": {
3870
- "title": "Solar Transmittance",
3871
- "description": "The transmittance averaged over the solar spectrum. It is assumed independent of incidence angle. Default value is 0.4.",
3872
- "default": 0.4,
3873
- "exclusiveMaximum": 1,
3874
- "minimum": 0,
3875
- "type": "number",
3876
- "format": "double"
3877
- },
3878
- "solar_reflectance": {
3879
- "title": "Solar Reflectance",
3880
- "description": "The reflectance averaged over the solar spectrum. It us assumed same on both sides of shade and independent of incidence angle. Default value is 0.5",
3881
- "default": 0.5,
3882
- "exclusiveMaximum": 1,
3883
- "minimum": 0,
3884
- "type": "number",
3885
- "format": "double"
3886
- },
3887
- "visible_transmittance": {
3888
- "title": "Visible Transmittance",
3889
- "description": "The transmittance averaged over the solar spectrum and weighted by the response of the human eye. It is assumed independent of incidence angle. Default value is 0.4.",
3890
- "default": 0.4,
3891
- "exclusiveMaximum": 1,
3892
- "minimum": 0,
3893
- "type": "number",
3894
- "format": "double"
3895
- },
3896
- "visible_reflectance": {
3897
- "title": "Visible Reflectance",
3898
- "description": "The transmittance averaged over the solar spectrum and weighted by the response of the human eye. It is assumed independent of incidence angle. Default value is 0.4",
3899
- "default": 0.4,
3900
- "exclusiveMaximum": 1,
3901
- "minimum": 0,
3902
- "type": "number",
3903
- "format": "double"
4141
+ "schedule_rules": {
4142
+ "title": "Schedule Rules",
4143
+ "description": "A list of ScheduleRuleAbridged that note exceptions to the default_day_schedule. These rules should be ordered from highest to lowest priority.",
4144
+ "type": "array",
4145
+ "items": {
4146
+ "$ref": "#/components/schemas/ScheduleRuleAbridged"
4147
+ }
3904
4148
  },
3905
- "emissivity": {
3906
- "title": "Emissivity",
3907
- "description": "The effective long-wave infrared hemispherical emissivity. It is assumed same on both sides of shade. Default value is 0.9.",
3908
- "default": 0.9,
3909
- "exclusiveMinimum": 0,
3910
- "exclusiveMaximum": 1,
3911
- "type": "number",
3912
- "format": "double"
4149
+ "holiday_schedule": {
4150
+ "title": "Holiday Schedule",
4151
+ "description": "An identifier for the ScheduleDay that will be used for holidays. This ScheduleDay must be in the day_schedules.",
4152
+ "maxLength": 100,
4153
+ "minLength": 1,
4154
+ "type": "string"
3913
4155
  },
3914
- "infrared_transmittance": {
3915
- "title": "Infrared Transmittance",
3916
- "description": "The effective long-wave transmittance. It is assumed independent of incidence angle. Default value is 0.",
3917
- "default": 0,
3918
- "exclusiveMaximum": 1,
3919
- "minimum": 0,
3920
- "type": "number",
3921
- "format": "double"
4156
+ "summer_designday_schedule": {
4157
+ "title": "Summer Designday Schedule",
4158
+ "description": "An identifier for the ScheduleDay that will be used for the summer design day. This ScheduleDay must be in the day_schedules.",
4159
+ "maxLength": 100,
4160
+ "minLength": 1,
4161
+ "type": "string"
3922
4162
  },
3923
- "thickness": {
3924
- "title": "Thickness",
3925
- "description": "The thickness of the shade material in meters. Default value is 0.005.",
3926
- "default": 0.005,
3927
- "exclusiveMinimum": 0,
3928
- "type": "number",
3929
- "format": "double"
4163
+ "winter_designday_schedule": {
4164
+ "title": "Winter Designday Schedule",
4165
+ "description": "An identifier for the ScheduleDay that will be used for the winter design day. This ScheduleDay must be in the day_schedules.",
4166
+ "maxLength": 100,
4167
+ "minLength": 1,
4168
+ "type": "string"
3930
4169
  },
3931
- "conductivity": {
3932
- "title": "Conductivity",
3933
- "description": "The conductivity of the shade material in W/(m-K). Default value is 0.1.",
3934
- "default": 0.1,
3935
- "exclusiveMinimum": 0,
3936
- "type": "number",
3937
- "format": "double"
4170
+ "schedule_type_limit": {
4171
+ "title": "Schedule Type Limit",
4172
+ "description": "ScheduleTypeLimit object that will be used to validate schedule values against upper/lower limits and assign units to the schedule values. If None, no validation will occur.",
4173
+ "allOf": [
4174
+ {
4175
+ "$ref": "#/components/schemas/ScheduleTypeLimit"
4176
+ }
4177
+ ]
4178
+ }
4179
+ },
4180
+ "required": [
4181
+ "identifier",
4182
+ "day_schedules",
4183
+ "default_day_schedule"
4184
+ ],
4185
+ "additionalProperties": false
4186
+ },
4187
+ "ScheduleFixedInterval": {
4188
+ "title": "ScheduleFixedInterval",
4189
+ "description": "Used to specify a start date and a list of values for a period of analysis.",
4190
+ "type": "object",
4191
+ "properties": {
4192
+ "identifier": {
4193
+ "title": "Identifier",
4194
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
4195
+ "maxLength": 100,
4196
+ "minLength": 1,
4197
+ "type": "string"
3938
4198
  },
3939
- "distance_to_glass": {
3940
- "title": "Distance To Glass",
3941
- "description": "The distance from shade to adjacent glass in meters. Default value is 0.05",
3942
- "default": 0.05,
3943
- "minimum": 0.001,
3944
- "maximum": 1,
3945
- "type": "number",
3946
- "format": "double"
4199
+ "values": {
4200
+ "title": "Values",
4201
+ "description": "A list of timeseries values occuring at each timestep over the course of the simulation.",
4202
+ "type": "array",
4203
+ "items": {
4204
+ "type": "number",
4205
+ "format": "double"
4206
+ },
4207
+ "minItems": 24,
4208
+ "maxItems": 527040
3947
4209
  },
3948
- "top_opening_multiplier": {
3949
- "title": "Top Opening Multiplier",
3950
- "description": "The effective area for air flow at the top of the shade, divided by the horizontal area between glass and shade. Default value is 0.5.",
3951
- "default": 0.5,
3952
- "minimum": 0,
3953
- "maximum": 1,
3954
- "type": "number",
3955
- "format": "double"
4210
+ "display_name": {
4211
+ "title": "Display Name",
4212
+ "description": "Display name of the object with no character restrictions.",
4213
+ "type": "string"
3956
4214
  },
3957
- "bottom_opening_multiplier": {
3958
- "title": "Bottom Opening Multiplier",
3959
- "description": "The effective area for air flow at the bottom of the shade, divided by the horizontal area between glass and shade. Default value is 0.5.",
3960
- "default": 0.5,
3961
- "minimum": 0,
3962
- "maximum": 1,
3963
- "type": "number",
3964
- "format": "double"
4215
+ "type": {
4216
+ "title": "Type",
4217
+ "default": "ScheduleFixedInterval",
4218
+ "pattern": "^ScheduleFixedInterval$",
4219
+ "type": "string",
4220
+ "readOnly": true
3965
4221
  },
3966
- "left_opening_multiplier": {
3967
- "title": "Left Opening Multiplier",
3968
- "description": "The effective area for air flow at the left side of the shade, divided by the vertical area between glass and shade. Default value is 0.5.",
3969
- "default": 0.5,
3970
- "minimum": 0,
3971
- "maximum": 1,
3972
- "type": "number",
3973
- "format": "double"
4222
+ "schedule_type_limit": {
4223
+ "title": "Schedule Type Limit",
4224
+ "description": "ScheduleTypeLimit object that will be used to validate schedule values against upper/lower limits and assign units to the schedule values. If None, no validation will occur.",
4225
+ "allOf": [
4226
+ {
4227
+ "$ref": "#/components/schemas/ScheduleTypeLimit"
4228
+ }
4229
+ ]
3974
4230
  },
3975
- "right_opening_multiplier": {
3976
- "title": "Right Opening Multiplier",
3977
- "description": "The effective area for air flow at the right side of the shade, divided by the vertical area between glass and shade. Default value is 0.5.",
3978
- "default": 0.5,
3979
- "minimum": 0,
3980
- "maximum": 1,
3981
- "type": "number",
3982
- "format": "double"
4231
+ "timestep": {
4232
+ "title": "Timestep",
4233
+ "description": "An integer for the number of steps per hour that the input values correspond to. For example, if each value represents 30 minutes, the timestep is 2. For 15 minutes, it is 4.",
4234
+ "default": 1,
4235
+ "type": "integer",
4236
+ "format": "int32"
3983
4237
  },
3984
- "airflow_permeability": {
3985
- "title": "Airflow Permeability",
3986
- "description": "The fraction of the shade surface that is open to air flow. If air cannot pass through the shade material, airflow_permeability = 0. Default value is 0.",
4238
+ "start_date": {
4239
+ "title": "Start Date",
4240
+ "description": "A list of two integers for [month, day], representing the start date when the schedule values begin to take effect.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).",
4241
+ "default": [
4242
+ 1,
4243
+ 1
4244
+ ],
4245
+ "type": "array",
4246
+ "items": {
4247
+ "type": "integer",
4248
+ "format": "int32"
4249
+ },
4250
+ "minItems": 2,
4251
+ "maxItems": 3
4252
+ },
4253
+ "placeholder_value": {
4254
+ "title": "Placeholder Value",
4255
+ "description": " A value that will be used for all times not covered by the input values. Typically, your simulation should not need to use this value if the input values completely cover the simulation period.",
3987
4256
  "default": 0,
3988
- "minimum": 0,
3989
- "maximum": 0.8,
3990
4257
  "type": "number",
3991
4258
  "format": "double"
4259
+ },
4260
+ "interpolate": {
4261
+ "title": "Interpolate",
4262
+ "description": "Boolean to note whether values in between intervals should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corresponding to them.",
4263
+ "default": false,
4264
+ "type": "boolean"
3992
4265
  }
3993
4266
  },
3994
4267
  "required": [
3995
- "identifier"
4268
+ "identifier",
4269
+ "values"
3996
4270
  ],
3997
4271
  "additionalProperties": false
3998
4272
  },
3999
- "WindowConstruction": {
4000
- "title": "WindowConstruction",
4001
- "description": "Construction for window objects (Aperture, Door).",
4273
+ "AirBoundaryConstruction": {
4274
+ "title": "AirBoundaryConstruction",
4275
+ "description": "Construction for Air Boundary objects.",
4002
4276
  "type": "object",
4003
4277
  "properties": {
4004
4278
  "identifier": {
@@ -4008,51 +4282,17 @@
4008
4282
  "minLength": 1,
4009
4283
  "type": "string"
4010
4284
  },
4011
- "layers": {
4012
- "title": "Layers",
4013
- "description": "List of strings for material identifiers. The order of the materials is from exterior to interior.",
4014
- "minLength": 1,
4015
- "maxLength": 100,
4016
- "type": "array",
4017
- "items": {
4018
- "type": "string",
4019
- "minLength": 1,
4020
- "maxLength": 100
4021
- },
4022
- "minItems": 1,
4023
- "maxItems": 8
4024
- },
4025
- "materials": {
4026
- "title": "Materials",
4027
- "description": "List of materials. The order of the materials is from outside to inside.",
4028
- "type": "array",
4029
- "items": {
4030
- "anyOf": [
4031
- {
4032
- "$ref": "#/components/schemas/EnergyWindowMaterialGas"
4033
- },
4034
- {
4035
- "$ref": "#/components/schemas/EnergyWindowMaterialGasCustom"
4036
- },
4037
- {
4038
- "$ref": "#/components/schemas/EnergyWindowMaterialGasMixture"
4039
- },
4040
- {
4041
- "$ref": "#/components/schemas/EnergyWindowMaterialSimpleGlazSys"
4042
- },
4043
- {
4044
- "$ref": "#/components/schemas/EnergyWindowMaterialBlind"
4045
- },
4046
- {
4047
- "$ref": "#/components/schemas/EnergyWindowMaterialGlazing"
4048
- },
4049
- {
4050
- "$ref": "#/components/schemas/EnergyWindowMaterialShade"
4051
- }
4052
- ]
4053
- },
4054
- "minItems": 1,
4055
- "maxItems": 8
4285
+ "air_mixing_schedule": {
4286
+ "title": "Air Mixing Schedule",
4287
+ "description": "A fractional schedule as a ScheduleRuleset or ScheduleFixedInterval for the air mixing schedule across the construction.",
4288
+ "anyOf": [
4289
+ {
4290
+ "$ref": "#/components/schemas/ScheduleRuleset"
4291
+ },
4292
+ {
4293
+ "$ref": "#/components/schemas/ScheduleFixedInterval"
4294
+ }
4295
+ ]
4056
4296
  },
4057
4297
  "display_name": {
4058
4298
  "title": "Display Name",
@@ -4061,177 +4301,112 @@
4061
4301
  },
4062
4302
  "type": {
4063
4303
  "title": "Type",
4064
- "default": "WindowConstruction",
4065
- "pattern": "^WindowConstruction$",
4304
+ "default": "AirBoundaryConstruction",
4305
+ "pattern": "^AirBoundaryConstruction$",
4066
4306
  "type": "string",
4067
4307
  "readOnly": true
4308
+ },
4309
+ "air_mixing_per_area": {
4310
+ "title": "Air Mixing Per Area",
4311
+ "description": "A positive number for the amount of air mixing between Rooms across the air boundary surface [m3/s-m2]. Default: 0.1 corresponds to average indoor air speeds of 0.1 m/s (roughly 20 fpm), which is typical of what would be induced by a HVAC system.",
4312
+ "default": 0.1,
4313
+ "minimum": 0,
4314
+ "type": "number",
4315
+ "format": "double"
4068
4316
  }
4069
4317
  },
4070
4318
  "required": [
4071
4319
  "identifier",
4072
- "layers",
4073
- "materials"
4320
+ "air_mixing_schedule"
4074
4321
  ],
4075
4322
  "additionalProperties": false
4076
4323
  },
4077
- "ApertureConstructionSet": {
4078
- "title": "ApertureConstructionSet",
4079
- "description": "A set of constructions for aperture assemblies.",
4324
+ "ConstructionSet": {
4325
+ "title": "ConstructionSet",
4326
+ "description": "A set of constructions for different surface types and boundary conditions.",
4080
4327
  "type": "object",
4081
4328
  "properties": {
4082
- "type": {
4083
- "title": "Type",
4084
- "default": "ApertureConstructionSet",
4085
- "pattern": "^ApertureConstructionSet$",
4086
- "type": "string",
4087
- "readOnly": true
4088
- },
4089
- "interior_construction": {
4090
- "title": "Interior Construction",
4091
- "description": "A WindowConstruction for apertures with an Outdoors boundary condition, False is_operable property, and a Wall face type for their parent face.",
4092
- "allOf": [
4093
- {
4094
- "$ref": "#/components/schemas/WindowConstruction"
4095
- }
4096
- ]
4097
- },
4098
- "window_construction": {
4099
- "title": "Window Construction",
4100
- "description": "A WindowConstruction for all apertures with a Surface boundary condition.",
4101
- "allOf": [
4102
- {
4103
- "$ref": "#/components/schemas/WindowConstruction"
4104
- }
4105
- ]
4329
+ "identifier": {
4330
+ "title": "Identifier",
4331
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
4332
+ "maxLength": 100,
4333
+ "minLength": 1,
4334
+ "type": "string"
4106
4335
  },
4107
- "skylight_construction": {
4108
- "title": "Skylight Construction",
4109
- "description": "A WindowConstruction for apertures with a Outdoors boundary condition, False is_operable property, and a RoofCeiling or Floor face type for their parent face.",
4110
- "allOf": [
4111
- {
4112
- "$ref": "#/components/schemas/WindowConstruction"
4113
- }
4114
- ]
4336
+ "display_name": {
4337
+ "title": "Display Name",
4338
+ "description": "Display name of the object with no character restrictions.",
4339
+ "type": "string"
4115
4340
  },
4116
- "operable_construction": {
4117
- "title": "Operable Construction",
4118
- "description": "A WindowConstruction for all apertures with an Outdoors boundary condition and True is_operable property..",
4119
- "allOf": [
4120
- {
4121
- "$ref": "#/components/schemas/WindowConstruction"
4122
- }
4123
- ]
4124
- }
4125
- },
4126
- "additionalProperties": false
4127
- },
4128
- "DoorConstructionSet": {
4129
- "title": "DoorConstructionSet",
4130
- "description": "A set of constructions for door assemblies.",
4131
- "type": "object",
4132
- "properties": {
4133
4341
  "type": {
4134
4342
  "title": "Type",
4135
- "default": "DoorConstructionSet",
4136
- "pattern": "^DoorConstructionSet$",
4343
+ "default": "ConstructionSet",
4344
+ "pattern": "^ConstructionSet$",
4137
4345
  "type": "string",
4138
4346
  "readOnly": true
4139
4347
  },
4140
- "interior_construction": {
4141
- "title": "Interior Construction",
4142
- "description": "An OpaqueConstruction for all opaque doors with a Surface boundary condition.",
4348
+ "wall_set": {
4349
+ "title": "Wall Set",
4350
+ "description": "A WallConstructionSet object for this ConstructionSet.",
4143
4351
  "allOf": [
4144
4352
  {
4145
- "$ref": "#/components/schemas/OpaqueConstruction"
4353
+ "$ref": "#/components/schemas/WallConstructionSet"
4146
4354
  }
4147
4355
  ]
4148
4356
  },
4149
- "exterior_construction": {
4150
- "title": "Exterior Construction",
4151
- "description": "An OpaqueConstruction for opaque doors with an Outdoors boundary condition and a Wall face type for their parent face.",
4357
+ "floor_set": {
4358
+ "title": "Floor Set",
4359
+ "description": "A FloorConstructionSet object for this ConstructionSet.",
4152
4360
  "allOf": [
4153
4361
  {
4154
- "$ref": "#/components/schemas/OpaqueConstruction"
4362
+ "$ref": "#/components/schemas/FloorConstructionSet"
4155
4363
  }
4156
4364
  ]
4157
4365
  },
4158
- "overhead_construction": {
4159
- "title": "Overhead Construction",
4160
- "description": "An OpaqueConstruction for opaque doors with an Outdoors boundary condition and a RoofCeiling or Floor type for their parent face.",
4366
+ "roof_ceiling_set": {
4367
+ "title": "Roof Ceiling Set",
4368
+ "description": "A RoofCeilingConstructionSet object for this ConstructionSet.",
4161
4369
  "allOf": [
4162
4370
  {
4163
- "$ref": "#/components/schemas/OpaqueConstruction"
4371
+ "$ref": "#/components/schemas/RoofCeilingConstructionSet"
4164
4372
  }
4165
4373
  ]
4166
4374
  },
4167
- "exterior_glass_construction": {
4168
- "title": "Exterior Glass Construction",
4169
- "description": "A WindowConstruction for all glass doors with an Outdoors boundary condition.",
4375
+ "aperture_set": {
4376
+ "title": "Aperture Set",
4377
+ "description": "A ApertureConstructionSet object for this ConstructionSet.",
4170
4378
  "allOf": [
4171
4379
  {
4172
- "$ref": "#/components/schemas/WindowConstruction"
4380
+ "$ref": "#/components/schemas/ApertureConstructionSet"
4173
4381
  }
4174
4382
  ]
4175
4383
  },
4176
- "interior_glass_construction": {
4177
- "title": "Interior Glass Construction",
4178
- "description": "A WindowConstruction for all glass doors with a Surface boundary condition.",
4384
+ "door_set": {
4385
+ "title": "Door Set",
4386
+ "description": "A DoorConstructionSet object for this ConstructionSet.",
4179
4387
  "allOf": [
4180
4388
  {
4181
- "$ref": "#/components/schemas/WindowConstruction"
4182
- }
4183
- ]
4184
- }
4185
- },
4186
- "additionalProperties": false
4187
- },
4188
- "ShadeConstruction": {
4189
- "title": "ShadeConstruction",
4190
- "description": "Construction for Shade objects.",
4191
- "type": "object",
4192
- "properties": {
4193
- "identifier": {
4194
- "title": "Identifier",
4195
- "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
4196
- "maxLength": 100,
4197
- "minLength": 1,
4198
- "type": "string"
4199
- },
4200
- "display_name": {
4201
- "title": "Display Name",
4202
- "description": "Display name of the object with no character restrictions.",
4203
- "type": "string"
4204
- },
4205
- "type": {
4206
- "title": "Type",
4207
- "default": "ShadeConstruction",
4208
- "pattern": "^ShadeConstruction$",
4209
- "type": "string",
4210
- "readOnly": true
4211
- },
4212
- "solar_reflectance": {
4213
- "title": "Solar Reflectance",
4214
- "description": " A number for the solar reflectance of the construction.",
4215
- "default": 0.2,
4216
- "minimum": 0,
4217
- "maximum": 1,
4218
- "type": "number",
4219
- "format": "double"
4389
+ "$ref": "#/components/schemas/DoorConstructionSet"
4390
+ }
4391
+ ]
4220
4392
  },
4221
- "visible_reflectance": {
4222
- "title": "Visible Reflectance",
4223
- "description": " A number for the visible reflectance of the construction.",
4224
- "default": 0.2,
4225
- "minimum": 0,
4226
- "maximum": 1,
4227
- "type": "number",
4228
- "format": "double"
4393
+ "shade_construction": {
4394
+ "title": "Shade Construction",
4395
+ "description": "A ShadeConstruction to set the reflectance properties of all outdoor shades of all objects to which this ConstructionSet is assigned.",
4396
+ "allOf": [
4397
+ {
4398
+ "$ref": "#/components/schemas/ShadeConstruction"
4399
+ }
4400
+ ]
4229
4401
  },
4230
- "is_specular": {
4231
- "title": "Is Specular",
4232
- "description": "Boolean to note whether the reflection off the shade is diffuse (False) or specular (True). Set to True if the construction is representing a glass facade or a mirror material.",
4233
- "default": false,
4234
- "type": "boolean"
4402
+ "air_boundary_construction": {
4403
+ "title": "Air Boundary Construction",
4404
+ "description": "An AirBoundaryConstruction to set the properties of Faces with an AirBoundary type.",
4405
+ "allOf": [
4406
+ {
4407
+ "$ref": "#/components/schemas/AirBoundaryConstruction"
4408
+ }
4409
+ ]
4235
4410
  }
4236
4411
  },
4237
4412
  "required": [
@@ -4239,9 +4414,9 @@
4239
4414
  ],
4240
4415
  "additionalProperties": false
4241
4416
  },
4242
- "ScheduleDay": {
4243
- "title": "ScheduleDay",
4244
- "description": "Used to describe the daily schedule for a single simulation day.",
4417
+ "OpaqueConstructionAbridged": {
4418
+ "title": "OpaqueConstructionAbridged",
4419
+ "description": "Construction for opaque objects (Face, Shade, Door).",
4245
4420
  "type": "object",
4246
4421
  "properties": {
4247
4422
  "identifier": {
@@ -4251,14 +4426,19 @@
4251
4426
  "minLength": 1,
4252
4427
  "type": "string"
4253
4428
  },
4254
- "values": {
4255
- "title": "Values",
4256
- "description": "A list of floats or integers for the values of the schedule. The length of this list must match the length of the times list.",
4429
+ "layers": {
4430
+ "title": "Layers",
4431
+ "description": "List of strings for opaque material identifiers. The order of the materials is from exterior to interior.",
4432
+ "minLength": 1,
4433
+ "maxLength": 100,
4257
4434
  "type": "array",
4258
4435
  "items": {
4259
- "type": "number",
4260
- "format": "double"
4261
- }
4436
+ "type": "string",
4437
+ "minLength": 1,
4438
+ "maxLength": 100
4439
+ },
4440
+ "minItems": 1,
4441
+ "maxItems": 10
4262
4442
  },
4263
4443
  "display_name": {
4264
4444
  "title": "Display Name",
@@ -4267,159 +4447,66 @@
4267
4447
  },
4268
4448
  "type": {
4269
4449
  "title": "Type",
4270
- "default": "ScheduleDay",
4271
- "pattern": "^ScheduleDay$",
4450
+ "default": "OpaqueConstructionAbridged",
4451
+ "pattern": "^OpaqueConstructionAbridged$",
4272
4452
  "type": "string",
4273
4453
  "readOnly": true
4274
- },
4275
- "times": {
4276
- "title": "Times",
4277
- "description": "A list of lists with each sub-list possesing 2 values for [hour, minute]. The length of the master list must match the length of the values list. Each time in the master list represents the time of day that the corresponding value begins to take effect. For example [(0,0), (9,0), (17,0)] in combination with the values [0, 1, 0] denotes a schedule value of 0 from 0:00 to 9:00, a value of 1 from 9:00 to 17:00 and 0 from 17:00 to the end of the day. Note that this representation of times as the \"time of beginning\" is a different convention than EnergyPlus, which uses \"time until\".",
4278
- "default": [
4279
- 0,
4280
- 0
4281
- ],
4282
- "minItems": 2,
4283
- "maxItems": 2,
4284
- "type": "array",
4285
- "items": {
4286
- "type": "array",
4287
- "items": {
4288
- "type": "integer",
4289
- "format": "int32"
4290
- },
4291
- "minItems": 2,
4292
- "maxItems": 2
4293
- }
4294
- },
4295
- "interpolate": {
4296
- "title": "Interpolate",
4297
- "description": "Boolean to note whether values in between times should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corrsponding to them.",
4298
- "default": false,
4299
- "type": "boolean"
4300
4454
  }
4301
4455
  },
4302
4456
  "required": [
4303
4457
  "identifier",
4304
- "values"
4458
+ "layers"
4305
4459
  ],
4306
4460
  "additionalProperties": false
4307
4461
  },
4308
- "ScheduleRuleAbridged": {
4309
- "title": "ScheduleRuleAbridged",
4310
- "description": "Schedule rule including a ScheduleDay and when it should be applied..",
4462
+ "WindowConstructionAbridged": {
4463
+ "title": "WindowConstructionAbridged",
4464
+ "description": "Construction for window objects (Aperture, Door).",
4311
4465
  "type": "object",
4312
4466
  "properties": {
4313
- "schedule_day": {
4314
- "title": "Schedule Day",
4315
- "description": "The identifier of a ScheduleDay object associated with this rule.",
4467
+ "identifier": {
4468
+ "title": "Identifier",
4469
+ "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
4316
4470
  "maxLength": 100,
4317
4471
  "minLength": 1,
4318
4472
  "type": "string"
4319
4473
  },
4320
- "type": {
4321
- "title": "Type",
4322
- "default": "ScheduleRuleAbridged",
4323
- "pattern": "^ScheduleRuleAbridged$",
4324
- "type": "string",
4325
- "readOnly": true
4326
- },
4327
- "apply_sunday": {
4328
- "title": "Apply Sunday",
4329
- "description": "Boolean noting whether to apply schedule_day on Sundays.",
4330
- "default": false,
4331
- "type": "boolean"
4332
- },
4333
- "apply_monday": {
4334
- "title": "Apply Monday",
4335
- "description": "Boolean noting whether to apply schedule_day on Mondays.",
4336
- "default": false,
4337
- "type": "boolean"
4338
- },
4339
- "apply_tuesday": {
4340
- "title": "Apply Tuesday",
4341
- "description": "Boolean noting whether to apply schedule_day on Tuesdays.",
4342
- "default": false,
4343
- "type": "boolean"
4344
- },
4345
- "apply_wednesday": {
4346
- "title": "Apply Wednesday",
4347
- "description": "Boolean noting whether to apply schedule_day on Wednesdays.",
4348
- "default": false,
4349
- "type": "boolean"
4350
- },
4351
- "apply_thursday": {
4352
- "title": "Apply Thursday",
4353
- "description": "Boolean noting whether to apply schedule_day on Thursdays.",
4354
- "default": false,
4355
- "type": "boolean"
4356
- },
4357
- "apply_friday": {
4358
- "title": "Apply Friday",
4359
- "description": "Boolean noting whether to apply schedule_day on Fridays.",
4360
- "default": false,
4361
- "type": "boolean"
4362
- },
4363
- "apply_saturday": {
4364
- "title": "Apply Saturday",
4365
- "description": "Boolean noting whether to apply schedule_day on Saturdays.",
4366
- "default": false,
4367
- "type": "boolean"
4368
- },
4369
- "start_date": {
4370
- "title": "Start Date",
4371
- "description": "A list of two integers for [month, day], representing the start date of the period over which the schedule_day will be applied.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).",
4372
- "default": [
4373
- 1,
4374
- 1
4375
- ],
4474
+ "layers": {
4475
+ "title": "Layers",
4476
+ "description": "List of strings for glazing or gas material identifiers. The order of the materials is from exterior to interior. If a SimpleGlazSys material is used, it must be the only material in the construction. For multi-layered constructions, adjacent glass layers must be separated by one and only one gas layer.",
4477
+ "minLength": 1,
4478
+ "maxLength": 100,
4376
4479
  "type": "array",
4377
4480
  "items": {
4378
- "type": "integer",
4379
- "format": "int32"
4481
+ "type": "string",
4482
+ "minLength": 1,
4483
+ "maxLength": 100
4380
4484
  },
4381
- "minItems": 2,
4382
- "maxItems": 3
4485
+ "minItems": 1,
4486
+ "maxItems": 8
4487
+ },
4488
+ "display_name": {
4489
+ "title": "Display Name",
4490
+ "description": "Display name of the object with no character restrictions.",
4491
+ "type": "string"
4383
4492
  },
4384
- "end_date": {
4385
- "title": "End Date",
4386
- "description": "A list of two integers for [month, day], representing the end date of the period over which the schedule_day will be applied.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).",
4387
- "default": [
4388
- 12,
4389
- 31
4390
- ],
4391
- "type": "array",
4392
- "items": {
4393
- "type": "integer",
4394
- "format": "int32"
4395
- },
4396
- "minItems": 2,
4397
- "maxItems": 3
4398
- }
4399
- },
4400
- "required": [
4401
- "schedule_day"
4402
- ],
4403
- "additionalProperties": false
4404
- },
4405
- "NoLimit": {
4406
- "title": "NoLimit",
4407
- "description": "Base class for all objects that are not extensible with additional keys.\n\nThis effectively includes all objects except for the Properties classes\nthat are assigned to geometry objects.",
4408
- "type": "object",
4409
- "properties": {
4410
4493
  "type": {
4411
4494
  "title": "Type",
4412
- "default": "NoLimit",
4413
- "pattern": "^NoLimit$",
4495
+ "default": "WindowConstructionAbridged",
4496
+ "pattern": "^WindowConstructionAbridged$",
4414
4497
  "type": "string",
4415
4498
  "readOnly": true
4416
4499
  }
4417
4500
  },
4501
+ "required": [
4502
+ "identifier",
4503
+ "layers"
4504
+ ],
4418
4505
  "additionalProperties": false
4419
4506
  },
4420
- "ScheduleTypeLimit": {
4421
- "title": "ScheduleTypeLimit",
4422
- "description": "Specifies the data types and limits for values contained in schedules.",
4507
+ "WindowConstructionShadeAbridged": {
4508
+ "title": "WindowConstructionShadeAbridged",
4509
+ "description": "Construction for window objects with an included shade layer.",
4423
4510
  "type": "object",
4424
4511
  "properties": {
4425
4512
  "identifier": {
@@ -4429,6 +4516,22 @@
4429
4516
  "minLength": 1,
4430
4517
  "type": "string"
4431
4518
  },
4519
+ "window_construction": {
4520
+ "title": "Window Construction",
4521
+ "description": "A WindowConstructionAbridged object that serves as the \"switched off\" version of the construction (aka. the \"bare construction\"). The shade_material and shade_location will be used to modify this starting construction.",
4522
+ "allOf": [
4523
+ {
4524
+ "$ref": "#/components/schemas/WindowConstructionAbridged"
4525
+ }
4526
+ ]
4527
+ },
4528
+ "shade_material": {
4529
+ "title": "Shade Material",
4530
+ "description": "Identifier of a An EnergyWindowMaterialShade or an EnergyWindowMaterialBlind that serves as the shading layer for this construction. This can also be an EnergyWindowMaterialGlazing, which will indicate that the WindowConstruction has a dynamically-controlled glass pane like an electrochromic window assembly.",
4531
+ "maxLength": 100,
4532
+ "minLength": 1,
4533
+ "type": "string"
4534
+ },
4432
4535
  "display_name": {
4433
4536
  "title": "Display Name",
4434
4537
  "description": "Display name of the object with no character restrictions.",
@@ -4436,72 +4539,65 @@
4436
4539
  },
4437
4540
  "type": {
4438
4541
  "title": "Type",
4439
- "default": "ScheduleTypeLimit",
4440
- "pattern": "^ScheduleTypeLimit$",
4542
+ "default": "WindowConstructionShadeAbridged",
4543
+ "pattern": "^WindowConstructionShadeAbridged$",
4441
4544
  "type": "string",
4442
4545
  "readOnly": true
4443
4546
  },
4444
- "lower_limit": {
4445
- "title": "Lower Limit",
4446
- "description": "Lower limit for the schedule type or NoLimit.",
4447
- "default": {
4448
- "type": "NoLimit"
4449
- },
4450
- "anyOf": [
4451
- {
4452
- "$ref": "#/components/schemas/NoLimit"
4453
- },
4454
- {
4455
- "type": "number",
4456
- "format": "double"
4457
- }
4458
- ]
4459
- },
4460
- "upper_limit": {
4461
- "title": "Upper Limit",
4462
- "description": "Upper limit for the schedule type or NoLimit.",
4463
- "default": {
4464
- "type": "NoLimit"
4465
- },
4466
- "anyOf": [
4467
- {
4468
- "$ref": "#/components/schemas/NoLimit"
4469
- },
4470
- {
4471
- "type": "number",
4472
- "format": "double"
4473
- }
4474
- ]
4475
- },
4476
- "numeric_type": {
4547
+ "shade_location": {
4477
4548
  "allOf": [
4478
4549
  {
4479
- "$ref": "#/components/schemas/ScheduleNumericType"
4550
+ "$ref": "#/components/schemas/ShadeLocation"
4480
4551
  }
4481
4552
  ],
4482
- "title": "Numeric Type",
4483
- "default": "Continuous",
4553
+ "title": "Shade Location",
4554
+ "description": "Text to indicate where in the window assembly the shade_material is located. Note that the WindowConstruction must have at least one gas gap to use the \"Between\" option. Also note that, for a WindowConstruction with more than one gas gap, the \"Between\" option defalts to using the inner gap as this is the only option that EnergyPlus supports.",
4555
+ "default": "Interior",
4484
4556
  "type": "string"
4485
4557
  },
4486
- "unit_type": {
4558
+ "control_type": {
4487
4559
  "allOf": [
4488
4560
  {
4489
- "$ref": "#/components/schemas/ScheduleUnitType"
4561
+ "$ref": "#/components/schemas/ControlType"
4490
4562
  }
4491
4563
  ],
4492
- "title": "Unit Type",
4493
- "default": "Dimensionless",
4564
+ "title": "Control Type",
4565
+ "description": "Text to indicate how the shading device is controlled, which determines when the shading is \u201con\u201d or \u201coff.\u201d",
4566
+ "default": "AlwaysOn",
4494
4567
  "type": "string"
4568
+ },
4569
+ "setpoint": {
4570
+ "title": "Setpoint",
4571
+ "description": "A number that corresponds to the specified control_type. This can be a value in (W/m2), (C) or (W) depending upon the control type.Note that this value cannot be None for any control type except \"AlwaysOn.\"",
4572
+ "type": "number",
4573
+ "format": "double"
4574
+ },
4575
+ "schedule": {
4576
+ "title": "Schedule",
4577
+ "description": "An optional schedule identifier to be applied on top of the control_type. If None, the control_type will govern all behavior of the construction.",
4578
+ "maxLength": 100,
4579
+ "minLength": 1,
4580
+ "type": "string",
4581
+ "anyOf": [
4582
+ {
4583
+ "$ref": "#/components/schemas/ScheduleRuleset"
4584
+ },
4585
+ {
4586
+ "$ref": "#/components/schemas/ScheduleFixedInterval"
4587
+ }
4588
+ ]
4495
4589
  }
4496
4590
  },
4497
4591
  "required": [
4498
- "identifier"
4592
+ "identifier",
4593
+ "window_construction",
4594
+ "shade_material"
4499
4595
  ],
4500
4596
  "additionalProperties": false
4501
4597
  },
4502
- "ScheduleRuleset": {
4503
- "title": "ScheduleRuleset",
4504
- "description": "Used to define a schedule for a default day, further described by ScheduleRule.",
4598
+ "AirBoundaryConstructionAbridged": {
4599
+ "title": "AirBoundaryConstructionAbridged",
4600
+ "description": "Construction for Air Boundary objects.",
4505
4601
  "type": "object",
4506
4602
  "properties": {
4507
4603
  "identifier": {
@@ -4511,17 +4607,9 @@
4511
4607
  "minLength": 1,
4512
4608
  "type": "string"
4513
4609
  },
4514
- "day_schedules": {
4515
- "title": "Day Schedules",
4516
- "description": "A list of ScheduleDays that are referenced in the other keys of this ScheduleRulesetAbridged.",
4517
- "type": "array",
4518
- "items": {
4519
- "$ref": "#/components/schemas/ScheduleDay"
4520
- }
4521
- },
4522
- "default_day_schedule": {
4523
- "title": "Default Day Schedule",
4524
- "description": "An identifier for the ScheduleDay that will be used for all days when no ScheduleRule is applied. This ScheduleDay must be in the day_schedules.",
4610
+ "air_mixing_schedule": {
4611
+ "title": "Air Mixing Schedule",
4612
+ "description": "Identifier of a fractional schedule for the air mixing schedule across the construction.",
4525
4613
  "maxLength": 100,
4526
4614
  "minLength": 1,
4527
4615
  "type": "string"
@@ -4533,60 +4621,29 @@
4533
4621
  },
4534
4622
  "type": {
4535
4623
  "title": "Type",
4536
- "default": "ScheduleRuleset",
4537
- "pattern": "^ScheduleRuleset$",
4624
+ "default": "AirBoundaryConstructionAbridged",
4625
+ "pattern": "^AirBoundaryConstructionAbridged$",
4538
4626
  "type": "string",
4539
4627
  "readOnly": true
4540
4628
  },
4541
- "schedule_rules": {
4542
- "title": "Schedule Rules",
4543
- "description": "A list of ScheduleRuleAbridged that note exceptions to the default_day_schedule. These rules should be ordered from highest to lowest priority.",
4544
- "type": "array",
4545
- "items": {
4546
- "$ref": "#/components/schemas/ScheduleRuleAbridged"
4547
- }
4548
- },
4549
- "holiday_schedule": {
4550
- "title": "Holiday Schedule",
4551
- "description": "An identifier for the ScheduleDay that will be used for holidays. This ScheduleDay must be in the day_schedules.",
4552
- "maxLength": 100,
4553
- "minLength": 1,
4554
- "type": "string"
4555
- },
4556
- "summer_designday_schedule": {
4557
- "title": "Summer Designday Schedule",
4558
- "description": "An identifier for the ScheduleDay that will be used for the summer design day. This ScheduleDay must be in the day_schedules.",
4559
- "maxLength": 100,
4560
- "minLength": 1,
4561
- "type": "string"
4562
- },
4563
- "winter_designday_schedule": {
4564
- "title": "Winter Designday Schedule",
4565
- "description": "An identifier for the ScheduleDay that will be used for the winter design day. This ScheduleDay must be in the day_schedules.",
4566
- "maxLength": 100,
4567
- "minLength": 1,
4568
- "type": "string"
4569
- },
4570
- "schedule_type_limit": {
4571
- "title": "Schedule Type Limit",
4572
- "description": "ScheduleTypeLimit object that will be used to validate schedule values against upper/lower limits and assign units to the schedule values. If None, no validation will occur.",
4573
- "allOf": [
4574
- {
4575
- "$ref": "#/components/schemas/ScheduleTypeLimit"
4576
- }
4577
- ]
4629
+ "air_mixing_per_area": {
4630
+ "title": "Air Mixing Per Area",
4631
+ "description": "A positive number for the amount of air mixing between Rooms across the air boundary surface [m3/s-m2]. Default: 0.1 corresponds to average indoor air speeds of 0.1 m/s (roughly 20 fpm), which is typical of what would be induced by a HVAC system.",
4632
+ "default": 0.1,
4633
+ "minimum": 0,
4634
+ "type": "number",
4635
+ "format": "double"
4578
4636
  }
4579
4637
  },
4580
4638
  "required": [
4581
4639
  "identifier",
4582
- "day_schedules",
4583
- "default_day_schedule"
4640
+ "air_mixing_schedule"
4584
4641
  ],
4585
4642
  "additionalProperties": false
4586
4643
  },
4587
- "ScheduleFixedInterval": {
4588
- "title": "ScheduleFixedInterval",
4589
- "description": "Used to specify a start date and a list of values for a period of analysis.",
4644
+ "EnergyWindowMaterialShade": {
4645
+ "title": "EnergyWindowMaterialShade",
4646
+ "description": "This object specifies the properties of window shade materials.",
4590
4647
  "type": "object",
4591
4648
  "properties": {
4592
4649
  "identifier": {
@@ -4596,17 +4653,6 @@
4596
4653
  "minLength": 1,
4597
4654
  "type": "string"
4598
4655
  },
4599
- "values": {
4600
- "title": "Values",
4601
- "description": "A list of timeseries values occuring at each timestep over the course of the simulation.",
4602
- "type": "array",
4603
- "items": {
4604
- "type": "number",
4605
- "format": "double"
4606
- },
4607
- "minItems": 24,
4608
- "maxItems": 527040
4609
- },
4610
4656
  "display_name": {
4611
4657
  "title": "Display Name",
4612
4658
  "description": "Display name of the object with no character restrictions.",
@@ -4614,65 +4660,144 @@
4614
4660
  },
4615
4661
  "type": {
4616
4662
  "title": "Type",
4617
- "default": "ScheduleFixedInterval",
4618
- "pattern": "^ScheduleFixedInterval$",
4663
+ "default": "EnergyWindowMaterialShade",
4664
+ "pattern": "^EnergyWindowMaterialShade$",
4619
4665
  "type": "string",
4620
4666
  "readOnly": true
4621
4667
  },
4622
- "schedule_type_limit": {
4623
- "title": "Schedule Type Limit",
4624
- "description": "ScheduleTypeLimit object that will be used to validate schedule values against upper/lower limits and assign units to the schedule values. If None, no validation will occur.",
4625
- "allOf": [
4626
- {
4627
- "$ref": "#/components/schemas/ScheduleTypeLimit"
4628
- }
4629
- ]
4668
+ "solar_transmittance": {
4669
+ "title": "Solar Transmittance",
4670
+ "description": "The transmittance averaged over the solar spectrum. It is assumed independent of incidence angle. Default value is 0.4.",
4671
+ "default": 0.4,
4672
+ "exclusiveMaximum": 1,
4673
+ "minimum": 0,
4674
+ "type": "number",
4675
+ "format": "double"
4630
4676
  },
4631
- "timestep": {
4632
- "title": "Timestep",
4633
- "description": "An integer for the number of steps per hour that the input values correspond to. For example, if each value represents 30 minutes, the timestep is 2. For 15 minutes, it is 4.",
4634
- "default": 1,
4635
- "type": "integer",
4636
- "format": "int32"
4677
+ "solar_reflectance": {
4678
+ "title": "Solar Reflectance",
4679
+ "description": "The reflectance averaged over the solar spectrum. It us assumed same on both sides of shade and independent of incidence angle. Default value is 0.5",
4680
+ "default": 0.5,
4681
+ "exclusiveMaximum": 1,
4682
+ "minimum": 0,
4683
+ "type": "number",
4684
+ "format": "double"
4637
4685
  },
4638
- "start_date": {
4639
- "title": "Start Date",
4640
- "description": "A list of two integers for [month, day], representing the start date when the schedule values begin to take effect.A third integer may be added to denote whether the date should be re-serialized for a leap year (it should be a 1 in this case).",
4641
- "default": [
4642
- 1,
4643
- 1
4644
- ],
4645
- "type": "array",
4646
- "items": {
4647
- "type": "integer",
4648
- "format": "int32"
4649
- },
4650
- "minItems": 2,
4651
- "maxItems": 3
4686
+ "visible_transmittance": {
4687
+ "title": "Visible Transmittance",
4688
+ "description": "The transmittance averaged over the solar spectrum and weighted by the response of the human eye. It is assumed independent of incidence angle. Default value is 0.4.",
4689
+ "default": 0.4,
4690
+ "exclusiveMaximum": 1,
4691
+ "minimum": 0,
4692
+ "type": "number",
4693
+ "format": "double"
4652
4694
  },
4653
- "placeholder_value": {
4654
- "title": "Placeholder Value",
4655
- "description": " A value that will be used for all times not covered by the input values. Typically, your simulation should not need to use this value if the input values completely cover the simulation period.",
4695
+ "visible_reflectance": {
4696
+ "title": "Visible Reflectance",
4697
+ "description": "The transmittance averaged over the solar spectrum and weighted by the response of the human eye. It is assumed independent of incidence angle. Default value is 0.4",
4698
+ "default": 0.4,
4699
+ "exclusiveMaximum": 1,
4700
+ "minimum": 0,
4701
+ "type": "number",
4702
+ "format": "double"
4703
+ },
4704
+ "emissivity": {
4705
+ "title": "Emissivity",
4706
+ "description": "The effective long-wave infrared hemispherical emissivity. It is assumed same on both sides of shade. Default value is 0.9.",
4707
+ "default": 0.9,
4708
+ "exclusiveMinimum": 0,
4709
+ "exclusiveMaximum": 1,
4710
+ "type": "number",
4711
+ "format": "double"
4712
+ },
4713
+ "infrared_transmittance": {
4714
+ "title": "Infrared Transmittance",
4715
+ "description": "The effective long-wave transmittance. It is assumed independent of incidence angle. Default value is 0.",
4656
4716
  "default": 0,
4717
+ "exclusiveMaximum": 1,
4718
+ "minimum": 0,
4719
+ "type": "number",
4720
+ "format": "double"
4721
+ },
4722
+ "thickness": {
4723
+ "title": "Thickness",
4724
+ "description": "The thickness of the shade material in meters. Default value is 0.005.",
4725
+ "default": 0.005,
4726
+ "exclusiveMinimum": 0,
4727
+ "type": "number",
4728
+ "format": "double"
4729
+ },
4730
+ "conductivity": {
4731
+ "title": "Conductivity",
4732
+ "description": "The conductivity of the shade material in W/(m-K). Default value is 0.1.",
4733
+ "default": 0.1,
4734
+ "exclusiveMinimum": 0,
4735
+ "type": "number",
4736
+ "format": "double"
4737
+ },
4738
+ "distance_to_glass": {
4739
+ "title": "Distance To Glass",
4740
+ "description": "The distance from shade to adjacent glass in meters. Default value is 0.05",
4741
+ "default": 0.05,
4742
+ "minimum": 0.001,
4743
+ "maximum": 1,
4744
+ "type": "number",
4745
+ "format": "double"
4746
+ },
4747
+ "top_opening_multiplier": {
4748
+ "title": "Top Opening Multiplier",
4749
+ "description": "The effective area for air flow at the top of the shade, divided by the horizontal area between glass and shade. Default value is 0.5.",
4750
+ "default": 0.5,
4751
+ "minimum": 0,
4752
+ "maximum": 1,
4753
+ "type": "number",
4754
+ "format": "double"
4755
+ },
4756
+ "bottom_opening_multiplier": {
4757
+ "title": "Bottom Opening Multiplier",
4758
+ "description": "The effective area for air flow at the bottom of the shade, divided by the horizontal area between glass and shade. Default value is 0.5.",
4759
+ "default": 0.5,
4760
+ "minimum": 0,
4761
+ "maximum": 1,
4762
+ "type": "number",
4763
+ "format": "double"
4764
+ },
4765
+ "left_opening_multiplier": {
4766
+ "title": "Left Opening Multiplier",
4767
+ "description": "The effective area for air flow at the left side of the shade, divided by the vertical area between glass and shade. Default value is 0.5.",
4768
+ "default": 0.5,
4769
+ "minimum": 0,
4770
+ "maximum": 1,
4771
+ "type": "number",
4772
+ "format": "double"
4773
+ },
4774
+ "right_opening_multiplier": {
4775
+ "title": "Right Opening Multiplier",
4776
+ "description": "The effective area for air flow at the right side of the shade, divided by the vertical area between glass and shade. Default value is 0.5.",
4777
+ "default": 0.5,
4778
+ "minimum": 0,
4779
+ "maximum": 1,
4657
4780
  "type": "number",
4658
4781
  "format": "double"
4659
4782
  },
4660
- "interpolate": {
4661
- "title": "Interpolate",
4662
- "description": "Boolean to note whether values in between intervals should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corrsponding to them.",
4663
- "default": false,
4664
- "type": "boolean"
4783
+ "airflow_permeability": {
4784
+ "title": "Airflow Permeability",
4785
+ "description": "The fraction of the shade surface that is open to air flow. If air cannot pass through the shade material, airflow_permeability = 0. Default value is 0.",
4786
+ "default": 0,
4787
+ "minimum": 0,
4788
+ "maximum": 0.8,
4789
+ "type": "number",
4790
+ "format": "double"
4665
4791
  }
4666
4792
  },
4667
4793
  "required": [
4668
- "identifier",
4669
- "values"
4794
+ "identifier"
4670
4795
  ],
4671
4796
  "additionalProperties": false
4672
4797
  },
4673
- "AirBoundaryConstruction": {
4674
- "title": "AirBoundaryConstruction",
4675
- "description": "Construction for Air Boundary objects.",
4798
+ "EnergyWindowMaterialBlind": {
4799
+ "title": "EnergyWindowMaterialBlind",
4800
+ "description": "Window blind material consisting of flat, equally-spaced slats.",
4676
4801
  "type": "object",
4677
4802
  "properties": {
4678
4803
  "identifier": {
@@ -4682,48 +4807,261 @@
4682
4807
  "minLength": 1,
4683
4808
  "type": "string"
4684
4809
  },
4685
- "air_mixing_schedule": {
4686
- "title": "Air Mixing Schedule",
4687
- "description": "A fractional schedule as a ScheduleRuleset or ScheduleFixedInterval for the air mixing schedule across the construction.",
4688
- "anyOf": [
4689
- {
4690
- "$ref": "#/components/schemas/ScheduleRuleset"
4691
- },
4692
- {
4693
- "$ref": "#/components/schemas/ScheduleFixedInterval"
4694
- }
4695
- ]
4696
- },
4697
4810
  "display_name": {
4698
4811
  "title": "Display Name",
4699
4812
  "description": "Display name of the object with no character restrictions.",
4700
4813
  "type": "string"
4701
4814
  },
4702
- "type": {
4703
- "title": "Type",
4704
- "default": "AirBoundaryConstruction",
4705
- "pattern": "^AirBoundaryConstruction$",
4706
- "type": "string",
4707
- "readOnly": true
4815
+ "type": {
4816
+ "title": "Type",
4817
+ "default": "EnergyWindowMaterialBlind",
4818
+ "pattern": "^EnergyWindowMaterialBlind$",
4819
+ "type": "string",
4820
+ "readOnly": true
4821
+ },
4822
+ "slat_orientation": {
4823
+ "allOf": [
4824
+ {
4825
+ "$ref": "#/components/schemas/SlatOrientation"
4826
+ }
4827
+ ],
4828
+ "title": "Slat Orientation",
4829
+ "default": "Horizontal",
4830
+ "type": "string"
4831
+ },
4832
+ "slat_width": {
4833
+ "title": "Slat Width",
4834
+ "description": "The width of slat measured from edge to edge in meters.",
4835
+ "default": 0.025,
4836
+ "exclusiveMinimum": 0,
4837
+ "maximum": 1,
4838
+ "type": "number",
4839
+ "format": "double"
4840
+ },
4841
+ "slat_separation": {
4842
+ "title": "Slat Separation",
4843
+ "description": "The distance between the front of a slat and the back of the adjacent slat in meters.",
4844
+ "default": 0.01875,
4845
+ "exclusiveMinimum": 0,
4846
+ "maximum": 1,
4847
+ "type": "number",
4848
+ "format": "double"
4849
+ },
4850
+ "slat_thickness": {
4851
+ "title": "Slat Thickness",
4852
+ "description": "The distance between the faces of a slat in meters. The default value is 0.001.",
4853
+ "default": 0.001,
4854
+ "exclusiveMinimum": 0,
4855
+ "maximum": 0.1,
4856
+ "type": "number",
4857
+ "format": "double"
4858
+ },
4859
+ "slat_angle": {
4860
+ "title": "Slat Angle",
4861
+ "description": "The angle (degrees) between the glazing outward normal and the slat outward normal where the outward normal points away from the front face of the slat (degrees). The default value is 45.",
4862
+ "default": 45,
4863
+ "minimum": 0,
4864
+ "maximum": 180,
4865
+ "type": "number",
4866
+ "format": "double"
4867
+ },
4868
+ "slat_conductivity": {
4869
+ "title": "Slat Conductivity",
4870
+ "description": "The thermal conductivity of the slat in W/(m-K). Default value is 221.",
4871
+ "default": 221,
4872
+ "exclusiveMinimum": 0,
4873
+ "type": "number",
4874
+ "format": "double"
4875
+ },
4876
+ "beam_solar_transmittance": {
4877
+ "title": "Beam Solar Transmittance",
4878
+ "description": "The beam solar transmittance of the slat, assumed to be independent of angle of incidence on the slat. Any transmitted beam radiation is assumed to be 100% diffuse (i.e., slats are translucent). The default value is 0.",
4879
+ "default": 0,
4880
+ "exclusiveMaximum": 1,
4881
+ "minimum": 0,
4882
+ "type": "number",
4883
+ "format": "double"
4884
+ },
4885
+ "beam_solar_reflectance": {
4886
+ "title": "Beam Solar Reflectance",
4887
+ "description": "The beam solar reflectance of the front side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.",
4888
+ "default": 0.5,
4889
+ "exclusiveMaximum": 1,
4890
+ "minimum": 0,
4891
+ "type": "number",
4892
+ "format": "double"
4893
+ },
4894
+ "beam_solar_reflectance_back": {
4895
+ "title": "Beam Solar Reflectance Back",
4896
+ "description": "The beam solar reflectance of the back side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.",
4897
+ "default": 0.5,
4898
+ "exclusiveMaximum": 1,
4899
+ "minimum": 0,
4900
+ "type": "number",
4901
+ "format": "double"
4902
+ },
4903
+ "diffuse_solar_transmittance": {
4904
+ "title": "Diffuse Solar Transmittance",
4905
+ "description": "The slat transmittance for hemisperically diffuse solar radiation. Default value is 0.",
4906
+ "default": 0,
4907
+ "exclusiveMaximum": 1,
4908
+ "minimum": 0,
4909
+ "type": "number",
4910
+ "format": "double"
4911
+ },
4912
+ "diffuse_solar_reflectance": {
4913
+ "title": "Diffuse Solar Reflectance",
4914
+ "description": "The front-side slat reflectance for hemispherically diffuse solar radiation. Default value is 0.5.",
4915
+ "default": 0.5,
4916
+ "exclusiveMaximum": 1,
4917
+ "minimum": 0,
4918
+ "type": "number",
4919
+ "format": "double"
4920
+ },
4921
+ "diffuse_solar_reflectance_back": {
4922
+ "title": "Diffuse Solar Reflectance Back",
4923
+ "description": "The back-side slat reflectance for hemispherically diffuse solar radiation. Default value is 0.5.",
4924
+ "default": 0.5,
4925
+ "exclusiveMaximum": 1,
4926
+ "minimum": 0,
4927
+ "type": "number",
4928
+ "format": "double"
4929
+ },
4930
+ "beam_visible_transmittance": {
4931
+ "title": "Beam Visible Transmittance",
4932
+ "description": "The beam visible transmittance of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.",
4933
+ "default": 0,
4934
+ "exclusiveMaximum": 1,
4935
+ "minimum": 0,
4936
+ "type": "number",
4937
+ "format": "double"
4938
+ },
4939
+ "beam_visible_reflectance": {
4940
+ "title": "Beam Visible Reflectance",
4941
+ "description": "The beam visible reflectance on the front side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.",
4942
+ "default": 0.5,
4943
+ "exclusiveMaximum": 1,
4944
+ "minimum": 0,
4945
+ "type": "number",
4946
+ "format": "double"
4947
+ },
4948
+ "beam_visible_reflectance_back": {
4949
+ "title": "Beam Visible Reflectance Back",
4950
+ "description": "The beam visible reflectance on the back side of the slat, it is assumed to be independent of the angle of incidence. Default value is 0.5.",
4951
+ "default": 0.5,
4952
+ "exclusiveMaximum": 1,
4953
+ "minimum": 0,
4954
+ "type": "number",
4955
+ "format": "double"
4956
+ },
4957
+ "diffuse_visible_transmittance": {
4958
+ "title": "Diffuse Visible Transmittance",
4959
+ "description": "The slat transmittance for hemispherically diffuse visible radiation. This value should equal \u201cSlat Beam Visible Transmittance.\u201d",
4960
+ "default": 0,
4961
+ "exclusiveMaximum": 1,
4962
+ "minimum": 0,
4963
+ "type": "number",
4964
+ "format": "double"
4965
+ },
4966
+ "diffuse_visible_reflectance": {
4967
+ "title": "Diffuse Visible Reflectance",
4968
+ "description": "The front-side slat reflectance for hemispherically diffuse visible radiation. This value should equal \u201cFront Side Slat Beam Visible Reflectance.\u201d Default value is 0.5.",
4969
+ "default": 0.5,
4970
+ "exclusiveMaximum": 1,
4971
+ "minimum": 0,
4972
+ "type": "number",
4973
+ "format": "double"
4974
+ },
4975
+ "diffuse_visible_reflectance_back": {
4976
+ "title": "Diffuse Visible Reflectance Back",
4977
+ "description": "The back-side slat reflectance for hemispherically diffuse visible radiation. This value should equal \u201cBack Side Slat Beam Visible Reflectance. Default value is 0.5.\u201d",
4978
+ "default": 0.5,
4979
+ "exclusiveMaximum": 1,
4980
+ "minimum": 0,
4981
+ "type": "number",
4982
+ "format": "double"
4983
+ },
4984
+ "infrared_transmittance": {
4985
+ "title": "Infrared Transmittance",
4986
+ "description": "The slat infrared hemispherical transmittance. It is zero for solid metallic, wooden or glass slats, but may be non-zero in some cases such as for thin plastic slats. The default value is 0.",
4987
+ "default": 0,
4988
+ "exclusiveMaximum": 1,
4989
+ "minimum": 0,
4990
+ "type": "number",
4991
+ "format": "double"
4992
+ },
4993
+ "emissivity": {
4994
+ "title": "Emissivity",
4995
+ "description": "Front side hemispherical emissivity of the slat. Default is 0.9 for most materials. The default value is 0.9.",
4996
+ "default": 0.9,
4997
+ "exclusiveMaximum": 1,
4998
+ "minimum": 0,
4999
+ "type": "number",
5000
+ "format": "double"
5001
+ },
5002
+ "emissivity_back": {
5003
+ "title": "Emissivity Back",
5004
+ "description": "Back side hemispherical emissivity of the slat. Default is 0.9 for most materials. The default value is 0.9.",
5005
+ "default": 0.9,
5006
+ "exclusiveMaximum": 1,
5007
+ "minimum": 0,
5008
+ "type": "number",
5009
+ "format": "double"
5010
+ },
5011
+ "distance_to_glass": {
5012
+ "title": "Distance To Glass",
5013
+ "description": "The distance from the mid-plane of the blind to the adjacent glass in meters. The default value is 0.05.",
5014
+ "default": 0.05,
5015
+ "minimum": 0.01,
5016
+ "maximum": 1,
5017
+ "type": "number",
5018
+ "format": "double"
5019
+ },
5020
+ "top_opening_multiplier": {
5021
+ "title": "Top Opening Multiplier",
5022
+ "description": "The effective area for air flow at the top of the shade, divided by the horizontal area between glass and shade. The default value is 0.5",
5023
+ "default": 0.5,
5024
+ "minimum": 0,
5025
+ "maximum": 1,
5026
+ "type": "number",
5027
+ "format": "double"
5028
+ },
5029
+ "bottom_opening_multiplier": {
5030
+ "title": "Bottom Opening Multiplier",
5031
+ "description": "The effective area for air flow at the bottom of the shade, divided by the horizontal area between glass and shade. The default value is 0.",
5032
+ "default": 0.5,
5033
+ "minimum": 0,
5034
+ "maximum": 1,
5035
+ "type": "number",
5036
+ "format": "double"
5037
+ },
5038
+ "left_opening_multiplier": {
5039
+ "title": "Left Opening Multiplier",
5040
+ "description": "The effective area for air flow at the left side of the shade, divided by the vertical area between glass and shade. The default value is 0.5.",
5041
+ "default": 0.5,
5042
+ "minimum": 0,
5043
+ "maximum": 1,
5044
+ "type": "number",
5045
+ "format": "double"
4708
5046
  },
4709
- "air_mixing_per_area": {
4710
- "title": "Air Mixing Per Area",
4711
- "description": "A positive number for the amount of air mixing between Rooms across the air boundary surface [m3/s-m2]. Default: 0.1 corresponds to average indoor air speeds of 0.1 m/s (roughly 20 fpm), which is typical of what would be induced by a HVAC system.",
4712
- "default": 0.1,
5047
+ "right_opening_multiplier": {
5048
+ "title": "Right Opening Multiplier",
5049
+ "description": "The effective area for air flow at the right side of the shade, divided by the vertical area between glass and shade. The default value is 0.5.",
5050
+ "default": 0.5,
4713
5051
  "minimum": 0,
5052
+ "maximum": 1,
4714
5053
  "type": "number",
4715
5054
  "format": "double"
4716
5055
  }
4717
5056
  },
4718
5057
  "required": [
4719
- "identifier",
4720
- "air_mixing_schedule"
5058
+ "identifier"
4721
5059
  ],
4722
5060
  "additionalProperties": false
4723
5061
  },
4724
- "ConstructionSet": {
4725
- "title": "ConstructionSet",
4726
- "description": "A set of constructions for different surface types and boundary conditions.",
5062
+ "WindowConstructionShade": {
5063
+ "title": "WindowConstructionShade",
5064
+ "description": "Construction for window objects (Aperture, Door).",
4727
5065
  "type": "object",
4728
5066
  "properties": {
4729
5067
  "identifier": {
@@ -4733,157 +5071,29 @@
4733
5071
  "minLength": 1,
4734
5072
  "type": "string"
4735
5073
  },
4736
- "display_name": {
4737
- "title": "Display Name",
4738
- "description": "Display name of the object with no character restrictions.",
4739
- "type": "string"
4740
- },
4741
- "type": {
4742
- "title": "Type",
4743
- "default": "ConstructionSet",
4744
- "pattern": "^ConstructionSet$",
4745
- "type": "string",
4746
- "readOnly": true
4747
- },
4748
- "wall_set": {
4749
- "title": "Wall Set",
4750
- "description": "A WallConstructionSet object for this ConstructionSet.",
4751
- "allOf": [
4752
- {
4753
- "$ref": "#/components/schemas/WallConstructionSet"
4754
- }
4755
- ]
4756
- },
4757
- "floor_set": {
4758
- "title": "Floor Set",
4759
- "description": "A FloorConstructionSet object for this ConstructionSet.",
4760
- "allOf": [
4761
- {
4762
- "$ref": "#/components/schemas/FloorConstructionSet"
4763
- }
4764
- ]
4765
- },
4766
- "roof_ceiling_set": {
4767
- "title": "Roof Ceiling Set",
4768
- "description": "A RoofCeilingConstructionSet object for this ConstructionSet.",
4769
- "allOf": [
4770
- {
4771
- "$ref": "#/components/schemas/RoofCeilingConstructionSet"
4772
- }
4773
- ]
4774
- },
4775
- "aperture_set": {
4776
- "title": "Aperture Set",
4777
- "description": "A ApertureConstructionSet object for this ConstructionSet.",
5074
+ "window_construction": {
5075
+ "title": "Window Construction",
5076
+ "description": "A WindowConstruction object that serves as the \"switched off\" version of the construction (aka. the \"bare construction\"). The shade_material and shade_location will be used to modify this starting construction.",
4778
5077
  "allOf": [
4779
5078
  {
4780
- "$ref": "#/components/schemas/ApertureConstructionSet"
5079
+ "$ref": "#/components/schemas/WindowConstruction"
4781
5080
  }
4782
5081
  ]
4783
5082
  },
4784
- "door_set": {
4785
- "title": "Door Set",
4786
- "description": "A DoorConstructionSet object for this ConstructionSet.",
4787
- "allOf": [
5083
+ "shade_material": {
5084
+ "title": "Shade Material",
5085
+ "description": "Identifier of a An EnergyWindowMaterialShade or an EnergyWindowMaterialBlind that serves as the shading layer for this construction. This can also be an EnergyWindowMaterialGlazing, which will indicate that the WindowConstruction has a dynamically-controlled glass pane like an electrochromic window assembly.",
5086
+ "anyOf": [
4788
5087
  {
4789
- "$ref": "#/components/schemas/DoorConstructionSet"
4790
- }
4791
- ]
4792
- },
4793
- "shade_construction": {
4794
- "title": "Shade Construction",
4795
- "description": "A ShadeConstruction to set the reflectance properties of all outdoor shades of all objects to which this ConstructionSet is assigned.",
4796
- "allOf": [
5088
+ "$ref": "#/components/schemas/EnergyWindowMaterialShade"
5089
+ },
4797
5090
  {
4798
- "$ref": "#/components/schemas/ShadeConstruction"
4799
- }
4800
- ]
4801
- },
4802
- "air_boundary_construction": {
4803
- "title": "Air Boundary Construction",
4804
- "description": "An AirBoundaryConstruction to set the properties of Faces with an AirBoundary type.",
4805
- "allOf": [
5091
+ "$ref": "#/components/schemas/EnergyWindowMaterialBlind"
5092
+ },
4806
5093
  {
4807
- "$ref": "#/components/schemas/AirBoundaryConstruction"
5094
+ "$ref": "#/components/schemas/EnergyWindowMaterialGlazing"
4808
5095
  }
4809
5096
  ]
4810
- }
4811
- },
4812
- "required": [
4813
- "identifier"
4814
- ],
4815
- "additionalProperties": false
4816
- },
4817
- "OpaqueConstructionAbridged": {
4818
- "title": "OpaqueConstructionAbridged",
4819
- "description": "Construction for opaque objects (Face, Shade, Door).",
4820
- "type": "object",
4821
- "properties": {
4822
- "identifier": {
4823
- "title": "Identifier",
4824
- "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
4825
- "maxLength": 100,
4826
- "minLength": 1,
4827
- "type": "string"
4828
- },
4829
- "layers": {
4830
- "title": "Layers",
4831
- "description": "List of strings for material identifiers. The order of the materials is from exterior to interior.",
4832
- "minLength": 1,
4833
- "maxLength": 100,
4834
- "type": "array",
4835
- "items": {
4836
- "type": "string",
4837
- "minLength": 1,
4838
- "maxLength": 100
4839
- },
4840
- "minItems": 1,
4841
- "maxItems": 10
4842
- },
4843
- "display_name": {
4844
- "title": "Display Name",
4845
- "description": "Display name of the object with no character restrictions.",
4846
- "type": "string"
4847
- },
4848
- "type": {
4849
- "title": "Type",
4850
- "default": "OpaqueConstructionAbridged",
4851
- "pattern": "^OpaqueConstructionAbridged$",
4852
- "type": "string",
4853
- "readOnly": true
4854
- }
4855
- },
4856
- "required": [
4857
- "identifier",
4858
- "layers"
4859
- ],
4860
- "additionalProperties": false
4861
- },
4862
- "WindowConstructionAbridged": {
4863
- "title": "WindowConstructionAbridged",
4864
- "description": "Construction for window objects (Aperture, Door).",
4865
- "type": "object",
4866
- "properties": {
4867
- "identifier": {
4868
- "title": "Identifier",
4869
- "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
4870
- "maxLength": 100,
4871
- "minLength": 1,
4872
- "type": "string"
4873
- },
4874
- "layers": {
4875
- "title": "Layers",
4876
- "description": "List of strings for material identifiers. The order of the materials is from exterior to interior.",
4877
- "minLength": 1,
4878
- "maxLength": 100,
4879
- "type": "array",
4880
- "items": {
4881
- "type": "string",
4882
- "minLength": 1,
4883
- "maxLength": 100
4884
- },
4885
- "minItems": 1,
4886
- "maxItems": 8
4887
5097
  },
4888
5098
  "display_name": {
4889
5099
  "title": "Display Name",
@@ -4892,61 +5102,56 @@
4892
5102
  },
4893
5103
  "type": {
4894
5104
  "title": "Type",
4895
- "default": "WindowConstructionAbridged",
4896
- "pattern": "^WindowConstructionAbridged$",
5105
+ "default": "WindowConstructionShade",
5106
+ "pattern": "^WindowConstructionShade$",
4897
5107
  "type": "string",
4898
5108
  "readOnly": true
4899
- }
4900
- },
4901
- "required": [
4902
- "identifier",
4903
- "layers"
4904
- ],
4905
- "additionalProperties": false
4906
- },
4907
- "AirBoundaryConstructionAbridged": {
4908
- "title": "AirBoundaryConstructionAbridged",
4909
- "description": "Construction for Air Boundary objects.",
4910
- "type": "object",
4911
- "properties": {
4912
- "identifier": {
4913
- "title": "Identifier",
4914
- "description": "Text string for a unique object ID. This identifier remains constant as the object is mutated, copied, and serialized to different formats (eg. dict, idf, osm). This identifier is also used to reference the object across a Model. It must be < 100 characters, use only ASCII characters and exclude (, ; ! \\n \\t).",
4915
- "maxLength": 100,
4916
- "minLength": 1,
4917
- "type": "string"
4918
5109
  },
4919
- "air_mixing_schedule": {
4920
- "title": "Air Mixing Schedule",
4921
- "description": "Identifier of a fractional schedule for the air mixing schedule across the construction.",
4922
- "maxLength": 100,
4923
- "minLength": 1,
5110
+ "shade_location": {
5111
+ "allOf": [
5112
+ {
5113
+ "$ref": "#/components/schemas/ShadeLocation"
5114
+ }
5115
+ ],
5116
+ "title": "Shade Location",
5117
+ "description": "Text to indicate where in the window assembly the shade_material is located. Note that the WindowConstruction must have at least one gas gap to use the \"Between\" option. Also note that, for a WindowConstruction with more than one gas gap, the \"Between\" option defalts to using the inner gap as this is the only option that EnergyPlus supports.",
5118
+ "default": "Interior",
4924
5119
  "type": "string"
4925
5120
  },
4926
- "display_name": {
4927
- "title": "Display Name",
4928
- "description": "Display name of the object with no character restrictions.",
5121
+ "control_type": {
5122
+ "allOf": [
5123
+ {
5124
+ "$ref": "#/components/schemas/ControlType"
5125
+ }
5126
+ ],
5127
+ "title": "Control Type",
5128
+ "description": "Text to indicate how the shading device is controlled, which determines when the shading is \u201con\u201d or \u201coff.\u201d",
5129
+ "default": "AlwaysOn",
4929
5130
  "type": "string"
4930
5131
  },
4931
- "type": {
4932
- "title": "Type",
4933
- "default": "AirBoundaryConstructionAbridged",
4934
- "pattern": "^AirBoundaryConstructionAbridged$",
4935
- "type": "string",
4936
- "readOnly": true
4937
- },
4938
- "air_mixing_per_area": {
4939
- "title": "Air Mixing Per Area",
4940
- "description": "A positive number for the amount of air mixing between Rooms across the air boundary surface [m3/s-m2]. Default: 0.1 corresponds to average indoor air speeds of 0.1 m/s (roughly 20 fpm), which is typical of what would be induced by a HVAC system.",
4941
- "default": 0.1,
4942
- "minimum": 0,
5132
+ "setpoint": {
5133
+ "title": "Setpoint",
5134
+ "description": "A number that corresponds to the specified control_type. This can be a value in (W/m2), (C) or (W) depending upon the control type.Note that this value cannot be None for any control type except \"AlwaysOn.\"",
4943
5135
  "type": "number",
4944
5136
  "format": "double"
5137
+ },
5138
+ "schedule": {
5139
+ "title": "Schedule",
5140
+ "description": "An optional ScheduleRuleset or ScheduleFixedInterval to be applied on top of the control_type. If None, the control_type will govern all behavior of the construction.",
5141
+ "anyOf": [
5142
+ {
5143
+ "$ref": "#/components/schemas/ScheduleRuleset"
5144
+ },
5145
+ {
5146
+ "$ref": "#/components/schemas/ScheduleFixedInterval"
5147
+ }
5148
+ ]
4945
5149
  }
4946
5150
  },
4947
5151
  "required": [
4948
5152
  "identifier",
4949
- "air_mixing_schedule"
5153
+ "window_construction",
5154
+ "shade_material"
4950
5155
  ],
4951
5156
  "additionalProperties": false
4952
5157
  },
@@ -5044,7 +5249,7 @@
5044
5249
  },
5045
5250
  "heating_limit": {
5046
5251
  "title": "Heating Limit",
5047
- "description": "A number for the maximum heating capacity in Watts. This can also be an Autosize object to indicate that the capacity should be determined during the EnergyPlus sizing calculation. This can also be a NoLimit boject to indicate no upper limit to the heating capacity.",
5252
+ "description": "A number for the maximum heating capacity in Watts. This can also be an Autosize object to indicate that the capacity should be determined during the EnergyPlus sizing calculation. This can also be a NoLimit object to indicate no upper limit to the heating capacity.",
5048
5253
  "default": {
5049
5254
  "type": "Autosize"
5050
5255
  },
@@ -5064,7 +5269,7 @@
5064
5269
  },
5065
5270
  "cooling_limit": {
5066
5271
  "title": "Cooling Limit",
5067
- "description": "A number for the maximum cooling capacity in Watts. This can also be an Autosize object to indicate that the capacity should be determined during the EnergyPlus sizing calculation. This can also be a NoLimit boject to indicate no upper limit to the cooling capacity.",
5272
+ "description": "A number for the maximum cooling capacity in Watts. This can also be an Autosize object to indicate that the capacity should be determined during the EnergyPlus sizing calculation. This can also be a NoLimit object to indicate no upper limit to the cooling capacity.",
5068
5273
  "default": {
5069
5274
  "type": "Autosize"
5070
5275
  },
@@ -5995,7 +6200,7 @@
5995
6200
  },
5996
6201
  "interpolate": {
5997
6202
  "title": "Interpolate",
5998
- "description": "Boolean to note whether values in between intervals should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corrsponding to them.",
6203
+ "description": "Boolean to note whether values in between intervals should be linearly interpolated or whether successive values should take effect immediately upon the beginning time corresponding to them.",
5999
6204
  "default": false,
6000
6205
  "type": "boolean"
6001
6206
  }
@@ -6053,7 +6258,7 @@
6053
6258
  "$ref": "#/components/schemas/WindowConstructionAbridged"
6054
6259
  },
6055
6260
  {
6056
- "$ref": "#/components/schemas/ShadeConstruction"
6261
+ "$ref": "#/components/schemas/WindowConstructionShadeAbridged"
6057
6262
  },
6058
6263
  {
6059
6264
  "$ref": "#/components/schemas/AirBoundaryConstructionAbridged"
@@ -6064,8 +6269,14 @@
6064
6269
  {
6065
6270
  "$ref": "#/components/schemas/WindowConstruction"
6066
6271
  },
6272
+ {
6273
+ "$ref": "#/components/schemas/WindowConstructionShade"
6274
+ },
6067
6275
  {
6068
6276
  "$ref": "#/components/schemas/AirBoundaryConstruction"
6277
+ },
6278
+ {
6279
+ "$ref": "#/components/schemas/ShadeConstruction"
6069
6280
  }
6070
6281
  ]
6071
6282
  }
@@ -8090,7 +8301,7 @@
8090
8301
  },
8091
8302
  "air_boundary_modifier": {
8092
8303
  "title": "Air Boundary Modifier",
8093
- "description": "An optional Modifier to be used for all Faces with an AirBoundary face type. If None, it will be the honyebee generic air wall modifier.",
8304
+ "description": "An optional Modifier to be used for all Faces with an AirBoundary face type. If None, it will be the honeybee generic air wall modifier.",
8094
8305
  "anyOf": [
8095
8306
  {
8096
8307
  "$ref": "#/components/schemas/Plastic"
@@ -8380,7 +8591,7 @@
8380
8591
  },
8381
8592
  "air_boundary_modifier": {
8382
8593
  "title": "Air Boundary Modifier",
8383
- "description": "Optional Modifier to be used for all Faces with an AirBoundary face type. If None, it will be the honyebee generic air wall modifier.",
8594
+ "description": "Optional Modifier to be used for all Faces with an AirBoundary face type. If None, it will be the honeybee generic air wall modifier.",
8384
8595
  "type": "string"
8385
8596
  }
8386
8597
  },
@@ -8571,15 +8782,17 @@
8571
8782
  },
8572
8783
  "tolerance": {
8573
8784
  "title": "Tolerance",
8574
- "description": "The maximum difference between x, y, and z values at which vertices are considered equivalent. This value should be in the Model units and it is used in a variety of checks, including checks for whether Room faces form a closed volume and subsequently correcting all face normals point outward from the Room. A value of 0 will result in no attempt to evaluate whether Room volumes are closed or check face direction. So it is recommended that this always be a positive number when such checks have not been performed on a Model. Typical tolerances for building geometry range from 0.1 to 0.0001 depending on the units of the geometry.",
8575
- "default": 0,
8785
+ "description": "The maximum difference between x, y, and z values at which vertices are considered equivalent. This value should be in the Model units and it is used in a variety of checks, including checks for whether Room faces form a closed volume and subsequently correcting all face normals point outward from the Room. A value of 0 will result in bypassing all checks so it is recommended that this always be a positive number when such checks have not already been performed on a Model. The default of 0.01 is suitable for models in meters.",
8786
+ "default": 0.01,
8787
+ "minimum": 0,
8576
8788
  "type": "number",
8577
8789
  "format": "double"
8578
8790
  },
8579
8791
  "angle_tolerance": {
8580
8792
  "title": "Angle Tolerance",
8581
- "description": "The max angle difference in degrees that vertices are allowed to differ from one another in order to consider them colinear. This value is used in a variety of checks, including checks for whether Room faces form a closed volume and subsequently correcting all face normals point outward from the Room. A value of 0 will result in no attempt to evaluate whether the Room volumes is closed or check face direction. So it is recommended that this always be a positive number when such checks have not been performed on a given Model. Typical tolerances for building geometry are often around 1 degree.",
8582
- "default": 0,
8793
+ "description": "The max angle difference in degrees that vertices are allowed to differ from one another in order to consider them colinear. This value is used in a variety of checks, including checks for whether Room faces form a closed volume and subsequently correcting all face normals point outward from the Room. A value of 0 will result in bypassing all checks so it is recommended that this always be a positive number when such checks have not already been performed on a given Model.",
8794
+ "default": 1.0,
8795
+ "minimum": 0,
8583
8796
  "type": "number",
8584
8797
  "format": "double"
8585
8798
  }
@@ -8686,6 +8899,34 @@
8686
8899
  "Mode"
8687
8900
  ],
8688
8901
  "type": "string"
8902
+ },
8903
+ "ShadeLocation": {
8904
+ "title": "Shade Location",
8905
+ "description": "Text to indicate where in the window assembly the shade_material is located. Note that the WindowConstruction must have at least one gas gap to use the \"Between\" option. Also note that, for a WindowConstruction with more than one gas gap, the \"Between\" option defalts to using the inner gap as this is the only option that EnergyPlus supports.",
8906
+ "default": "Interior",
8907
+ "enum": [
8908
+ "Interior",
8909
+ "Between",
8910
+ "Exterior"
8911
+ ],
8912
+ "type": "string"
8913
+ },
8914
+ "ControlType": {
8915
+ "title": "Control Type",
8916
+ "description": "Text to indicate how the shading device is controlled, which determines when the shading is \u201con\u201d or \u201coff.\u201d",
8917
+ "default": "AlwaysOn",
8918
+ "enum": [
8919
+ "AlwaysOn",
8920
+ "OnIfHighSolarOnWindow",
8921
+ "OnIfHighHorizontalSolar",
8922
+ "OnIfHighOutdoorAirTemperature",
8923
+ "OnIfHighZoneAirTemperature",
8924
+ "OnIfHighZoneCooling",
8925
+ "OnNightIfLowOutdoorTempAndOffDay",
8926
+ "OnNightIfLowInsideTempAndOffDay",
8927
+ "OnNightIfHeatingAndOffDay"
8928
+ ],
8929
+ "type": "string"
8689
8930
  }
8690
8931
  }
8691
8932
  }