honeybee-openstudio 2.35.2 → 2.36.1

data/lib/honeybee/geometry/shademesh.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 ShadeMesh < ModelObject
+
+    def defaults
+      @@schema[:components][:schemas][:ShadeMeshEnergyPropertiesAbridged][:properties]
+    end
+
+  end #ShadeMesh
+end #Honeybee

data/lib/honeybee/model_object.rb

@@ -106,15 +106,21 @@ module Honeybee
       raise 'defaults not implemented for ModelObject, override in your class'
     end
 
+    def self.truncate(string, max)
+      string.length > max ? "#{string[0...max]}..." : string
+    end
+
     # remove illegal characters in identifier
     def self.clean_name(str)
       ascii = str.encode(Encoding.find('ASCII'), **@@encoding_options)
+      ascii = truncate(ascii, 97)
     end
 
     # remove illegal characters in identifier
     def self.clean_identifier(str)
       encode_str = str.encode(Encoding.find('ASCII'), **@@encoding_options)
       encode_str.gsub(/[^.A-Za-z0-9_-]/, '_').gsub(' ', '_')
+      encode_str = truncate(encode_str, 97)
     end
 
     # Create methods to get and set display name

data/lib/honeybee.rb

@@ -44,6 +44,7 @@ require 'honeybee/geometry/door'
 require 'honeybee/geometry/aperture'
 require 'honeybee/geometry/face'
 require 'honeybee/geometry/room'
+require 'honeybee/geometry/shademesh'
 
 # import the HVAC objects
 require 'honeybee/hvac/ideal_air'

data/lib/to_openstudio/geometry/face.rb

@@ -56,12 +56,14 @@ module Honeybee
         os_vertices << OpenStudio::Point3d.new(vertex[0], vertex[1], vertex[2])
       end
 
-      # create the openstudio surface and assign the type
+      # create the openstudio surface
       os_surface = OpenStudio::Model::Surface.new(os_vertices, openstudio_model)
       os_surface.setName(@hash[:identifier])
       unless @hash[:display_name].nil?
         os_surface.setDisplayName(@hash[:display_name])
       end
+
+      # assign the type
       os_surface.setSurfaceType(@hash[:face_type])
 
       if @hash[:properties].key?(:energy)

data/lib/to_openstudio/geometry/room.rb

@@ -219,6 +219,28 @@ module Honeybee
           end
         end
 
+        # overwrite the face type if E+ is going to flip the surface on us and make the geometry incorrect
+        face_tilt = os_surface.tilt
+        if face[:face_type] == 'RoofCeiling' && face_tilt > 1.57079632679
+          if !face[:properties][:energy][:construction]
+            orig_construction = os_surface.construction
+            unless orig_construction.empty?
+              orig_construction = orig_construction.get
+              os_surface.setConstruction(orig_construction)
+            end
+          end
+          os_surface.setSurfaceType('Wall')
+        elsif face[:face_type] == 'Floor' && face_tilt < 1.57079632679
+          if !face[:properties][:energy][:construction]
+            orig_construction = os_surface.construction
+            unless orig_construction.empty?
+              orig_construction = orig_construction.get
+              os_surface.setConstruction(orig_construction)
+            end
+          end
+          os_surface.setSurfaceType('Wall')
+        end
+
         # assign air boundaries
         if face[:face_type] == 'AirBoundary'
           # assign default air boundary construction for AirBoundary face types

data/lib/to_openstudio/geometry/shademesh.rb

@@ -0,0 +1,91 @@
+# *******************************************************************************
+# 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/geometry/shademesh'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class ShadeMesh
+
+    def to_openstudio(openstudio_model)
+      # get the vertices from the face
+      hb_verts = @hash[:geometry][:vertices]
+      hb_faces = @hash[:geometry][:faces]
+
+      # loop through each mesh face and make it a shading surface
+      os_shading_surfaces = []
+      hb_faces.each_with_index do |face_indices, index|
+        # ensure that vertices are correctly ordered with the upper-left corner
+        os_vertices = OpenStudio::Point3dVector.new
+        face_indices.each do |vertex_index|
+          vertex = hb_verts[vertex_index]
+          os_vertices << OpenStudio::Point3d.new(vertex[0], vertex[1], vertex[2])
+        end
+        os_vertices = OpenStudio.reorderULC(os_vertices)
+
+        # create the openstudio shading surface
+        os_shading_surface = OpenStudio::Model::ShadingSurface.new(os_vertices, openstudio_model)
+        os_shading_surface.setName(@hash[:identifier] + "..#{index}")
+        unless @hash[:display_name].nil?
+          os_shading_surface.setDisplayName(@hash[:display_name])
+        end
+
+        if @hash[:properties].key?(:energy)
+          # 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_shading_surface.setConstruction(os_construction)
+            end
+          end
+
+          # assign the transmittance schedule if it exists
+          if @hash[:properties][:energy][:transmittance_schedule]
+            schedule_identifier = @hash[:properties][:energy][:transmittance_schedule]
+            schedule = openstudio_model.getScheduleByName(schedule_identifier)
+            unless schedule.empty?
+              os_schedule = schedule.get
+              os_shading_surface.setTransmittanceSchedule(os_schedule)
+            end
+          end
+        end
+
+        os_shading_surfaces << os_shading_surface
+      end
+      
+      os_shading_surfaces
+    end
+
+  end #ShadeMesh
+end #Honeybee

data/lib/to_openstudio/model.rb

@@ -216,6 +216,7 @@ module Honeybee
       create_orphaned_faces
       create_orphaned_apertures
       create_orphaned_doors
+      create_shade_meshes
     end
 
     def create_materials(material_dicts, check_existing=false)
@@ -673,6 +674,27 @@ module Honeybee
       end
     end
 
+    def create_shade_meshes
+      if @hash[:shade_meshes]
+        @hash[:shade_meshes].each do |shade_mesh|
+          shade_mesh_object = ShadeMesh.new(shade_mesh)
+          openstudio_shades = shade_mesh_object.to_openstudio(@openstudio_model)
+
+          if $orphan_groups
+            shading_surface_group = OpenStudio::Model::ShadingSurfaceGroup.new(@openstudio_model)
+            shading_surface_group.setShadingSurfaceType('Building')
+            shading_surface_group.setName(shade_mesh[:identifier])
+            unless shade_mesh[:display_name].nil?
+              shading_surface_group.setDisplayName(shade_mesh[:display_name])
+            end
+            openstudio_shades.each do |openstudio_shade|
+              openstudio_shade.setShadingSurfaceGroup(shading_surface_group)
+            end
+          end
+        end
+      end
+    end
+
     #TODO: create runlog for errors.
 
   end # Model

data/lib/to_openstudio/simulation/parameter_model.rb

@@ -157,10 +157,12 @@ module Honeybee
         end
         # set any design days
         if @hash[:sizing_parameter][:design_days]
-          @hash[:sizing_parameter][:design_days].each do |des_day|
-            des_day_object = DesignDay.new(des_day)
-            os_des_day = des_day_object.to_openstudio(@openstudio_model)
-            db_temps << des_day[:dry_bulb_condition][:dry_bulb_max]
+          if @hash[:simulation_control][:do_zone_sizing].nil? || @hash[:simulation_control][:do_zone_sizing] == true
+            @hash[:sizing_parameter][:design_days].each do |des_day|
+              des_day_object = DesignDay.new(des_day)
+              os_des_day = des_day_object.to_openstudio(@openstudio_model)
+              db_temps << des_day[:dry_bulb_condition][:dry_bulb_max]
+            end
           end
         end
       end

data/lib/to_openstudio.rb

@@ -44,6 +44,7 @@ require 'to_openstudio/geometry/door'
 require 'to_openstudio/geometry/aperture'
 require 'to_openstudio/geometry/face'
 require 'to_openstudio/geometry/room'
+require 'to_openstudio/geometry/shademesh'
 
 # extend the HVAC objects
 require 'to_openstudio/hvac/ideal_air'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeybee-openstudio
 version: !ruby/object:Gem::Version
-  version: 2.35.2
+  version: 2.36.1
 platform: ruby
 authors:
 - Tanushree Charan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-10 00:00:00.000000000 Z
+date: 2023-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_pure
@@ -138,6 +138,7 @@ files:
 - lib/honeybee/geometry/face.rb
 - lib/honeybee/geometry/room.rb
 - lib/honeybee/geometry/shade.rb
+- lib/honeybee/geometry/shademesh.rb
 - lib/honeybee/hvac/ideal_air.rb
 - lib/honeybee/hvac/template.rb
 - lib/honeybee/internalmass.rb
@@ -229,6 +230,7 @@ files:
 - lib/to_openstudio/geometry/face.rb
 - lib/to_openstudio/geometry/room.rb
 - lib/to_openstudio/geometry/shade.rb
+- lib/to_openstudio/geometry/shademesh.rb
 - lib/to_openstudio/hvac/Model.hvac.rb
 - lib/to_openstudio/hvac/ideal_air.rb
 - lib/to_openstudio/hvac/radiant.rb