honeybee-openstudio 2.9.2 → 2.10.0

data/lib/honeybee/_defaults/simulation-parameter.json

@@ -2,9 +2,9 @@
   "openapi": "3.0.2",
   "servers": [],
   "info": {
-    "description": "This is the documentation for Honeybee energy simulation parameter schema.",
-    "version": "1.36.0",
-    "title": "Honeybee Energy Simulation Parameter Schema",
+    "description": "Honeybee simulation-parameter schema.",
+    "version": "1.39.12",
+    "title": "Honeybee Simulation Parameter Schema",
     "contact": {
       "name": "Ladybug Tools",
       "email": "info@ladybug.tools",
@@ -186,7 +186,6 @@
             "readOnly": true
           },
           "reporting_frequency": {
-            "title": "Reporting Frequency",
             "default": "Hourly",
             "allOf": [
               {
@@ -327,7 +326,6 @@
             }
           },
           "start_day_of_week": {
-            "title": "Start Day Of Week",
             "description": "Text for the day of the week on which the simulation starts.",
             "default": "Sunday",
             "allOf": [
@@ -456,7 +454,6 @@
             "readOnly": true
           },
           "solar_distribution": {
-            "title": "Solar Distribution",
             "default": "FullExteriorWithReflections",
             "allOf": [
               {
@@ -465,7 +462,6 @@
             ]
           },
           "calculation_method": {
-            "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",
             "allOf": [
@@ -475,7 +471,6 @@
             ]
           },
           "calculation_update_method": {
-            "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",
             "allOf": [
@@ -515,7 +510,6 @@
           "Wednesday",
           "Thursday",
           "Friday",
-          "Saturday",
           "Holiday",
           "CustomDay1",
           "CustomDay2"
@@ -573,12 +567,7 @@
         "type": "object",
         "properties": {
           "humidity_type": {
-            "title": "Humidity Type",
-            "allOf": [
-              {
-                "$ref": "#/components/schemas/HumidityTypes"
-              }
-            ]
+            "$ref": "#/components/schemas/HumidityTypes"
           },
           "humidity_value": {
             "title": "Humidity Value",
@@ -766,12 +755,7 @@
             "type": "string"
           },
           "day_type": {
-            "title": "Day Type",
-            "allOf": [
-              {
-                "$ref": "#/components/schemas/DesignDayTypes"
-              }
-            ]
+            "$ref": "#/components/schemas/DesignDayTypes"
           },
           "dry_bulb_condition": {
             "title": "Dry Bulb Condition",
@@ -956,7 +940,6 @@
             "format": "double"
           },
           "terrain_type": {
-            "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",
             "allOf": [

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

data/lib/to_openstudio.rb

@@ -72,6 +72,7 @@ require 'to_openstudio/load/people'
 require 'to_openstudio/load/lighting'
 require 'to_openstudio/load/electric_equipment'
 require 'to_openstudio/load/gas_equipment'
+require 'to_openstudio/load/service_hot_water'
 require 'to_openstudio/load/infiltration'
 require 'to_openstudio/load/ventilation'
 require 'to_openstudio/load/setpoint_thermostat'

data/lib/to_openstudio/geometry/room.rb

@@ -269,6 +269,13 @@ module Honeybee
         os_custom_gas_equipment.setSpaceType(unique_program)  # assign the new load definition
       end
 
+      # assign service hot water if it exists
+      if @hash[:properties][:energy][:service_hot_water]
+        shw_space = ServiceHotWaterAbridged.new(@hash[:properties][:energy][:service_hot_water])
+        os_shw_space = shw_space.to_openstudio(openstudio_model, os_space)
+        $shw_for_plant = shw_space
+      end
+
       # assign infiltration if it exists
       if @hash[:properties][:energy][:infiltration] && $use_simple_vent  # only use infiltration with simple ventilation
         unique_program = get_unique_space_type(openstudio_model, os_space)

data/lib/to_openstudio/load/electric_equipment.rb

@@ -37,7 +37,7 @@ module Honeybee
   class ElectricEquipmentAbridged
 
     def find_existing_openstudio_object(openstudio_model)
-      model_electric_equipment = openstudio_model.getElectricEquipmentDefinitionByName(@hash[:identifier])
+      model_electric_equipment = openstudio_model.getElectricEquipmentByName(@hash[:identifier])
       return model_electric_equipment.get unless model_electric_equipment.empty?
       nil
     end

data/lib/to_openstudio/load/gas_equipment.rb

@@ -37,7 +37,7 @@ module Honeybee
   class GasEquipmentAbridged
 
     def find_existing_openstudio_object(openstudio_model)
-      model_gas_equipment = openstudio_model.getGasEquipmentDefinitionByName(@hash[:identifier])
+      model_gas_equipment = openstudio_model.getGasEquipmentByName(@hash[:identifier])
       return model_gas_equipment.get unless model_gas_equipment.empty?
       nil
     end

data/lib/to_openstudio/load/lighting.rb

@@ -37,7 +37,7 @@ module Honeybee
   class LightingAbridged
 
     def find_existing_openstudio_object(openstudio_model)
-      model_lights = openstudio_model.getLightsDefinitionByName(@hash[:identifier])
+      model_lights = openstudio_model.getLightsByName(@hash[:identifier])
       return model_lights.get unless model_lights.empty?
       nil
     end

data/lib/to_openstudio/load/people.rb

@@ -37,7 +37,7 @@ module Honeybee
   class PeopleAbridged
 
     def find_existing_openstudio_object(openstudio_model)
-      model_people = openstudio_model.getPeopleDefinitionByName(@hash[:identifier])
+      model_people = openstudio_model.getPeopleByName(@hash[:identifier])
       return model_people.get unless model_people.empty?
       nil
     end

data/lib/to_openstudio/load/service_hot_water.rb

@@ -0,0 +1,170 @@
+# *******************************************************************************
+# 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/load/service_hot_water'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class ServiceHotWaterAbridged
+    @@max_target_temp = 60
+    @@max_temp_schedule = nil
+    @@shw_connections = []
+
+    def find_existing_openstudio_object(openstudio_model)
+      model_shw = openstudio_model.getWaterUseEquipmentByName(@hash[:identifier])
+      return model_shw.get unless model_shw.empty?
+      nil
+    end
+
+    def add_district_hot_water_plant(openstudio_model)
+      # add a defaul district hot water system to supply all of the shw_connections
+      # create the plant loop
+      hot_water_plant = OpenStudio::Model::PlantLoop.new(openstudio_model)
+      hot_water_plant.setName('Service Hot Water Loop')
+      hot_water_plant.setMaximumLoopTemperature(@@max_target_temp)
+      hot_water_plant.setMinimumLoopTemperature(10)  # default value in C from OpenStudio Application
+
+      # edit the sizing information to be for a hot water loop
+      loop_sizing = hot_water_plant.sizingPlant()
+      loop_sizing.setLoopType('Heating')
+      loop_sizing.setDesignLoopExitTemperature(@@max_target_temp)  
+      loop_sizing.setLoopDesignTemperatureDifference(5)  # default value in C from OpenStudio Application
+
+      # add a setpoint manager for the loop
+      hot_sch = @@max_temp_schedule
+      if @@max_temp_schedule.nil?
+        hot_sch_name = @@max_target_temp.to_s + 'C Hot Water'
+        hot_sch = create_constant_schedule(openstudio_model, hot_sch_name, @@max_target_temp)
+      end
+      sp_manager = OpenStudio::Model::SetpointManagerScheduled.new(openstudio_model, hot_sch)
+      sp_manager.addToNode(hot_water_plant.supplyOutletNode())
+
+      # add a constant speed pump for the loop
+      hot_water_pump = OpenStudio::Model::PumpConstantSpeed.new(openstudio_model)
+      hot_water_pump.setName('Service Hot Water Pump')
+      hot_water_pump.setRatedPumpHead(29891)  # default value in Pa from OpenStudio Application
+      hot_water_pump.setMotorEfficiency(0.9)  # default value from OpenStudio Application
+      hot_water_pump.addToNode(hot_water_plant.supplyInletNode())
+
+      # add a district heating system to supply the heat for the loop
+      district_hw = OpenStudio::Model::DistrictHeating.new(openstudio_model)
+      district_hw.setName('Service Hot Water District Heat')
+      district_hw.setNominalCapacity(1000000)
+      hot_water_plant.addSupplyBranchForComponent(district_hw)
+
+      # add all of the water use connections to the loop
+      @@shw_connections.each do |shw_conn|
+        hot_water_plant.addDemandBranchForComponent(shw_conn)
+      end
+  
+      hot_water_plant
+    end
+
+    def to_openstudio(openstudio_model, os_space)
+      # create water use equipment + connection and set identifier
+      os_shw_def = OpenStudio::Model::WaterUseEquipmentDefinition.new(openstudio_model)
+      os_shw = OpenStudio::Model::WaterUseEquipment.new(os_shw_def)
+      unique_id = @hash[:identifier] + '..' + os_space.nameString
+      os_shw_def.setName(unique_id)
+      os_shw.setName(unique_id)
+
+      # assign the flow of water
+      total_flow = (@hash[:flow_per_area].to_f * os_space.floorArea) / 3600000
+      os_shw_def.setPeakFlowRate(total_flow)
+      os_shw_def.setEndUseSubcategory('General')
+
+      # assign schedule
+      shw_schedule = openstudio_model.getScheduleByName(@hash[:schedule])
+      unless shw_schedule.empty?
+        shw_schedule_object = shw_schedule.get
+        os_shw.setFlowRateFractionSchedule(shw_schedule_object)
+      end
+
+      # assign the hot water temperature
+      target_temp = defaults[:target_temperature][:default]
+      if @hash[:target_temperature]
+        target_temp = @hash[:target_temperature]
+      end
+      target_sch_name = target_temp.to_s + 'C Hot Water'
+      target_water_sch = create_constant_schedule(openstudio_model, target_sch_name, target_temp)
+      os_shw_def.setTargetTemperatureSchedule(target_water_sch)
+
+      # create the hot water connection with same temperature as target temperature
+      os_shw_conn = OpenStudio::Model::WaterUseConnections.new(openstudio_model)
+      os_shw_conn.addWaterUseEquipment(os_shw)
+      os_shw_conn.setHotWaterSupplyTemperatureSchedule(target_water_sch)
+      if target_temp > @@max_target_temp
+        @@max_target_temp = target_temp
+        @@max_temp_schedule = target_water_sch
+      end
+      @@shw_connections << os_shw_conn
+
+      # assign sensible fraction if it exists
+      sens_fract = defaults[:sensible_fraction][:default]
+      if @hash[:sensible_fraction]
+        sens_fract = @hash[:sensible_fraction]
+      end
+      sens_sch_name = sens_fract.to_s + ' Hot Water Sensible Fraction'
+      sens_fract_sch = create_constant_schedule(openstudio_model, sens_sch_name, sens_fract)
+      os_shw_def.setSensibleFractionSchedule(sens_fract_sch)
+
+      # assign latent fraction if it exists
+      lat_fract = defaults[:latent_fraction][:default]
+      if @hash[:latent_fraction]
+        lat_fract = @hash[:latent_fraction]
+      end
+      lat_sch_name = lat_fract.to_s + ' Hot Water Latent Fraction'
+      lat_fract_sch = create_constant_schedule(openstudio_model, lat_sch_name, lat_fract)
+      os_shw_def.setLatentFractionSchedule(lat_fract_sch)
+
+      # assign the service hot water to the space
+      os_shw.setSpace(os_space)
+
+      os_shw
+    end
+
+    private
+
+    def create_constant_schedule(openstudio_model, schedule_name, value)
+      # check if a constant schedule already exists and, if not, create it
+      exist_schedule = openstudio_model.getScheduleByName(schedule_name)
+      if exist_schedule.empty?  # create the schedule
+        os_sch_ruleset = OpenStudio::Model::ScheduleRuleset.new(openstudio_model, value)
+        os_sch_ruleset.setName(schedule_name)
+      else
+        os_sch_ruleset = exist_schedule.get
+      end
+      os_sch_ruleset
+    end
+
+  end #ServiceHotWaterAbridged
+end #Honeybee

data/lib/to_openstudio/model.rb

@@ -86,8 +86,10 @@ module Honeybee
       $gas_gap_hash = Hash.new  # hash to track gas gaps in case they are split by shades
       $air_boundary_hash = Hash.new  # hash to track any air boundary constructions
       $window_shade_hash = Hash.new  # hash to track any window constructions with shade
+      $programtype_shw_hash = Hash.new  # hash to track ServiceHotWater objects
       $programtype_setpoint_hash = Hash.new  # hash to track Setpoint objects
       $interior_afn_srf_hash = Hash.new  # track whether an adjacent surface is already in the AFN
+      $shw_for_plant = nil  # track whether a hot water plant is needed
 
       # create all of the non-geometric model elements
       if log_report  # schedules are used by all other objects and come first
@@ -151,6 +153,7 @@ module Honeybee
         puts 'Translating HVAC Systems'
       end
       create_hvacs
+      create_hot_water_plant
 
       if log_report
         puts 'Translating Context Shade Geometry'
@@ -361,6 +364,17 @@ module Honeybee
           room_object = Room.new(room)
           openstudio_room = room_object.to_openstudio(@openstudio_model)
 
+          # for rooms with hot water objects definied in the ProgramType, make a new WaterUse:Equipment
+          if room[:properties][:energy][:program_type] && !room[:properties][:energy][:service_hot_water]
+            program_type_id = room[:properties][:energy][:program_type]
+            shw_hash = $programtype_shw_hash[program_type_id]
+            unless shw_hash.nil?
+              shw_object = ServiceHotWaterAbridged.new(shw_hash)
+              openstudio_shw = shw_object.to_openstudio(@openstudio_model, openstudio_room)
+              $shw_for_plant = shw_object
+            end
+          end
+
           # for rooms with setpoint objects definied in the ProgramType, make a new thermostat
           if room[:properties][:energy][:program_type] && !room[:properties][:energy][:setpoint]
             thermal_zone = openstudio_room.thermalZone()
@@ -368,7 +382,7 @@ module Honeybee
               thermal_zone_object = thermal_zone.get
               program_type_id = room[:properties][:energy][:program_type]
               setpoint_hash = $programtype_setpoint_hash[program_type_id]
-              if not setpoint_hash.nil?  # program type has no setpoint
+              unless setpoint_hash.nil?  # program type has no setpoint
                 thermostat_object = SetpointThermostat.new(setpoint_hash)
                 openstudio_thermostat = thermostat_object.to_openstudio(@openstudio_model)
                 thermal_zone_object.setThermostatSetpointDualSetpoint(openstudio_thermostat)
@@ -467,6 +481,13 @@ module Honeybee
       end
     end
 
+    def create_hot_water_plant
+      # create a hot water plant if there's any service hot water in the model
+      unless $shw_for_plant.nil?
+        $shw_for_plant.add_district_hot_water_plant(@openstudio_model)
+      end
+    end
+
     def create_orphaned_shades
       if @hash[:orphaned_shades]
         shading_surface_group = OpenStudio::Model::ShadingSurfaceGroup.new(@openstudio_model)

data/lib/to_openstudio/program_type.rb

@@ -75,6 +75,11 @@ module Honeybee
         os_gas_equipment.setSpaceType(os_space_type)
       end
 
+      # add hot water from to a global hash that will be used to assign them to rooms
+      if @hash[:service_hot_water]
+        $programtype_shw_hash[@hash[:identifier]] = @hash[:service_hot_water]
+      end
+
       # assign infiltration
       if @hash[:infiltration] && $use_simple_vent  # only use infiltration with simple ventilation
         infiltration = InfiltrationAbridged.new(@hash[:infiltration])

data/lib/to_openstudio/simulation/parameter_model.rb

@@ -237,6 +237,10 @@ module Honeybee
       if @hash[:terrain_type]
         os_site.setTerrain(@hash[:terrain_type])
       end
+
+      # ensure water mains temperatures are written
+      os_water_mains = @openstudio_model.getSiteWaterMainsTemperature 
+      os_water_mains.setCalculationMethod('CorrelationFromWeatherFile')
     end
 
   end #SimulationParameter