honeybee-openstudio 2.0.0 → 2.2.0

data/lib/from_honeybee/_openapi/simulation-parameter.json

@@ -3,7 +3,7 @@
   "servers": [],
   "info": {
     "description": "This is the documentation for Honeybee energy simulation parameter schema.",
-    "version": "1.27.1",
+    "version": "0.0.1",
     "title": "Honeybee Energy Simulation Parameter Schema",
     "contact": {
       "name": "Ladybug Tools",
@@ -44,6 +44,11 @@
       "x-displayName": "DesignDay",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DesignDay\" />\n"
     },
+    {
+      "name": "designdaytypes_model",
+      "x-displayName": "DesignDayTypes",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DesignDayTypes\" />\n"
+    },
     {
       "name": "drybulbcondition_model",
       "x-displayName": "DryBulbCondition",
@@ -54,16 +59,41 @@
       "x-displayName": "HumidityCondition",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/HumidityCondition\" />\n"
     },
+    {
+      "name": "humiditytypes_model",
+      "x-displayName": "HumidityTypes",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/HumidityTypes\" />\n"
+    },
     {
       "name": "runperiod_model",
       "x-displayName": "RunPeriod",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/RunPeriod\" />\n"
     },
+    {
+      "name": "daysofweek_model",
+      "x-displayName": "DaysOfWeek",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/DaysOfWeek\" />\n"
+    },
     {
       "name": "shadowcalculation_model",
       "x-displayName": "ShadowCalculation",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ShadowCalculation\" />\n"
     },
+    {
+      "name": "solardistribution_model",
+      "x-displayName": "SolarDistribution",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SolarDistribution\" />\n"
+    },
+    {
+      "name": "calculationmethod_model",
+      "x-displayName": "CalculationMethod",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/CalculationMethod\" />\n"
+    },
+    {
+      "name": "calculationupdatemethod_model",
+      "x-displayName": "CalculationUpdateMethod",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/CalculationUpdateMethod\" />\n"
+    },
     {
       "name": "simulationcontrol_model",
       "x-displayName": "SimulationControl",
@@ -74,11 +104,21 @@
       "x-displayName": "SimulationOutput",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SimulationOutput\" />\n"
     },
+    {
+      "name": "reportingfrequency_model",
+      "x-displayName": "ReportingFrequency",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/ReportingFrequency\" />\n"
+    },
     {
       "name": "simulationparameter_model",
       "x-displayName": "SimulationParameter",
       "description": "<SchemaDefinition schemaRef=\"#/components/schemas/SimulationParameter\" />\n"
     },
+    {
+      "name": "terriantypes_model",
+      "x-displayName": "TerrianTypes",
+      "description": "<SchemaDefinition schemaRef=\"#/components/schemas/TerrianTypes\" />\n"
+    },
     {
       "name": "sizingparameter_model",
       "x-displayName": "SizingParameter",
@@ -96,16 +136,24 @@
       "tags": [
         "ashraeclearsky_model",
         "ashraetau_model",
+        "calculationmethod_model",
+        "calculationupdatemethod_model",
         "daylightsavingtime_model",
+        "daysofweek_model",
         "designday_model",
+        "designdaytypes_model",
         "drybulbcondition_model",
         "humiditycondition_model",
+        "humiditytypes_model",
+        "reportingfrequency_model",
         "runperiod_model",
         "shadowcalculation_model",
         "simulationcontrol_model",
         "simulationoutput_model",
         "simulationparameter_model",
         "sizingparameter_model",
+        "solardistribution_model",
+        "terriantypes_model",
         "windcondition_model"
       ]
     }
@@ -126,15 +174,13 @@
             "readOnly": true
           },
           "reporting_frequency": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/ReportingFrequency"
+              }
+            ],
             "title": "Reporting Frequency",
             "default": "Hourly",
-            "enum": [
-              "Timestep",
-              "Hourly",
-              "Daily",
-              "Monthly",
-              "Annual"
-            ],
             "type": "string"
           },
           "include_sqlite": {
@@ -146,7 +192,7 @@
           "include_html": {
             "title": "Include Html",
             "description": "Boolean to note whether an HTML report should be requested from the simulation.",
-            "default": false,
+            "default": true,
             "type": "boolean"
           },
           "outputs": {
@@ -256,18 +302,14 @@
             "maxItems": 2
           },
           "start_day_of_week": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/DaysOfWeek"
+              }
+            ],
             "title": "Start Day Of Week",
             "description": "Text for the day of the week on which the simulation starts.",
             "default": "Sunday",
-            "enum": [
-              "Sunday",
-              "Monday",
-              "Tuesday",
-              "Wednesday",
-              "Thursday",
-              "Friday",
-              "Saturday"
-            ],
             "type": "string"
           },
           "holidays": {
@@ -362,34 +404,45 @@
             "readOnly": true
           },
           "solar_distribution": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/SolarDistribution"
+              }
+            ],
             "title": "Solar Distribution",
             "default": "FullExteriorWithReflections",
-            "enum": [
-              "MinimalShadowing",
-              "FullExterior",
-              "FullInteriorAndExterior",
-              "FullExteriorWithReflections",
-              "FullInteriorAndExteriorWithReflections"
+            "type": "string"
+          },
+          "calculation_method": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/CalculationMethod"
+              }
             ],
+            "title": "Calculation Method",
+            "description": "Text noting whether CPU-based polygon clipping method orGPU-based pixel counting method should be used. For low numbers of shadingsurfaces (less than ~200), PolygonClipping requires less runtime thanPixelCounting. However, PixelCounting runtime scales significantlybetter at higher numbers of shading surfaces. PixelCounting also hasno limitations related to zone concavity when used with any\u201cFullInterior\u201d solar distribution options.",
+            "default": "PolygonClipping",
+            "type": "string"
+          },
+          "calculation_update_method": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/CalculationUpdateMethod"
+              }
+            ],
+            "title": "Calculation Update Method",
+            "description": "Text describing how often the solar and shading calculations are updated with respect to the flow of time in the simulation.",
+            "default": "Periodic",
             "type": "string"
           },
           "calculation_frequency": {
             "title": "Calculation Frequency",
-            "description": "Integer for the number of days in each period for which a unique shadow calculation will be performed. This field is only used if the AverageOverDaysInFrequency calculation_method is used.",
+            "description": "Integer for the number of days in each period for which a unique shadow calculation will be performed. This field is only used if the Periodic calculation_method is used.",
             "default": 30,
             "minimum": 1,
             "type": "integer",
             "format": "int32"
           },
-          "calculation_method": {
-            "title": "Calculation Method",
-            "default": "AverageOverDaysInFrequency",
-            "enum": [
-              "AverageOverDaysInFrequency",
-              "TimestepFrequency"
-            ],
-            "type": "string"
-          },
           "maximum_figures": {
             "title": "Maximum Figures",
             "description": "Number of allowable figures in shadow overlap calculations.",
@@ -441,13 +494,12 @@
         "type": "object",
         "properties": {
           "humidity_type": {
-            "title": "Humidity Type",
-            "enum": [
-              "Wetbulb",
-              "Dewpoint",
-              "HumidityRatio",
-              "Enthalpy"
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/HumidityTypes"
+              }
             ],
+            "title": "Humidity Type",
             "type": "string"
           },
           "humidity_value": {
@@ -544,7 +596,7 @@
           },
           "clearness": {
             "title": "Clearness",
-            "description": "Value between 0 and 1.2 that will get multiplied by the irradinace to correct for factors like elevation above sea level.",
+            "description": "Value between 0 and 1.2 that will get multiplied by the irradiance to correct for factors like elevation above sea level.",
             "minimum": 0,
             "maximum": 1.2,
             "type": "number",
@@ -636,20 +688,12 @@
             "type": "string"
           },
           "day_type": {
-            "title": "Day Type",
-            "enum": [
-              "SummerDesignDay",
-              "WinterDesignDay",
-              "Sunday",
-              "Monday",
-              "Tuesday",
-              "Wednesday",
-              "Thursday",
-              "Friday",
-              "Holiday",
-              "CustomDay1",
-              "CustomDay2"
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/DesignDayTypes"
+              }
             ],
+            "title": "Day Type",
             "type": "string"
           },
           "dry_bulb_condition": {
@@ -823,20 +867,117 @@
             "format": "double"
           },
           "terrain_type": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/TerrianTypes"
+              }
+            ],
             "title": "Terrain Type",
             "description": "Text for the terrain in which the model sits. This is used to determine the wind profile over the height of the rooms.",
             "default": "City",
-            "enum": [
-              "Ocean",
-              "Country",
-              "Suburbs",
-              "Urban",
-              "City"
-            ],
             "type": "string"
           }
         },
         "additionalProperties": false
+      },
+      "DesignDayTypes": {
+        "title": "Day Type",
+        "enum": [
+          "SummerDesignDay",
+          "WinterDesignDay",
+          "Sunday",
+          "Monday",
+          "Tuesday",
+          "Wednesday",
+          "Thursday",
+          "Friday",
+          "Holiday",
+          "CustomDay1",
+          "CustomDay2"
+        ],
+        "type": "string"
+      },
+      "HumidityTypes": {
+        "title": "Humidity Type",
+        "enum": [
+          "Wetbulb",
+          "Dewpoint",
+          "HumidityRatio",
+          "Enthalpy"
+        ],
+        "type": "string"
+      },
+      "DaysOfWeek": {
+        "title": "Start Day Of Week",
+        "description": "Text for the day of the week on which the simulation starts.",
+        "default": "Sunday",
+        "enum": [
+          "Sunday",
+          "Monday",
+          "Tuesday",
+          "Wednesday",
+          "Thursday",
+          "Friday",
+          "Saturday"
+        ],
+        "type": "string"
+      },
+      "SolarDistribution": {
+        "title": "Solar Distribution",
+        "default": "FullExteriorWithReflections",
+        "enum": [
+          "MinimalShadowing",
+          "FullExterior",
+          "FullInteriorAndExterior",
+          "FullExteriorWithReflections",
+          "FullInteriorAndExteriorWithReflections"
+        ],
+        "type": "string"
+      },
+      "CalculationMethod": {
+        "title": "Calculation Method",
+        "description": "Text noting whether CPU-based polygon clipping method orGPU-based pixel counting method should be used. For low numbers of shadingsurfaces (less than ~200), PolygonClipping requires less runtime thanPixelCounting. However, PixelCounting runtime scales significantlybetter at higher numbers of shading surfaces. PixelCounting also hasno limitations related to zone concavity when used with any\u201cFullInterior\u201d solar distribution options.",
+        "default": "PolygonClipping",
+        "enum": [
+          "PolygonClipping",
+          "PixelCounting"
+        ],
+        "type": "string"
+      },
+      "CalculationUpdateMethod": {
+        "title": "Calculation Update Method",
+        "description": "Text describing how often the solar and shading calculations are updated with respect to the flow of time in the simulation.",
+        "default": "Periodic",
+        "enum": [
+          "Periodic",
+          "Timestep"
+        ],
+        "type": "string"
+      },
+      "ReportingFrequency": {
+        "title": "Reporting Frequency",
+        "default": "Hourly",
+        "enum": [
+          "Timestep",
+          "Hourly",
+          "Daily",
+          "Monthly",
+          "Annual"
+        ],
+        "type": "string"
+      },
+      "TerrianTypes": {
+        "title": "Terrain Type",
+        "description": "Text for the terrain in which the model sits. This is used to determine the wind profile over the height of the rooms.",
+        "default": "City",
+        "enum": [
+          "Ocean",
+          "Country",
+          "Suburbs",
+          "Urban",
+          "City"
+        ],
+        "type": "string"
       }
     }
   }

data/lib/from_honeybee/construction/window.rb

@@ -74,7 +74,6 @@ module FromHoneybee
 
   end #WindowConstructionAbridged
 end #FromHoneybee
-    
 
     
     

data/lib/from_honeybee/construction/windowshade.rb

@@ -0,0 +1,207 @@
+# *******************************************************************************
+# 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/construction/window'
+
+require 'openstudio'
+
+module FromHoneybee
+  class WindowConstructionShadeAbridged < ModelObject
+    attr_reader :errors, :warnings
+
+    def initialize(hash = {})
+      super(hash)
+      @construction = nil
+      @shade_construction = nil
+      @shade_location = nil
+      @shade_material = nil
+      @control_type = nil
+      @setpoint = nil
+      @schedule = nil
+    end
+
+    def defaults
+      @@schema[:components][:schemas][:WindowConstructionShadeAbridged][:properties]
+    end
+
+    def find_existing_openstudio_object(openstudio_model)
+      object = openstudio_model.getConstructionByName(@hash[:identifier])
+      return object.get if object.is_initialized
+      nil
+    end
+
+    def to_openstudio(openstudio_model)
+      # write the shaded and unsaded versions of the construciton into the model
+      # reverse the shaded and unshaded identifiers so unshaded one is assigned to apertures
+      unshd_id = @hash[:identifier]
+      shd_id = @hash[:window_construction][:identifier]
+      @hash[:window_construction][:identifier] = unshd_id
+      @hash[:identifier] = shd_id
+
+      # create the unshaded construction
+      unshd_constr_obj = WindowConstructionAbridged.new(@hash[:window_construction])
+      @construction = unshd_constr_obj.to_openstudio(openstudio_model)
+
+      # create the shaded construction
+      @shade_construction = OpenStudio::Model::Construction.new(openstudio_model)
+      @shade_construction.setName(shd_id)
+
+      # create the layers of the unshaded construction into which we will insert the shade
+      os_materials = []
+      @hash[:window_construction][:layers].each do |layer|
+        material_identifier = layer
+        material = openstudio_model.getMaterialByName(material_identifier)
+        unless material.empty?
+          os_material = material.get
+          os_materials << os_material
+        end
+      end
+
+      # figure out where to insert the shade material and insert it
+      if @hash[:shade_location]
+        @shade_location = @hash[:shade_location]
+      else
+        @shade_location = defaults[:shade_location][:default]
+      end
+
+      # insert the shade material
+      shd_mat_name = openstudio_model.getMaterialByName(@hash[:shade_material])
+      unless shd_mat_name.empty?
+        @shade_material = shd_mat_name.get
+      end
+      unless @shade_material.nil?
+        if @shade_material.is_a? OpenStudio::Model::StandardGlazing
+          if @shade_location == 'Interior'
+              os_materials[-1] = @shade_material
+          elsif @shade_location == 'Exterior' | os_materials.length < 2
+              os_materials[0] = @shade_material
+          else  # middle glass pane
+              os_materials[-3] = @shade_material
+          end
+        else
+          if @shade_location == 'Interior'
+              os_materials << @shade_material
+          elsif @shade_location == 'Exterior'
+              os_materials.unshift(@shade_material)
+          else  # between glass shade/blind
+            split_gap = split_gas_gap(openstudio_model, os_materials[-2], @shade_material)
+            os_materials[-2] = split_gap
+            os_materials.insert(-2, @shade_material)
+            os_materials.insert(-2, split_gap)
+          end
+        end
+      end
+
+      # assign the layers to the shaded construction
+      os_materials_vec = OpenStudio::Model::MaterialVector.new
+      os_materials.each do |mat|
+        os_materials_vec << mat
+      end
+      @shade_construction.setLayers(os_materials)
+
+      # set defaults for control type, setpoint, and schedule
+      if @hash[:control_type]
+        @control_type = @hash[:control_type]
+      else
+        @control_type = defaults[:control_type][:default]
+      end
+
+      if @hash[:setpoint]
+        @setpoint = @hash[:setpoint]
+      else
+        @setpoint = defaults[:setpoint][:default]
+      end
+
+      unless @hash[:schedule].nil?
+        schedule_ref = openstudio_model.getScheduleByName(@hash[:schedule])
+        unless schedule_ref.empty?
+            @schedule = schedule_ref.get
+            if @control_type == 'AlwaysOn'
+                @control_type = 'OnIfScheduleAllows'
+            end
+        end
+      end
+
+      @shade_construction
+    end
+
+    def to_openstudio_shading_control(openstudio_model)
+      # add a WindowShadingControl object to a model for a given aperture and room
+      os_shade_control = OpenStudio::Model::ShadingControl.new(@shade_construction)
+
+      # figure out the shading type
+      if @shade_material.is_a? OpenStudio::Model::StandardGlazing
+        shd_type = 'SwitchableGlazing'
+      elsif @shade_material.is_a? OpenStudio::Model::Blind
+        if @shade_location == 'Between'
+          shd_type = 'BetweenGlassBlind'
+        else
+          shd_type = @shade_location + 'Blind'
+        end
+      else
+        if @shade_location == 'Between'
+          shd_type = 'BetweenGlassShade'
+        else
+          shd_type = @shade_location + 'Shade'
+        end
+      end
+      os_shade_control.setShadingType(shd_type)
+
+      # set the shade control type and schedule
+      os_shade_control.setShadingControlType(@control_type)
+      unless @setpoint.nil?
+        os_shade_control.setSetpoint(@setpoint)
+      end
+      unless @schedule.nil?
+        os_shade_control.setSchedule(@schedule)
+      end
+
+      os_shade_control
+    end
+
+    def split_gas_gap(openstudio_model, original_gap, shade_material)
+        # split a gas gap material in two when it is interrupeted by a shade/blind
+        if shade_material.is_a? OpenStudio::Model::Blind
+          shd_thick = 0
+        else
+          shd_thick = shade_material.thickness
+        end
+        gap_thick = (original_gap.thickness - shd_thick) / 2
+        gap_obj = $gas_gap_hash[original_gap.name.get]
+        new_gap = gap_obj.to_openstudio(openstudio_model)
+        new_gap.setName(original_gap.name.get + gap_thick.to_s)
+        new_gap.setThickness(gap_thick)
+        new_gap
+    end
+
+  end #WindowConstructionShadeAbridged
+end #FromHoneybee