honeybee-openstudio 1.8.1

data/lib/from_honeybee/extension.rb

@@ -0,0 +1,109 @@
+# *******************************************************************************
+# 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 'openstudio/extension'
+
+# NOTE: This file has been derived from one within the openStudio-extension gem
+# The properties here are a standard part of openstudio extensions
+
+module FromHoneybee
+  class Extension < OpenStudio::Extension::Extension
+    @@schema = nil
+
+    # Override parent class
+    def initialize
+      super
+
+      # Note that the root_dir is only meaningful when the gem is in a github repository
+      # When installed as a Ruby gem, the highest directory within the gem is the lib_dir
+      @root_dir = File.absolute_path(File.join(File.dirname(__FILE__), '..', '..'))
+      @lib_dir = File.absolute_path(File.join(File.dirname(__FILE__), '..'))
+
+      @instance_lock = Mutex.new
+      @@schema ||= schema
+    end
+
+    # Return the absolute path of the measures or nil if there is none.
+    # Can be used when configuring OSWs
+    def measures_dir
+      File.absolute_path(File.join(@lib_dir, 'measures'))
+    end
+
+    # Relevant files such as the openapi JSON schema files for the honeybee model.
+    # Return the absolute path of the files or nil if there is none.
+    # Used when configuring OSWs
+    def files_dir
+      File.absolute_path(File.join(@lib_dir, 'files'))
+    end
+
+    # Doc templates are common files like copyright files which are used to update measures
+    # Doc templates will only be applied when the gem is a part of a repository
+    # Return the absolute path of the doc templates dir or nil if there is none
+    def doc_templates_dir
+      File.absolute_path(File.join(@root_dir, 'doc_templates'))
+    end
+
+    # return path to the model schema file
+    def schema_file
+      File.join(@lib_dir, 'from_honeybee', '_openapi', 'model.json')
+    end
+
+    # return the model schema
+    def schema
+      @instance_lock.synchronize do
+        if @@schema.nil?
+          File.open(schema_file, 'r') do |f|
+            @@schema = JSON.parse(f.read, symbolize_names: true)
+          end
+        end
+      end
+
+      @@schema
+    end
+
+    # check if the model schema is valid
+    def schema_valid?
+      if Gem.loaded_specs.has_key?("json-schema")
+        require 'json-schema'
+        metaschema = JSON::Validator.validator_for_name('draft6').metaschema
+        JSON::Validator.validate(metaschema, @@schema)
+      end
+    end
+
+    # return detailed schema validation errors
+    def schema_validation_errors
+      if Gem.loaded_specs.has_key?("json-schema")
+        metaschema = JSON::Validator.validator_for_name('draft6').metaschema
+        JSON::Validator.fully_validate(metaschema, @@schema)
+      end
+    end
+  end
+end

data/lib/from_honeybee/geometry/aperture.rb

@@ -0,0 +1,167 @@
+# *******************************************************************************
+# 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 'from_honeybee/model_object'
+
+require 'openstudio'
+
+module FromHoneybee
+  class Aperture < ModelObject
+    attr_reader :errors, :warnings
+
+    def initialize(hash)
+      super(hash)
+      raise "Incorrect model type '#{@type}'" unless @type == 'Aperture'
+    end
+
+    def defaults
+      @@schema[:components][:schemas][:ApertureEnergyPropertiesAbridged][:properties]
+    end
+
+    def find_existing_openstudio_object(openstudio_model)
+      object = openstudio_model.getSubSurfaceByName(@hash[:identifier])
+      return object.get if object.is_initialized
+      nil
+    end
+
+    def to_openstudio(openstudio_model)
+      # create the OpenStudio aperture object
+      os_vertices = OpenStudio::Point3dVector.new
+      @hash[:geometry][:boundary].each do |vertex|
+        os_vertices << OpenStudio::Point3d.new(vertex[0], vertex[1], vertex[2])
+      end
+      reordered_vertices = OpenStudio.reorderULC(os_vertices)
+      
+      # triangulate subsurface if neccesary
+      triangulated = false
+      final_vertices_list = []
+      matching_os_subsurfaces = []
+      matching_os_subsurface_indices = []
+      if reordered_vertices.size > 4
+      
+        # if this apeture has a matched apeture, see if the other one has already been created
+        # the matched apeture should have been converted to multiple subsurfaces
+        if @hash[:boundary_condition][:type] == 'Surface'
+          adj_srf_identifier = @hash[:boundary_condition][:boundary_condition_objects][0]
+          regex = Regexp.new("#{adj_srf_identifier}\.\.(\\d+)")
+          openstudio_model.getSubSurfaces.each do |subsurface|
+            if md = regex.match(subsurface.nameString)
+              final_vertices_list << OpenStudio.reorderULC(OpenStudio::reverse(subsurface.vertices))
+              matching_os_subsurfaces << subsurface
+              matching_os_subsurface_indices << md[1]
+            end
+          end
+        end
+        
+        # if other apeture is not already created, do the triangulation
+        if final_vertices_list.empty?
+          
+          # transform to face coordinates
+          t = OpenStudio::Transformation::alignFace(reordered_vertices)
+          tInv = t.inverse
+          face_vertices = OpenStudio::reverse(tInv*reordered_vertices)
+          
+          # no holes in the subsurface
+          holes = OpenStudio::Point3dVectorVector.new
+          
+          # triangulate surface
+          triangles = OpenStudio::computeTriangulation(face_vertices, holes)
+          if triangles.empty?
+            raise "Failed to triangulate aperture #{@hash[:identifier]} with #{reordered_vertices.size} vertices"
+          end
+          
+          # create new list of surfaces
+          triangles.each do |vertices|
+            final_vertices_list << OpenStudio.reorderULC(OpenStudio::reverse(t*vertices))
+          end
+          
+          triangulated = true
+          
+        end
+        
+      else
+        # reordered_vertices are good as is
+        final_vertices_list << reordered_vertices
+      end
+
+      result = []
+      final_vertices_list.each_with_index do |reordered_vertices, index|
+        os_subsurface = OpenStudio::Model::SubSurface.new(reordered_vertices, openstudio_model)
+        
+        if !matching_os_subsurfaces.empty?
+          os_subsurface.setName(@hash[:identifier] + "..#{matching_os_subsurface_indices[index]}")
+        elsif triangulated
+          os_subsurface.setName(@hash[:identifier] + "..#{index}")
+        else
+          os_subsurface.setName(@hash[:identifier])
+        end
+        
+        # assign the construction if it exists
+        if @hash[:properties][:energy][:construction]
+          construction_identifier = @hash[:properties][:energy][:construction]
+          construction = openstudio_model.getConstructionByName(construction_identifier)
+          unless construction.empty?
+            os_construction = construction.get
+            os_subsurface.setConstruction(os_construction)
+          end
+        end
+        
+        # assign the boundary condition object if it's a Surface
+        if @hash[:boundary_condition][:type] == 'Surface'
+          if !matching_os_subsurfaces.empty?
+            # we already have the match because this was created from the matching_os_subsurfaces
+            # setAdjacentSubSurface will fail at this point because sub surface is not assigned to surface yet, store data for later
+            adj_srf_identifier = matching_os_subsurfaces[index].nameString
+            os_subsurface.additionalProperties.setFeature("AdjacentSubSurfaceName", adj_srf_identifier)
+          elsif triangulated
+            # other subsurfaces haven't been created yet, no-op
+          else
+            # get adjacent sub surface by identifier from openstudio model
+            # setAdjacentSubSurface will fail at this point because sub surface is not assigned to surface yet, store data for later
+            adj_srf_identifier = @hash[:boundary_condition][:boundary_condition_objects][0]
+            os_subsurface.additionalProperties.setFeature("AdjacentSubSurfaceName", adj_srf_identifier)
+          end
+        end
+
+        # assign the operable property
+        if @hash[:is_operable] == false
+          os_subsurface.setSubSurfaceType('FixedWindow')
+        else 
+          os_subsurface.setSubSurfaceType('OperableWindow')
+        end
+        
+        result << os_subsurface
+      end
+      
+      return result
+    end
+  end # Aperture
+end # FromHoneybee

data/lib/from_honeybee/geometry/door.rb

@@ -0,0 +1,160 @@
+# *******************************************************************************
+# 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 'from_honeybee/model_object'
+
+require 'openstudio'
+
+module FromHoneybee
+  class Door < ModelObject
+    attr_reader :errors, :warnings
+
+    def initialize(hash)
+      super(hash)
+      raise "Incorrect model type '#{@type}'" unless @type == 'Door'
+    end
+
+    def defaults
+      @@schema[:components][:schemas][:DoorEnergyPropertiesAbridged][:properties]
+    end
+
+    def find_existing_openstudio_object(openstudio_model)
+      object = openstudio_model.getSubSurfaceByName(@hash[:identifier])
+      return object.get if object.is_initialized
+      nil
+    end
+
+    def to_openstudio(openstudio_model)
+      # create the OpenStudio door object
+      os_vertices = OpenStudio::Point3dVector.new
+      @hash[:geometry][:boundary].each do |vertex|
+        os_vertices << OpenStudio::Point3d.new(vertex[0], vertex[1], vertex[2])
+      end
+      reordered_vertices = OpenStudio.reorderULC(os_vertices)
+      
+      # triangulate subsurface if neccesary
+      triangulated = false
+      final_vertices_list = []
+      matching_os_subsurfaces = []
+      matching_os_subsurface_indices = []
+      if reordered_vertices.size > 4
+      
+        # if this door has a matched door, see if the other one has already been created
+        # the matched door should have been converted to multiple subsurfaces
+        if @hash[:boundary_condition][:type] == 'Surface'
+          adj_srf_identifier = @hash[:boundary_condition][:boundary_condition_objects][0]
+          regex = Regexp.new("#{adj_srf_identifier}\.\.(\\d+)")
+          openstudio_model.getSubSurfaces.each do |subsurface|
+            if md = regex.match(subsurface.nameString)
+              final_vertices_list << OpenStudio.reorderULC(OpenStudio::reverse(subsurface.vertices))
+              matching_os_subsurfaces << subsurface
+              matching_os_subsurface_indices << md[1]
+            end
+          end
+        end
+        
+        # if other door is not already created, do the triangulation
+        if final_vertices_list.empty?
+          
+          # transform to face coordinates
+          t = OpenStudio::Transformation::alignFace(reordered_vertices)
+          tInv = t.inverse
+          face_vertices = OpenStudio::reverse(tInv*reordered_vertices)
+          
+          # no holes in the subsurface
+          holes = OpenStudio::Point3dVectorVector.new
+          
+          # triangulate surface
+          triangles = OpenStudio::computeTriangulation(face_vertices, holes)
+          if triangles.empty?
+            raise "Failed to triangulate door #{@hash[:identifier]} with #{reordered_vertices.size} vertices"
+          end
+          
+          # create new list of surfaces
+          triangles.each do |vertices|
+            final_vertices_list << OpenStudio.reorderULC(OpenStudio::reverse(t*vertices))
+          end
+          
+          triangulated = true
+          
+        end
+        
+      else
+        # reordered_vertices are good as is
+        final_vertices_list << reordered_vertices
+      end
+
+      result = []
+      final_vertices_list.each_with_index do |reordered_vertices, index|
+        os_subsurface = OpenStudio::Model::SubSurface.new(reordered_vertices, openstudio_model)
+        
+        if !matching_os_subsurfaces.empty?
+          os_subsurface.setName(@hash[:identifier] + "..#{matching_os_subsurface_indices[index]}")
+        elsif triangulated
+          os_subsurface.setName(@hash[:identifier] + "..#{index}")
+        else
+          os_subsurface.setName(@hash[:identifier])
+        end
+        
+        # assign the construction if it exists
+        if @hash[:properties][:energy][:construction]
+          construction_identifier = @hash[:properties][:energy][:construction]
+          construction = openstudio_model.getConstructionByName(construction_identifier)
+          unless construction.empty?
+            os_construction = construction.get
+            os_subsurface.setConstruction(os_construction)
+          end
+        end
+        
+        # assign the boundary condition object if it's a Surface
+        if @hash[:boundary_condition][:type] == 'Surface'
+          if !matching_os_subsurfaces.empty?
+            # we already have the match because this was created from the matching_os_subsurfaces
+            # setAdjacentSubSurface will fail at this point because sub surface is not assigned to surface yet, store data for later
+            adj_srf_identifier = matching_os_subsurfaces[index].nameString
+            os_subsurface.additionalProperties.setFeature("AdjacentSubSurfaceName", adj_srf_identifier)
+          elsif triangulated
+            # other subsurfaces haven't been created yet, no-op
+          else
+            # get adjacent sub surface by identifier from openstudio model
+            # setAdjacentSubSurface will fail at this point because sub surface is not assigned to surface yet, store data for later
+            adj_srf_identifier = @hash[:boundary_condition][:boundary_condition_objects][0]
+            os_subsurface.additionalProperties.setFeature("AdjacentSubSurfaceName", adj_srf_identifier)
+          end
+        end
+
+        result << os_subsurface
+      end
+      
+      return result
+    end
+  end # Door
+end # FromHoneybee

data/lib/from_honeybee/geometry/face.rb

@@ -0,0 +1,163 @@
+# *******************************************************************************
+# 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 'from_honeybee/model_object'
+require 'from_honeybee/geometry/aperture'
+require 'from_honeybee/geometry/door'
+
+require 'openstudio'
+
+module FromHoneybee
+  class Face < ModelObject
+    attr_reader :errors, :warnings
+
+    def initialize(hash = {})
+      super(hash)
+
+      raise "Incorrect model type '#{@type}'" unless @type == 'Face'
+    end
+
+    def defaults
+      @@schema[:components][:schemas][:FaceEnergyPropertiesAbridged][:properties]
+    end
+
+    def find_existing_openstudio_object(openstudio_model)
+      model_surf = openstudio_model.getSurfaceByName(@hash[:identifier])
+      return model_surf.get unless model_surf.empty?
+      nil
+    end
+
+    def to_openstudio(openstudio_model)
+      # create the openstudio surface
+      os_vertices = OpenStudio::Point3dVector.new
+      @hash[:geometry][:boundary].each do |vertex|
+        os_vertices << OpenStudio::Point3d.new(vertex[0], vertex[1], vertex[2])
+      end
+      reordered_vertices = OpenStudio.reorderULC(os_vertices)
+
+      os_surface = OpenStudio::Model::Surface.new(reordered_vertices, openstudio_model)     
+      os_surface.setName(@hash[:identifier])
+      os_surface.setSurfaceType(@hash[:face_type])
+      # assign the construction if it is present
+      if @hash[:properties][:energy][:construction]
+        construction_identifier = @hash[:properties][:energy][:construction]
+        construction = openstudio_model.getConstructionByName(construction_identifier)
+        unless construction.empty?
+          os_construction = construction.get
+          os_surface.setConstruction(os_construction)
+        end
+      end
+
+      # assign the boundary condition
+      boundary_condition = (@hash[:boundary_condition][:type])
+      case boundary_condition
+      when 'Outdoors'
+        if @hash[:boundary_condition][:sun_exposure] == false
+          os_surface.setSunExposure('NoSun')
+        else 
+          os_surface.setSunExposure('SunExposed')
+        end
+        if @hash[:boundary_condition][:wind_exposure] == false
+          os_surface.setWindExposure('NoWind')
+        else
+          os_surface.setWindExposure('WindExposed')
+        end
+        if @hash[:boundary_condition][:view_factor].is_a? Numeric
+          os_surface.setViewFactortoGround(@hash[:boundary_condition][:view_factor])
+        else
+          os_surface.autocalculateViewFactortoGround
+        end
+      when 'Surface'
+        # get adjacent surface by identifier from openstudio model
+        adj_srf_identifier = @hash[:boundary_condition][:boundary_condition_objects][0]
+        surface_object = openstudio_model.getSurfaceByName(adj_srf_identifier)
+        unless surface_object.empty?
+          surface = surface_object.get
+          os_surface.setAdjacentSurface(surface)
+        end
+      end
+      unless @hash[:boundary_condition][:type] == 'Surface'
+        os_surface.setOutsideBoundaryCondition(@hash[:boundary_condition][:type])
+      end
+
+      # assign apertures if they exist
+      if @hash[:apertures]
+        @hash[:apertures].each do |aperture|
+          ladybug_aperture = Aperture.new(aperture)
+          os_subsurface_apertures = ladybug_aperture.to_openstudio(openstudio_model)
+          os_subsurface_apertures.each do |os_subsurface_aperture|
+            if @hash[:face_type] == 'RoofCeiling' or @hash[:face_type]  == 'Floor'
+              if @hash[:boundary_condition][:type] == 'Outdoors' && aperture[:is_operable] == false
+                os_subsurface_aperture.setSubSurfaceType('Skylight')
+              end
+            end
+            os_subsurface_aperture.setSurface(os_surface)
+          end
+        end
+      end
+
+      # assign doors if they exist
+      if @hash[:doors]
+        @hash[:doors].each do |door|
+          honeybee_door = Door.new(door)
+          os_subsurface_doors = honeybee_door.to_openstudio(openstudio_model)
+          os_subsurface_doors.each do |os_subsurface_door|
+            os_subsurface_door.setSurface(os_surface)
+            if door[:is_glass] == true
+              os_subsurface_door.setSubSurfaceType('GlassDoor')
+            elsif (@hash[:face_type] == 'RoofCeiling' or @hash[:face_type] == 'Floor') && @hash[:boundary_condition][:type] == 'Outdoors'
+              os_subsurface_door.setSubSurfaceType('OverheadDoor')
+            elsif door[:is_glass] == false or door[:is_glass].nil?
+              os_subsurface_door.setSubSurfaceType('Door')
+            end
+          end
+        end
+      end
+
+      os_surface.subSurfaces.each do |os_subsurface|
+        if os_subsurface.hasAdditionalProperties
+          adj_sub_srf_identifier = os_subsurface.additionalProperties.getFeatureAsString("AdjacentSubSurfaceName")
+          unless adj_sub_srf_identifier.empty?
+            adj_sub_srf = openstudio_model.getSubSurfaceByName(adj_sub_srf_identifier.get)
+            unless adj_sub_srf.empty?
+              os_subsurface.setAdjacentSubSurface(adj_sub_srf.get)
+            end
+          end
+
+          # clean up, we don't need this object any more
+          os_subsurface.removeAdditionalProperties
+        end
+      end
+
+      os_surface
+    end
+  end # Face
+end # FromHoneybee