honeybee-openstudio 2.24.0 → 2.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaaa7ddfb52102f325f31d2090e14c7174c3a98ba156859b989b30391a4abbdb
-  data.tar.gz: 5f6fb58c9f9f926fab088fb0c300cbe4527039a984d2bc5d816d72c27f64d7f7
+  metadata.gz: 4e1a8b30344f5ddd1ab1066be049b6dd652a9093a3a7419557d7359a90962803
+  data.tar.gz: cd2cff6c82e3c4a0e49d54b01f1074af4fbf270aaf2fa0a32abd333cb57ff89d
 SHA512:
-  metadata.gz: 47d6f83ad9135c92c77e5924c9d1872c2b2573a2d056f9940bec7f96b7aba8e74c6bcd0aca8cd83766a79c4c8398df88bbf54ae2a29edb8a080cc6d57a6f13ef
-  data.tar.gz: dc582df2f41e9ffe26b67a0c92b0d256dbab7215697573655d4eb50edd6a498ef9f084fd66016f8dfff3882555afacdcb6b558db7d7ed4fabc795145d3df89af
+  metadata.gz: 6880870d22ce32cc6dd217b2ddc86cce39e6402e4134012ab3c135ee6addbdf27bef3738bdc721e09563c865cd476a4d237149a6c54d5d92f41215a7e86bfbc3
+  data.tar.gz: 98fcd830229b574f193d16b0803a608a0b8e126f8fc86c13ab23076e33bd0c9911d065fa9b3fa6104a3ded52e476ab13cfe953dd5682249be420b503147ea6e0

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.24.0'
+  spec.version       = '2.25.0'
   spec.authors       = ['Tanushree Charan', 'Dan Macumber', 'Chris Mackey', 'Mostapha Sadeghipour Roudsari']
   spec.email         = ['tanushree.charan@nrel.gov', 'chris@ladybug.tools']
 

data/lib/to_openstudio/geometry/room.rb

@@ -280,7 +280,8 @@ module Honeybee
       # 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)
+        os_shw_space = shw_space.to_openstudio(
+          openstudio_model, os_space, @hash[:properties][:energy][:shw])
         $shw_for_plant = shw_space
       end
 

data/lib/to_openstudio/load/service_hot_water.rb

@@ -37,7 +37,14 @@ module Honeybee
   class ServiceHotWaterAbridged
     @@max_target_temp = 60
     @@max_temp_schedule = nil
-    @@shw_connections = []
+    @@shw_connections = {}
+    @@shw_rates = {}
+    @@hp_deadband = 4
+    @@sys_count = 1
+
+    def shw_connections
+      @@shw_connections
+    end
 
     def find_existing_openstudio_object(openstudio_model)
       model_shw = openstudio_model.getWaterUseEquipmentByName(@hash[:identifier])
@@ -45,51 +52,188 @@ module Honeybee
       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)
+    def add_hot_water_plants(openstudio_model, shw_hashes)
+      # add district hot water loops to supply all of the shw_connections
+      shw_hashes.each do |shw_hash|
+        # create the plant loop
+        hot_water_plant = OpenStudio::Model::PlantLoop.new(openstudio_model)
+        hot_water_plant.setName('SHW Loop ' + shw_hash[:identifier])
+        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('SHW Pump' + @@sys_count.to_s)
+        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())
+        if shw_hash[:equipment_type] != 'Default_District_SHW'
+          hot_water_pump.setEndUseSubcategory('Water Systems')
+        end
+
+        eq_type = shw_hash[:equipment_type]
+        if eq_type == 'Default_District_SHW'
+          # 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)
+        elsif eq_type == 'Gas_WaterHeater' || eq_type == 'Electric_WaterHeater' || eq_type == 'HeatPump_WaterHeater'
+          # add a water heater to supply the heat for the loop
+          heater = OpenStudio::Model::WaterHeaterMixed.new(openstudio_model)
+          if eq_type == 'Electric_WaterHeater' || eq_type == 'HeatPump_WaterHeater'
+            heater.setHeaterFuelType('Electricity')
+            heater.setOffCycleParasiticFuelType('Electricity')
+            heater.setOnCycleParasiticFuelType('Electricity')
+          end
+          heater.setName('SHW WaterHeater' + @@sys_count.to_s)
+
+          # set the water heater efficiency
+          if eq_type == 'HeatPump_WaterHeater'
+            heater.setHeaterThermalEfficiency(1.0)
+          elsif shw_hash[:heater_efficiency].nil?
+            if eq_type == 'Electric_WaterHeater'
+              heater.setHeaterThermalEfficiency(1.0)
+            else
+              heater.setHeaterThermalEfficiency(0.8)
+            end
+          else
+            heater.setHeaterThermalEfficiency(shw_hash[:heater_efficiency])
+          end
+
+          # set the ambient condition of the water tank
+          to_thermal_zone = false
+          unless shw_hash[:ambient_condition].nil?
+            if shw_hash[:ambient_condition].is_a? Numeric
+              target_sch_name = shw_hash[:ambient_condition].to_s + 'C Ambient Condition'
+              target_sch = create_constant_schedule(
+                openstudio_model, target_sch_name, shw_hash[:ambient_condition])
+              heater.setAmbientTemperatureSchedule(target_sch)
+            else
+              source_zone_ref = openstudio_model.getThermalZoneByName(shw_hash[:ambient_condition])
+              unless source_zone_ref.empty?
+                source_zone = source_zone_ref.get
+                heater.setAmbientTemperatureThermalZone(source_zone)
+              end
+              heater.setAmbientTemperatureIndicator('ThermalZone')
+              to_thermal_zone = true
+            end
+          else
+            target_sch_name = '22C Ambient Condition'
+            target_sch = create_constant_schedule(openstudio_model, target_sch_name, 22)
+            heater.setAmbientTemperatureSchedule(target_sch)
+          end
+
+          # set the ambient loss coefficient
+          if to_thermal_zone
+            unless shw_hash[:ambient_loss_coefficient].nil?
+              heater.setOffCycleLossFractiontoThermalZone(
+                shw_hash[:ambient_loss_coefficient])
+              heater.setOnCycleLossFractiontoThermalZone(
+                shw_hash[:ambient_loss_coefficient])
+            else
+              heater.setOffCycleLossFractiontoThermalZone(6)
+              heater.setOnCycleLossFractiontoThermalZone(6)
+            end
+          else
+            unless shw_hash[:ambient_loss_coefficient].nil?
+              heater.setOffCycleLossCoefficienttoAmbientTemperature(
+                shw_hash[:ambient_loss_coefficient])
+              heater.setOnCycleLossCoefficienttoAmbientTemperature(
+                shw_hash[:ambient_loss_coefficient])
+            else
+              heater.setOffCycleLossCoefficienttoAmbientTemperature(6)
+              heater.setOnCycleLossCoefficienttoAmbientTemperature(6)
+            end
+          end
+
+          # ensure that the tank is sized appropriately and add it to the loop
+          heater.setHeaterMaximumCapacity(1000000)
+          heater.setTankVolume(@@shw_rates[shw_hash[:identifier]])
+          hot_water_plant.addSupplyBranchForComponent(heater)
+          
+          # if it's a heat pump system, then add the pump
+          if eq_type == 'HeatPump_WaterHeater'
+            # create a coil for the heat pump
+            heat_pump = OpenStudio::Model::CoilWaterHeatingAirToWaterHeatPump.new(openstudio_model)
+            heat_pump.setName('HPWH DX Coil' + @@sys_count.to_s)
+            if shw_hash[:heater_efficiency].nil?
+              heat_pump.setRatedCOP(3.5)
+            else
+              heat_pump.setRatedCOP(shw_hash[:heater_efficiency])
+            end
+
+            # add a fan for the heat pump system
+            fan = OpenStudio::Model::FanOnOff.new(openstudio_model)
+            fan.setName('HPWH Fan' + @@sys_count.to_s)
+            fan.setEndUseSubcategory('Water Systems')
+            setpt_sch = create_constant_schedule(
+              openstudio_model, 'HPWH Setpoint' + @@sys_count.to_s, @@max_target_temp + (@@hp_deadband * 2))
+            inlet_sch = create_constant_schedule(
+              openstudio_model, 'Inlet Air Mixer Fraction' + @@sys_count.to_s, 0.2)
+
+            # add a water heater to supply the heat for the loop
+            heat_sys = OpenStudio::Model::WaterHeaterHeatPump.new(
+              openstudio_model, heat_pump, heater, fan, setpt_sch, inlet_sch)
+            heat_sys.setDeadBandTemperatureDifference(@@hp_deadband)
+            
+            source_zone_ref = openstudio_model.getThermalZoneByName(shw_hash[:ambient_condition])
+            unless source_zone_ref.empty?
+              source_zone = source_zone_ref.get
+              heat_sys.addToThermalZone(source_zone)
+            end
+            heat_sys.setName('SHW WaterHeater HeatPump' + @@sys_count.to_s)
+          end
+
+        elsif eq_type == 'Gas_TanklessHeater' || eq_type == 'Electric_TanklessHeater'
+          # add a boiler to supply the heat for the loop
+          heater = OpenStudio::Model::BoilerHotWater.new(openstudio_model)
+          if eq_type == 'Electric_TanklessHeater'
+            heater.setFuelType('Electricity')
+          end
+          heater.setName('SHW Tankless WaterHeater' + @@sys_count.to_s)
+          heater.setEndUseSubcategory('Water Systems')
+
+          # set the water heater efficiency
+          unless shw_hash[:heater_efficiency].nil?
+            heater.setNominalThermalEfficiency(shw_hash[:heater_efficiency])
+          else
+            if eq_type == 'Electric_TanklessHeater'
+              heater.setNominalThermalEfficiency(1.0)
+            else
+              heater.setNominalThermalEfficiency(0.8)
+            end
+          end
+
+          # ensure that the boiler is sized appropriately and add it to the loop
+          heater.setNominalCapacity(1000000)
+          hot_water_plant.addSupplyBranchForComponent(heater)
+        end
+
+        # add all of the water use connections to the loop and total the capacity
+        @@shw_connections[shw_hash[:identifier]].each do |shw_conn|
+          hot_water_plant.addDemandBranchForComponent(shw_conn)
+        end
+        @@sys_count = @@sys_count + 1
       end
-  
-      hot_water_plant
     end
 
-    def to_openstudio(openstudio_model, os_space)
+    def to_openstudio(openstudio_model, os_space, shw_name)
       # 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)
@@ -101,6 +245,10 @@ module Honeybee
       total_flow = (@hash[:flow_per_area].to_f * os_space.floorArea) / 3600000
       os_shw_def.setPeakFlowRate(total_flow)
       os_shw_def.setEndUseSubcategory('General')
+      if @@shw_rates[shw_name].nil?
+        @@shw_rates[shw_name] = 0
+      end
+      @@shw_rates[shw_name] = @@shw_rates[shw_name] + (total_flow * 3600)
 
       # assign schedule
       shw_schedule = openstudio_model.getScheduleByName(@hash[:schedule])
@@ -126,7 +274,13 @@ module Honeybee
         @@max_target_temp = target_temp
         @@max_temp_schedule = target_water_sch
       end
-      @@shw_connections << os_shw_conn
+      if shw_name.nil?
+        shw_name = 'default_district_shw'
+      end
+      if @@shw_connections[shw_name].nil?
+        @@shw_connections[shw_name] = []
+      end
+      @@shw_connections[shw_name] << os_shw_conn
 
       # assign sensible fraction if it exists
       sens_fract = defaults[:sensible_fraction][:default]

data/lib/to_openstudio/model.rb

@@ -448,7 +448,8 @@ module Honeybee
             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)
+              openstudio_shw = shw_object.to_openstudio(
+                @openstudio_model, openstudio_room, room[:properties][:energy][:shw])
               $shw_for_plant = shw_object
             end
           end
@@ -570,7 +571,18 @@ module Honeybee
     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)
+        if @hash[:properties][:energy][:shws].nil?
+          shw_list = []
+        else
+          shw_list = @hash[:properties][:energy][:shws]
+        end
+        unless $shw_for_plant.shw_connections['default_district_shw'].nil?
+          def_hash = {}
+          def_hash[:equipment_type] = 'Default_District_SHW'
+          def_hash[:identifier] = 'default_district_shw'
+          shw_list << def_hash
+        end
+        $shw_for_plant.add_hot_water_plants(@openstudio_model, shw_list)
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeybee-openstudio
 version: !ruby/object:Gem::Version
-  version: 2.24.0
+  version: 2.25.0
 platform: ruby
 authors:
 - Tanushree Charan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-02 00:00:00.000000000 Z
+date: 2021-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler