honeybee-openstudio 2.31.14 → 2.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa0a8be909247d7b184dfa868ccd788e8a3ec63c4ae72c83c4645088457d7869
-  data.tar.gz: f047d5e5ede9ad6ef62979970fe26351adf22b7aadeb3fc189bd7ac2535ef135
+  metadata.gz: a1ff38871fe8372492211f52eef8aaa7b35f70dd3f8b86bf0a720ca793a171cd
+  data.tar.gz: 75d64bfd82c639cdc2e9effffdacbed361ebf0046d090f1736a1474327fadfc5
 SHA512:
-  metadata.gz: 22d507db51b816ac4787921b6aab068b9c0db3878ff70e6466b5a40cc3a00845c9a4b575479b833f42a7ddee90690d90b7cd5a7978509bf72889c28bd7c592ec
-  data.tar.gz: 3ffb6bfb6485d1c5dbb5462560787d19c8d32bc4fcbabd97870ccc6b6bde26a62d7cd4d67b8942590f164c232c1855ba7342beab73bc9e012fe01f21483cec90
+  metadata.gz: 1e56ee08a45f9774dde6621f41f40b5f7235b5742379471758132829cea4879cfbda9caffa0bc5cf1e7f6b56003c9d4401a9b8fc77b477ac65c90284b7f80fa3
+  data.tar.gz: 701ceb0b859d3a0090bcb2a84576e74ad55b219fa11365f5c4fa2ed1bb762b79ab7e13a9c1198f39281d73f400e7febd0f053e6696a63db573557d08e34d3cfe

data/honeybee-openstudio.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'honeybee-openstudio'
-  spec.version       = '2.31.14'
+  spec.version       = '2.33.0'
   spec.authors       = ['Tanushree Charan', 'Dan Macumber', 'Chris Mackey', 'Mostapha Sadeghipour Roudsari']
   spec.email         = ['tanushree.charan@nrel.gov', 'chris@ladybug.tools']
 

data/lib/from_openstudio/geometry/face.rb

@@ -125,6 +125,17 @@ module Honeybee
         result = {type: 'Ground'}
       elsif surface_bc == 'Adiabatic'
         result = {type: 'Adiabatic'}
+      elsif surface_bc == 'OtherSideCoefficients'
+        result = {type: 'OtherSideTemperature'}
+        unless surface.surfacePropertyOtherSideCoefficients.empty?
+          srf_prop = surface.surfacePropertyOtherSideCoefficients.get
+          if !srf_prop.isConstantTemperatureDefaulted
+            result[:temperature] = srf_prop.constantTemperature
+          end
+          unless srf_prop.combinedConvectiveRadiativeFilmCoefficient.empty?
+            result[:heat_transfer_coefficient] = srf_prop.combinedConvectiveRadiativeFilmCoefficient.get
+          end
+        end
       else
         sun_exposure = (surface.sunExposure == 'SunExposed')
         wind_exposure = (surface.windExposure == 'WindExposed')

data/lib/honeybee/_defaults/model.json

@@ -3,7 +3,7 @@
   "servers": [],
   "info": {
     "description": "Honeybee model schema.",
-    "version": "1.49.0",
+    "version": "1.50.5",
     "title": "Honeybee Model Schema",
     "contact": {
       "name": "Ladybug Tools",
@@ -214,6 +214,11 @@
       "x-displayName": "EnergyMaterialVegetation",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EnergyMaterialVegetation\" />\n"
     },
+    {
+      "name": "energywindowframe_model",
+      "x-displayName": "EnergyWindowFrame",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/EnergyWindowFrame\" />\n"
+    },
     {
       "name": "energywindowmaterialblind_model",
       "x-displayName": "EnergyWindowMaterialBlind",
@@ -494,6 +499,11 @@
       "x-displayName": "OpaqueConstructionAbridged",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/OpaqueConstructionAbridged\" />\n"
     },
+    {
+      "name": "othersidetemperature_model",
+      "x-displayName": "OtherSideTemperature",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/OtherSideTemperature\" />\n"
+    },
     {
       "name": "outdoors_model",
       "x-displayName": "Outdoors",
@@ -1007,6 +1017,7 @@
         "energymaterial_model",
         "energymaterialnomass_model",
         "energymaterialvegetation_model",
+        "energywindowframe_model",
         "energywindowmaterialblind_model",
         "energywindowmaterialgas_model",
         "energywindowmaterialgascustom_model",
@@ -1063,6 +1074,7 @@
         "nolimit_model",
         "opaqueconstruction_model",
         "opaqueconstructionabridged_model",
+        "othersidetemperature_model",
         "outdoors_model",
         "people_model",
         "peopleabridged_model",
@@ -1404,6 +1416,45 @@
         ],
         "additionalProperties": false
       },
+      "OtherSideTemperature": {
+        "title": "OtherSideTemperature",
+        "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.",
+        "type": "object",
+        "properties": {
+          "type": {
+            "title": "Type",
+            "default": "OtherSideTemperature",
+            "pattern": "^OtherSideTemperature$",
+            "type": "string",
+            "readOnly": true
+          },
+          "heat_transfer_coefficient": {
+            "title": "Heat Transfer Coefficient",
+            "description": "A value in W/m2-K to indicate the combined convective/radiative film coefficient. If equal to 0, then the specified temperature above is equal to the exterior surface temperature. Otherwise, the temperature above is considered the outside air temperature and this coefficient is used to determine the difference between this outside air temperature and the exterior surface temperature.",
+            "default": 0,
+            "minimum": 0,
+            "type": "number",
+            "format": "double"
+          },
+          "temperature": {
+            "title": "Temperature",
+            "description": "A temperature value in Celsius to note the temperature on the other side of the object. This input can also be an Autocalculate object to signify that the temperature is equal to the outdoor air temperature.",
+            "default": {
+              "type": "Autocalculate"
+            },
+            "anyOf": [
+              {
+                "$ref": "#/components/schemas/Autocalculate"
+              },
+              {
+                "type": "number",
+                "format": "double"
+              }
+            ]
+          }
+        },
+        "additionalProperties": false
+      },
       "ShadeEnergyPropertiesAbridged": {
         "title": "ShadeEnergyPropertiesAbridged",
         "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.",
@@ -1667,7 +1718,7 @@
           },
           "discharge_coefficient": {
             "title": "Discharge Coefficient",
-            "description": "A number that will be multipled by the area of the window in the stack (buoyancy-driven) part of the equation to account for additional friction from window geometry, insect screens, etc. Typical values include 0.45, for unobstructed windows WITH insect screens and 0.65 for unobstructed windows WITHOUT insect screens. This value should be lowered if windows are of an awning or casement type and are not allowed to fully open.",
+            "description": "A number that will be multiplied by the area of the window in the stack (buoyancy-driven) part of the equation to account for additional friction from window geometry, insect screens, etc. Typical values include 0.45, for unobstructed windows WITH insect screens and 0.65 for unobstructed windows WITHOUT insect screens. This value should be lowered if windows are of an awning or casement type and are not allowed to fully open.",
             "default": 0.45,
             "minimum": 0,
             "maximum": 1,
@@ -2263,6 +2314,9 @@
               },
               {
                 "$ref": "#/components/schemas/Surface"
+              },
+              {
+                "$ref": "#/components/schemas/OtherSideTemperature"
               }
             ]
           },
@@ -3517,7 +3571,7 @@
           },
           "multiplier": {
             "title": "Multiplier",
-            "description": "An integer noting how many times this Room is repeated. Multipliers are used to speed up the calculation when similar Rooms are repeated more than once. Essentially, a given simulation with the Room is run once and then the result is mutliplied by the multiplier.",
+            "description": "An integer noting how many times this Room is repeated. Multipliers are used to speed up the calculation when similar Rooms are repeated more than once. Essentially, a given simulation with the Room is run once and then the result is multiplied by the multiplier.",
             "default": 1,
             "minimum": 1,
             "type": "integer",
@@ -3902,7 +3956,7 @@
           },
           "solar_diffusing": {
             "title": "Solar Diffusing",
-            "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.",
+            "description": "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.",
             "default": false,
             "type": "boolean"
           }
@@ -4065,6 +4119,13 @@
             "pattern": "^WindowConstructionAbridged$",
             "type": "string",
             "readOnly": true
+          },
+          "frame": {
+            "title": "Frame",
+            "description": "An optional identifier for a frame material that surrounds the window construction.",
+            "maxLength": 100,
+            "minLength": 1,
+            "type": "string"
           }
         },
         "required": [
@@ -4655,7 +4716,8 @@
                 "type": "WindowConstructionAbridged",
                 "materials": [
                   "Generic Clear Glass"
-                ]
+                ],
+                "frame": null
               },
               {
                 "identifier": "Generic Shade",
@@ -4788,7 +4850,8 @@
                   "Generic Low-e Glass",
                   "Generic Window Air Gap",
                   "Generic Clear Glass"
-                ]
+                ],
+                "frame": null
               },
               {
                 "identifier": "Generic Exterior Door",
@@ -5407,7 +5470,7 @@
           },
           "u_factor": {
             "title": "U Factor",
-            "description": "The overall heat transfer coefficient for window system in W/m2-K. Note that constructions with U-values above 5.8 cannot be assigned to skylights without EnergyPlus thorwing an error.",
+            "description": "The overall heat transfer coefficient for window system in W/m2-K. Note that constructions with U-values above 5.8 should not be assigned to skylights as this implies the resistance of the window is negative when air films are subtracted.",
             "exclusiveMinimum": 0,
             "maximum": 12,
             "type": "number",
@@ -5415,7 +5478,7 @@
           },
           "shgc": {
             "title": "Shgc",
-            "description": "Unitless quantity for the Solar Heat Gain Coefficient (solar transmittance + conduction) at normal incidence and vertical orientation.",
+            "description": "Unit-less quantity for the Solar Heat Gain Coefficient (solar transmittance + conduction) at normal incidence and vertical orientation.",
             "exclusiveMinimum": 0,
             "exclusiveMaximum": 1,
             "type": "number",
@@ -5649,6 +5712,113 @@
         ],
         "additionalProperties": false
       },
+      "EnergyWindowFrame": {
+        "title": "EnergyWindowFrame",
+        "description": "Opaque material representing a layer within an opaque construction.",
+        "type": "object",
+        "properties": {
+          "identifier": {
+            "title": "Identifier",
+            "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).",
+            "maxLength": 100,
+            "minLength": 1,
+            "pattern": "^[^,;!\\n\\t]+$",
+            "type": "string"
+          },
+          "width": {
+            "title": "Width",
+            "description": "Number for the width of frame in plane of window [m]. The frame width is assumed to be the same on all sides of window..",
+            "exclusiveMinimum": 0,
+            "maximum": 1,
+            "type": "number",
+            "format": "double"
+          },
+          "conductance": {
+            "title": "Conductance",
+            "description": "Number for the thermal conductance of the frame material measured from inside to outside of the frame surface (no air films) and taking 2D conduction effects into account [W/m2-K].",
+            "exclusiveMinimum": 0,
+            "type": "number",
+            "format": "double"
+          },
+          "display_name": {
+            "title": "Display Name",
+            "description": "Display name of the object with no character restrictions.",
+            "type": "string"
+          },
+          "user_data": {
+            "title": "User Data",
+            "description": "Optional dictionary of user data associated with the object.All keys and values of this dictionary should be of a standard data type to ensure correct serialization of the object (eg. str, float, int, list).",
+            "type": "object"
+          },
+          "type": {
+            "title": "Type",
+            "default": "EnergyWindowFrame",
+            "pattern": "^EnergyWindowFrame$",
+            "type": "string",
+            "readOnly": true
+          },
+          "edge_to_center_ratio": {
+            "title": "Edge To Center Ratio",
+            "description": "Number between 0 and 4 for the ratio of the glass conductance near the frame (excluding air films) divided by the glass conductance at the center of the glazing (excluding air films). This is used only for multi-pane glazing constructions. This ratio should usually be greater than 1.0 since the spacer material that separates the glass panes is usually more conductive than the gap between panes. A value of 1 effectively indicates no spacer. Values should usually be obtained from the LBNL WINDOW program so that the unique characteristics of the window construction can be accounted for.",
+            "default": 1,
+            "exclusiveMinimum": 0,
+            "maximum": 4,
+            "type": "number",
+            "format": "double"
+          },
+          "outside_projection": {
+            "title": "Outside Projection",
+            "description": "Number for the distance that the frame projects outward from the outside face of the glazing [m]. This is used to calculate shadowing of frame onto glass, solar absorbed by the frame, IR emitted and absorbed by the frame, and convection from frame.",
+            "default": 0,
+            "minimum": 0,
+            "maximum": 0.5,
+            "type": "number",
+            "format": "double"
+          },
+          "inside_projection": {
+            "title": "Inside Projection",
+            "description": "Number for the distance that the frame projects inward from the inside face of the glazing [m]. This is used to calculate solar absorbed by the frame, IR emitted and absorbed by the frame, and convection from frame.",
+            "default": 0,
+            "minimum": 0,
+            "maximum": 0.5,
+            "type": "number",
+            "format": "double"
+          },
+          "thermal_absorptance": {
+            "title": "Thermal Absorptance",
+            "description": "Fraction of incident long wavelength radiation that is absorbed by the frame material.",
+            "default": 0.9,
+            "exclusiveMinimum": 0,
+            "maximum": 0.99999,
+            "type": "number",
+            "format": "double"
+          },
+          "solar_absorptance": {
+            "title": "Solar Absorptance",
+            "description": "Fraction of incident solar radiation absorbed by the frame material.",
+            "default": 0.7,
+            "minimum": 0,
+            "maximum": 1,
+            "type": "number",
+            "format": "double"
+          },
+          "visible_absorptance": {
+            "title": "Visible Absorptance",
+            "description": "Fraction of incident visible wavelength radiation absorbed by the frame material.",
+            "default": 0.7,
+            "minimum": 0,
+            "maximum": 1,
+            "type": "number",
+            "format": "double"
+          }
+        },
+        "required": [
+          "identifier",
+          "width",
+          "conductance"
+        ],
+        "additionalProperties": false
+      },
       "WindowConstruction": {
         "title": "WindowConstruction",
         "description": "Construction for window objects (Aperture, Door).",
@@ -5704,6 +5874,15 @@
             "pattern": "^WindowConstruction$",
             "type": "string",
             "readOnly": true
+          },
+          "frame": {
+            "title": "Frame",
+            "description": "An optional window frame material for the frame that surrounds the window construction.",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/EnergyWindowFrame"
+              }
+            ]
           }
         },
         "required": [
@@ -5992,7 +6171,7 @@
           },
           "diffuse_solar_transmittance": {
             "title": "Diffuse Solar Transmittance",
-            "description": "The slat transmittance for hemisperically diffuse solar radiation. Default: 0.",
+            "description": "The slat transmittance for hemispherically diffuse solar radiation. Default: 0.",
             "default": 0,
             "exclusiveMaximum": 1,
             "minimum": 0,
@@ -6109,7 +6288,7 @@
           },
           "top_opening_multiplier": {
             "title": "Top Opening Multiplier",
-            "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",
+            "description": "The effective area for air flow at the top of the shade, divided by the horizontal area between glass and shade.",
             "default": 0.5,
             "minimum": 0,
             "maximum": 1,
@@ -6118,7 +6297,7 @@
           },
           "bottom_opening_multiplier": {
             "title": "Bottom Opening Multiplier",
-            "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.",
+            "description": "The effective area for air flow at the bottom of the shade, divided by the horizontal area between glass and shade.",
             "default": 0.5,
             "minimum": 0,
             "maximum": 1,
@@ -6127,7 +6306,7 @@
           },
           "left_opening_multiplier": {
             "title": "Left Opening Multiplier",
-            "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.",
+            "description": "The effective area for air flow at the left side of the shade, divided by the vertical area between glass and shade.",
             "default": 0.5,
             "minimum": 0,
             "maximum": 1,
@@ -6136,7 +6315,7 @@
           },
           "right_opening_multiplier": {
             "title": "Right Opening Multiplier",
-            "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.",
+            "description": "The effective area for air flow at the right side of the shade, divided by the vertical area between glass and shade.",
             "default": 0.5,
             "minimum": 0,
             "maximum": 1,
@@ -6699,7 +6878,7 @@
             "readOnly": true
           },
           "shade_location": {
-            "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.",
+            "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 defaults to using the inner gap as this is the only option that EnergyPlus supports.",
             "default": "Interior",
             "allOf": [
               {
@@ -7152,7 +7331,7 @@
             "readOnly": true
           },
           "shade_location": {
-            "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.",
+            "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 defaults to using the inner gap as this is the only option that EnergyPlus supports.",
             "default": "Interior",
             "allOf": [
               {
@@ -8249,7 +8428,8 @@
           "Floor",
           "Ceiling",
           "FloorWithCarpet",
-          "CeilingMetalPanel"
+          "CeilingMetalPanel",
+          "FloorWithHardwood"
         ],
         "type": "string"
       },
@@ -10515,7 +10695,8 @@
                   "type": "WindowConstructionAbridged",
                   "materials": [
                     "Generic Clear Glass"
-                  ]
+                  ],
+                  "frame": null
                 },
                 {
                   "identifier": "Generic Shade",
@@ -10648,7 +10829,8 @@
                     "Generic Low-e Glass",
                     "Generic Window Air Gap",
                     "Generic Clear Glass"
-                  ]
+                  ],
+                  "frame": null
                 },
                 {
                   "identifier": "Generic Exterior Door",
@@ -10792,6 +10974,9 @@
                 {
                   "$ref": "#/components/schemas/EnergyWindowMaterialGasCustom"
                 },
+                {
+                  "$ref": "#/components/schemas/EnergyWindowFrame"
+                },
                 {
                   "$ref": "#/components/schemas/EnergyWindowMaterialBlind"
                 },
@@ -13468,12 +13653,12 @@
       },
       "Color": {
         "title": "Color",
-        "description": "A mesh in 3D space.",
+        "description": "A RGB color.",
         "type": "object",
         "properties": {
           "r": {
             "title": "R",
-            "description": "Integer for red value.",
+            "description": "Value for red channel.",
             "minimum": 0,
             "maximum": 255,
             "type": "integer",
@@ -13481,7 +13666,7 @@
           },
           "g": {
             "title": "G",
-            "description": "Integer for green value.",
+            "description": "Value for green channel.",
             "minimum": 0,
             "maximum": 255,
             "type": "integer",
@@ -13489,7 +13674,7 @@
           },
           "b": {
             "title": "B",
-            "description": "Integer for blue value.",
+            "description": "Value for blue channel.",
             "minimum": 0,
             "maximum": 255,
             "type": "integer",
@@ -13501,6 +13686,15 @@
             "pattern": "^Color$",
             "type": "string",
             "readOnly": true
+          },
+          "a": {
+            "title": "A",
+            "description": "Value for the alpha channel, which defines the opacity as a number between 0 (fully transparent) and 255 (fully opaque).",
+            "default": 255,
+            "minimum": 0,
+            "maximum": 255,
+            "type": "integer",
+            "format": "int32"
           }
         },
         "required": [
@@ -13539,6 +13733,7 @@
               "type": "array",
               "items": {
                 "type": "integer",
+                "minimum": 0,
                 "format": "int32"
               },
               "minItems": 3,
@@ -14098,7 +14293,7 @@
           "version": {
             "title": "Version",
             "description": "Text string for the current version of the schema.",
-            "default": "1.49.0",
+            "default": "1.50.5",
             "pattern": "([0-9]+)\\.([0-9]+)\\.([0-9]+)",
             "type": "string",
             "readOnly": true

data/lib/honeybee/material/frame.rb

@@ -0,0 +1,42 @@
+# *******************************************************************************
+# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
+# Energy, LLC, Ladybug Tools LLC and other contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *******************************************************************************
+
+require 'honeybee/model_object'
+
+module Honeybee
+  class EnergyWindowFrame < ModelObject
+
+    def defaults
+      @@schema[:components][:schemas][:EnergyWindowFrame][:properties]
+    end
+
+  end # EnergyWindowFrame
+end # Honeybee

data/lib/honeybee.rb

@@ -61,13 +61,14 @@ require 'honeybee/construction/air'
 require 'honeybee/material/opaque'
 require 'honeybee/material/opaque_no_mass'
 require 'honeybee/material/vegetation'
+require 'honeybee/material/window_simpleglazsys'
+require 'honeybee/material/window_glazing'
+require 'honeybee/material/frame'
 require 'honeybee/material/window_gas'
 require 'honeybee/material/window_gas_mixture'
 require 'honeybee/material/window_gas_custom'
 require 'honeybee/material/window_blind'
-require 'honeybee/material/window_glazing'
 require 'honeybee/material/window_shade'
-require 'honeybee/material/window_simpleglazsys'
 
 # import the load objects
 require 'honeybee/load/people'

data/lib/to_openstudio/geometry/aperture.rb

@@ -118,15 +118,25 @@ module Honeybee
         end
 
         # assign the construction if it exists
-        if @hash[:properties].key?(:energy) && @hash[:properties][:energy][:construction]
-          construction_identifier = @hash[:properties][:energy][:construction]
-          construction = openstudio_model.getConstructionByName(construction_identifier)
-          if !construction.empty?
-            os_construction = construction.get
-            os_subsurface.setConstruction(os_construction)
-          elsif $window_dynamic_hash[construction_identifier] != nil
-            os_construction = $window_dynamic_hash[construction_identifier].constructions[0]
-            os_subsurface.setConstruction(os_construction)
+        if @hash[:properties].key?(:energy)
+          if @hash[:properties][:energy][:construction]
+            construction_identifier = @hash[:properties][:energy][:construction]
+            construction = openstudio_model.getConstructionByName(construction_identifier)
+            if !construction.empty?
+              os_construction = construction.get
+              os_subsurface.setConstruction(os_construction)
+            elsif $window_dynamic_hash[construction_identifier] != nil
+              os_construction = $window_dynamic_hash[construction_identifier].constructions[0]
+              os_subsurface.setConstruction(os_construction)
+            end
+          end
+          if @hash[:properties][:energy][:frame]
+            frame_identifier = @hash[:properties][:energy][:frame]
+            frame = openstudio_model.getWindowPropertyFrameAndDividerByName(frame_identifier)
+            unless frame.empty?
+              os_frame = frame.get
+              os_subsurface.setWindowPropertyFrameAndDivider(os_frame)
+            end
           end
         end
 

data/lib/to_openstudio/geometry/door.rb

@@ -118,15 +118,25 @@ module Honeybee
         end
 
         # assign the construction if it exists
-        if @hash[:properties].key?(:energy) && @hash[:properties][:energy][:construction]
-          construction_identifier = @hash[:properties][:energy][:construction]
-          construction = openstudio_model.getConstructionByName(construction_identifier)
-          if !construction.empty?
-            os_construction = construction.get
-            os_subsurface.setConstruction(os_construction)
-          elsif $window_dynamic_hash[construction_identifier] != nil
-            os_construction = $window_dynamic_hash[construction_identifier].constructions[0]
-            os_subsurface.setConstruction(os_construction)
+        if @hash[:properties].key?(:energy)
+          if @hash[:properties][:energy][:construction]
+            construction_identifier = @hash[:properties][:energy][:construction]
+            construction = openstudio_model.getConstructionByName(construction_identifier)
+            if !construction.empty?
+              os_construction = construction.get
+              os_subsurface.setConstruction(os_construction)
+            elsif $window_dynamic_hash[construction_identifier] != nil
+              os_construction = $window_dynamic_hash[construction_identifier].constructions[0]
+              os_subsurface.setConstruction(os_construction)
+            end
+          end
+          if @hash[:properties][:energy][:frame]
+            frame_identifier = @hash[:properties][:energy][:frame]
+            frame = openstudio_model.getWindowPropertyFrameAndDividerByName(frame_identifier)
+            unless frame.empty?
+              os_frame = frame.get
+              os_subsurface.setWindowPropertyFrameAndDivider(os_frame)
+            end
           end
         end
 

data/lib/to_openstudio/geometry/face.rb

@@ -103,7 +103,7 @@ module Honeybee
       end
 
       # assign the boundary condition
-      boundary_condition = (@hash[:boundary_condition][:type])
+      boundary_condition = @hash[:boundary_condition][:type]
       case boundary_condition
       when 'Outdoors'
         if @hash[:boundary_condition][:sun_exposure] == false
@@ -129,9 +129,28 @@ module Honeybee
           surface = surface_object.get
           os_surface.setAdjacentSurface(surface)
         end
+      when 'OtherSideTemperature'
+        srf_prop = OpenStudio::Model::SurfacePropertyOtherSideCoefficients.new(openstudio_model)
+        srf_prop.setName(@hash[:identifier] + '_OtherTemp')
+        if @hash[:boundary_condition][:heat_transfer_coefficient].is_a? Numeric
+          srf_prop.setCombinedConvectiveRadiativeFilmCoefficient(
+            @hash[:boundary_condition][:heat_transfer_coefficient])
+        else
+          srf_prop.setCombinedConvectiveRadiativeFilmCoefficient(0)
+        end
+        if @hash[:boundary_condition][:temperature].is_a? Numeric
+          srf_prop.setConstantTemperature(@hash[:boundary_condition][:temperature])
+          srf_prop.setConstantTemperatureCoefficient(1)
+          srf_prop.setExternalDryBulbTemperatureCoefficient(0)
+        else
+          srf_prop.setConstantTemperatureCoefficient(0)
+          srf_prop.setExternalDryBulbTemperatureCoefficient(1)
+        end
+        os_surface.setSurfacePropertyOtherSideCoefficients(srf_prop)
       end
-      unless @hash[:boundary_condition][:type] == 'Surface'
-        os_surface.setOutsideBoundaryCondition(@hash[:boundary_condition][:type])
+
+      unless boundary_condition == 'Surface' || boundary_condition == 'OtherSideTemperature'
+        os_surface.setOutsideBoundaryCondition(boundary_condition)
       end
 
       # assign apertures if they exist

data/lib/to_openstudio/geometry/room.rb

@@ -211,6 +211,11 @@ module Honeybee
                 os_surface.setConstruction(interior_construction)
               end
             end
+          elsif face[:boundary_condition][:type] == 'OtherSideTemperature'
+            interior_construction = closest_interior_construction(openstudio_model, os_space, face[:face_type])
+            unless interior_construction.nil?
+              os_surface.setConstruction(interior_construction)
+            end
           end
         end
 

data/lib/to_openstudio/material/frame.rb

@@ -0,0 +1,102 @@
+# *******************************************************************************
+# Honeybee OpenStudio Gem, Copyright (c) 2020, Alliance for Sustainable
+# Energy, LLC, Ladybug Tools LLC and other contributors. All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# (1) Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# (2) Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# (3) Neither the name of the copyright holder nor the names of any contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission from the respective party.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) AND ANY CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER(S), ANY CONTRIBUTORS, THE
+# UNITED STATES GOVERNMENT, OR THE UNITED STATES DEPARTMENT OF ENERGY, NOR ANY OF
+# THEIR EMPLOYEES, BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+# OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+# STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# *******************************************************************************
+
+require 'honeybee/material/frame'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class EnergyWindowFrame < ModelObject
+
+    def find_existing_openstudio_object(openstudio_model)
+      object = openstudio_model.getWindowPropertyFrameAndDividerByName(@hash[:identifier])
+      return object.get if object.is_initialized
+      nil
+    end
+
+    def to_openstudio(openstudio_model)
+      # create frame OpenStudio material
+      os_frame_mat = OpenStudio::Model::WindowPropertyFrameAndDivider.new(openstudio_model)
+      os_frame_mat.setName(@hash[:identifier])
+      unless @hash[:display_name].nil?
+        os_frame_mat.setDisplayName(@hash[:display_name])
+      end
+      os_frame_mat.setFrameWidth(@hash[:width])
+      os_frame_mat.setFrameConductance(@hash[:conductance])
+
+      # assign edge_to_center_ratio if it exists
+      if @hash[:edge_to_center_ratio]
+        os_frame_mat.setRatioOfFrameEdgeGlassConductanceToCenterOfGlassConductance(
+            @hash[:edge_to_center_ratio])
+      else
+        os_frame_mat.setRatioOfFrameEdgeGlassConductanceToCenterOfGlassConductance(
+            defaults[:edge_to_center_ratio][:default])
+      end
+
+      # assign outside_projection if it exists
+      if @hash[:outside_projection]
+        os_frame_mat.setFrameOutsideProjection(@hash[:outside_projection])
+      else
+        os_frame_mat.setFrameOutsideProjection(defaults[:outside_projection][:default])
+      end
+
+      # assign inside_projection if it exists
+      if @hash[:inside_projection]
+        os_frame_mat.setFrameInsideProjection(@hash[:inside_projection])
+      else
+        os_frame_mat.setFrameInsideProjection(defaults[:inside_projection][:default])
+      end
+
+      # assign thermal absorptance if it exists
+      if @hash[:thermal_absorptance]
+        os_frame_mat.setFrameThermalHemisphericalEmissivity(@hash[:thermal_absorptance])
+      else
+        os_frame_mat.setFrameThermalHemisphericalEmissivity(defaults[:thermal_absorptance][:default])
+      end
+
+      # assign solar absorptance if it exists
+      if @hash[:solar_absorptance]
+        os_frame_mat.setFrameSolarAbsorptance(@hash[:solar_absorptance])
+      else
+        os_frame_mat.setFrameSolarAbsorptance(defaults[:solar_absorptance][:default])
+      end
+
+      # assign visible absorptance if it exists
+      if @hash[:visible_absorptance]
+        os_frame_mat.setFrameVisibleAbsorptance(@hash[:visible_absorptance])
+      else
+        os_frame_mat.setFrameVisibleAbsorptance(defaults[:visible_absorptance][:default])
+      end
+
+      os_frame_mat
+    end
+  end # EnergyWindowFrame
+end # Honeybee

data/lib/to_openstudio/model.rb

@@ -233,6 +233,12 @@ module Honeybee
             material_object = EnergyMaterialNoMass.new(material)
           when 'EnergyMaterialVegetation'
             material_object = EnergyMaterialVegetation.new(material)
+          when 'EnergyWindowMaterialSimpleGlazSys'
+            material_object = EnergyWindowMaterialSimpleGlazSys.new(material)
+          when 'EnergyWindowMaterialGlazing'
+            material_object = EnergyWindowMaterialGlazing.new(material)
+          when 'EnergyWindowFrame'
+            material_object = EnergyWindowFrame.new(material)
           when 'EnergyWindowMaterialGas'
             material_object = EnergyWindowMaterialGas.new(material)
             $gas_gap_hash[material[:identifier]] = material_object
@@ -242,12 +248,8 @@ module Honeybee
           when 'EnergyWindowMaterialGasCustom'
             material_object = EnergyWindowMaterialGasCustom.new(material)
             $gas_gap_hash[material[:identifier]] = material_object
-          when 'EnergyWindowMaterialSimpleGlazSys'
-            material_object = EnergyWindowMaterialSimpleGlazSys.new(material)
           when 'EnergyWindowMaterialBlind'
             material_object = EnergyWindowMaterialBlind.new(material)
-          when 'EnergyWindowMaterialGlazing'
-            material_object = EnergyWindowMaterialGlazing.new(material)
           when 'EnergyWindowMaterialShade'
             material_object = EnergyWindowMaterialShade.new(material)
           else

data/lib/to_openstudio/schedule/ruleset.rb

@@ -61,12 +61,16 @@ module Honeybee
       end
 
       # loop through day schedules and create openstudio schedule day object
+      day_schs = Hash.new
       def_day_id = @hash[:default_day_schedule]
       def_day_hash = nil
       @hash[:day_schedules].each do |day_schedule|
         if day_schedule[:identifier] != def_day_id
           day_schedule_new = OpenStudio::Model::ScheduleDay.new(openstudio_model)
-          day_schedule_new.setName(day_schedule[:identifier])
+          exist_sch = openstudio_model.getScheduleDayByName(day_schedule[:identifier])
+          if exist_sch.empty?  # make sure we don't overwrite an existing schedule day
+            day_schedule_new.setName(day_schedule[:identifier])
+          end
           unless @hash[:display_name].nil?
             day_schedule_new.setDisplayName(@hash[:display_name])
           end
@@ -81,53 +85,55 @@ module Honeybee
             time_until = OpenStudio::Time.new(0, times_day_new[i][0], times_day_new[i][1], 0)
             day_schedule_new.addValue(time_until, values_day_new[i])
           end
+          day_schs[day_schedule[:identifier]] = day_schedule_new
         else
           def_day_hash = day_schedule
         end
       end
 
+      # assign default day schedule
+      def_day_sch = os_sch_ruleset.defaultDaySchedule
+      exist_sch = openstudio_model.getScheduleDayByName(def_day_id)
+      if exist_sch.empty?  # make sure we don't overwrite an existing schedule day
+        def_day_sch.setName(def_day_id)
+      end
+      unless sch_type_limit_obj.nil?
+        def_day_sch.setScheduleTypeLimits(sch_type_limit_obj)
+      end
+      values_day_new = def_day_hash[:values]
+      times_day_new = def_day_hash[:times]
+      times_day_new.delete_at(0)  # Remove [0, 0] from array at index 0.
+      times_day_new.push([24, 0])  # Add [24, 0] at index 0
+      values_day_new.each_index do |i|
+        time_until = OpenStudio::Time.new(0, times_day_new[i][0], times_day_new[i][1], 0)
+        def_day_sch.addValue(time_until, values_day_new[i])
+      end
+      day_schs[def_day_id] = def_day_sch
+
       # assign holiday schedule
       if @hash[:holiday_schedule]
-        holiday_schedule = openstudio_model.getScheduleDayByName(@hash[:holiday_schedule])
-        unless holiday_schedule.empty?
-          holiday_schedule_object = holiday_schedule.get
-          os_sch_ruleset.setHolidaySchedule(holiday_schedule_object)
+        holiday_schedule = day_schs[@hash[:holiday_schedule]]
+        unless holiday_schedule.nil?
+          os_sch_ruleset.setHolidaySchedule(holiday_schedule)
         end
       end
 
       # assign summer design day schedule
       if @hash[:summer_designday_schedule]
-        summer_design_day = openstudio_model.getScheduleDayByName(@hash[:summer_designday_schedule])
-        unless summer_design_day.empty?
-          summer_design_day_object = summer_design_day.get
-          os_sch_ruleset.setSummerDesignDaySchedule(summer_design_day_object)
+        summer_design_day = day_schs[@hash[:summer_designday_schedule]]
+        unless summer_design_day.nil?
+          os_sch_ruleset.setSummerDesignDaySchedule(summer_design_day)
         end
       end
 
       # assign winter design day schedule
       if @hash[:winter_designday_schedule]
-        winter_design_day = openstudio_model.getScheduleDayByName(@hash[:winter_designday_schedule])
-        unless winter_design_day.empty?
-          winter_design_day_object = winter_design_day.get
-          os_sch_ruleset.setWinterDesignDaySchedule(winter_design_day_object)
+        winter_design_day = day_schs[@hash[:winter_designday_schedule]]
+        unless winter_design_day.nil?
+          os_sch_ruleset.setWinterDesignDaySchedule(winter_design_day)
         end
       end
 
-      # assign default day schedule
-      def_day_sch = os_sch_ruleset.defaultDaySchedule
-      def_day_sch.setName(def_day_id)
-      unless sch_type_limit_obj.nil?
-        def_day_sch.setScheduleTypeLimits(sch_type_limit_obj)
-      end
-      values_day_new = def_day_hash[:values]
-      times_day_new = def_day_hash[:times]
-      times_day_new.delete_at(0)  # Remove [0, 0] from array at index 0.
-      times_day_new.push([24, 0])  # Add [24, 0] at index 0
-      values_day_new.each_index do |i|
-        time_until = OpenStudio::Time.new(0, times_day_new[i][0], times_day_new[i][1], 0)
-        def_day_sch.addValue(time_until, values_day_new[i])
-      end
-
       # assign schedule rules
       if @hash[:schedule_rules]
         @hash[:schedule_rules].each do |rule|
@@ -145,12 +151,10 @@ module Honeybee
           openstudio_schedule_rule.setStartDate(start_date)
           openstudio_schedule_rule.setEndDate(end_date)
 
-          schedule_rule_day = openstudio_model.getScheduleDayByName(rule[:schedule_day])
-          unless schedule_rule_day.empty?
-            schedule_rule_day_object = schedule_rule_day.get
-
-            values_day = schedule_rule_day_object.values
-            times_day = schedule_rule_day_object.times
+          schedule_rule_day = day_schs[rule[:schedule_day]]
+          unless schedule_rule_day.nil?
+            values_day = schedule_rule_day.values
+            times_day = schedule_rule_day.times
 
             values_day.each_index do |i|
               openstudio_schedule_rule.daySchedule.addValue(times_day[i], values_day[i])

data/lib/to_openstudio.rb

@@ -61,13 +61,14 @@ require 'to_openstudio/construction/air'
 require 'to_openstudio/material/opaque'
 require 'to_openstudio/material/opaque_no_mass'
 require 'to_openstudio/material/vegetation'
+require 'to_openstudio/material/window_simpleglazsys'
+require 'to_openstudio/material/window_glazing'
 require 'to_openstudio/material/window_gas'
 require 'to_openstudio/material/window_gas_mixture'
 require 'to_openstudio/material/window_gas_custom'
+require 'to_openstudio/material/frame'
 require 'to_openstudio/material/window_blind'
-require 'to_openstudio/material/window_glazing'
 require 'to_openstudio/material/window_shade'
-require 'to_openstudio/material/window_simpleglazsys'
 
 # extend the load objects
 require 'to_openstudio/load/people'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeybee-openstudio
 version: !ruby/object:Gem::Version
-  version: 2.31.14
+  version: 2.33.0
 platform: ruby
 authors:
 - Tanushree Charan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-08 00:00:00.000000000 Z
+date: 2022-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -236,6 +236,7 @@ files:
 - lib/honeybee/load/setpoint_humidistat.rb
 - lib/honeybee/load/setpoint_thermostat.rb
 - lib/honeybee/load/ventilation.rb
+- lib/honeybee/material/frame.rb
 - lib/honeybee/material/opaque.rb
 - lib/honeybee/material/opaque_no_mass.rb
 - lib/honeybee/material/vegetation.rb
@@ -318,6 +319,7 @@ files:
 - lib/to_openstudio/load/setpoint_humidistat.rb
 - lib/to_openstudio/load/setpoint_thermostat.rb
 - lib/to_openstudio/load/ventilation.rb
+- lib/to_openstudio/material/frame.rb
 - lib/to_openstudio/material/opaque.rb
 - lib/to_openstudio/material/opaque_no_mass.rb
 - lib/to_openstudio/material/vegetation.rb