honeybee-openstudio 2.25.0 → 2.26.0

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

data/lib/honeybee/model_object.rb

@@ -36,6 +36,13 @@ module Honeybee
 
     attr_reader :errors, :warnings
 
+    @@encoding_options = {
+      :invalid           => :replace,  # Replace invalid byte sequences
+      :undef             => :replace,  # Replace anything not defined in ASCII
+      :replace           => '',        # Use a blank for those replacements
+      :universal_newline => true       # Always break lines with \n
+    }
+
     def method_missing(sym, *args)
       name = sym.to_s
       aname = name.sub('=', '')
@@ -100,12 +107,12 @@ module Honeybee
 
     # remove illegal characters in identifier
     def self.clean_name(str)
-      ascii = str.encode(Encoding.find('ASCII'))
+      ascii = str.encode(Encoding.find('ASCII'), **@@encoding_options)
     end
 
     # remove illegal characters in identifier
     def self.clean_identifier(str)
-      encode_str = str.encode(Encoding.find('ASCII'))
+      encode_str = str.encode(Encoding.find('ASCII'), **@@encoding_options)
       encode_str.gsub(/[^.A-Za-z0-9_-]/, '_').gsub(' ', '_')
     end
 

data/lib/honeybee.rb

@@ -79,6 +79,7 @@ require 'honeybee/load/ventilation'
 require 'honeybee/load/setpoint_thermostat'
 require 'honeybee/load/setpoint_humidistat'
 require 'honeybee/load/daylight'
+require 'honeybee/load/process'
 
 # import the schedule objects
 require 'honeybee/schedule/type_limit'

data/lib/to_openstudio/geometry/room.rb

@@ -382,6 +382,15 @@ module Honeybee
         end
       end
 
+      # assign any process loads if specified
+      if @hash[:properties][:energy][:process_loads]
+        @hash[:properties][:energy][:process_loads].each do |p_load|
+          hb_p_load = ProcessAbridged.new(p_load)
+          os_p_load = hb_p_load.to_openstudio(openstudio_model)
+          os_p_load.setSpace(os_space)
+        end
+      end
+
       os_space
     end
 

data/lib/to_openstudio/load/electric_equipment.rb

@@ -59,6 +59,9 @@ module Honeybee
         os_electric_equip.setSchedule(electric_equipment_schedule_object)
       end
 
+      # ensure that it's always reported under electric equipment
+      os_electric_equip.setEndUseSubcategory('Electric Equipment')
+
       # assign radiant fraction if it exists
       if @hash[:radiant_fraction]
         os_electric_equip_def.setFractionRadiant(@hash[:radiant_fraction])

data/lib/to_openstudio/load/gas_equipment.rb

@@ -60,6 +60,9 @@ module Honeybee
         os_gas_equip.setSchedule(gas_equipment_schedule_object)
       end
 
+      # ensure that it's always reported under electric equipment
+      os_gas_equip.setEndUseSubcategory('Gas Equipment')
+
       # assign radiant fraction if it exists
       if @hash[:radiant_fraction]
         os_gas_equip_def.setFractionRadiant(@hash[:radiant_fraction])

data/lib/to_openstudio/load/process.rb

@@ -0,0 +1,97 @@
+# *******************************************************************************
+# 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/process'
+
+require 'to_openstudio/model_object'
+
+module Honeybee
+  class ProcessAbridged
+
+    def find_existing_openstudio_object(openstudio_model)
+      model_other_equipment = openstudio_model.getOtherEquipmentByName(@hash[:identifier])
+      return model_other_equipment.get unless model_other_equipment.empty?
+      nil
+    end
+
+    def to_openstudio(openstudio_model)
+      # create process load and set identifier
+      os_other_equip_def = OpenStudio::Model::OtherEquipmentDefinition.new(openstudio_model)
+      os_other_equip = OpenStudio::Model::OtherEquipment.new(os_other_equip_def)
+      os_other_equip_def.setName(@hash[:identifier])
+      os_other_equip.setName(@hash[:identifier])
+
+      # assign watts
+      os_other_equip_def.setDesignLevel(@hash[:watts])
+
+      # assign schedule
+      other_equipment_schedule = openstudio_model.getScheduleByName(@hash[:schedule])
+      unless other_equipment_schedule.empty?
+        other_equipment_schedule_object = other_equipment_schedule.get
+        os_other_equip.setSchedule(other_equipment_schedule_object)
+      end
+
+      # assign the fuel type
+      os_other_equip.setFuelType(@hash[:fuel_type])
+
+      # assign the end use category if it exists
+      if @hash[:end_use_category]
+        os_other_equip.setEndUseSubcategory(@hash[:end_use_category])
+      else
+        os_other_equip.setEndUseSubcategory(defaults[:end_use_category][:default])
+      end
+
+      # assign radiant fraction if it exists
+      if @hash[:radiant_fraction]
+        os_other_equip_def.setFractionRadiant(@hash[:radiant_fraction])
+      else
+        os_other_equip_def.setFractionRadiant(defaults[:radiant_fraction][:default])
+      end
+
+      # assign latent fraction if it exists
+      if @hash[:latent_fraction]
+        os_other_equip_def.setFractionLatent(@hash[:latent_fraction])
+      else
+        os_other_equip_def.setFractionLatent(defaults[:latent_fraction][:default])
+      end
+
+      # assign lost fraction if it exists
+      if @hash[:lost_fraction]
+        os_other_equip_def.setFractionLost(@hash[:lost_fraction])
+      else
+        os_other_equip_def.setFractionLost(defaults[:lost_fraction][:default])
+      end
+
+      os_other_equip
+    end
+
+  end #ProcessAbridged
+end #Honeybee

data/lib/to_openstudio/load/service_hot_water.rb

@@ -82,9 +82,6 @@ module Honeybee
         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'
@@ -171,7 +168,7 @@ module Honeybee
           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)
+            heat_pump.setName('SHW HPWH DX Coil' + @@sys_count.to_s)
             if shw_hash[:heater_efficiency].nil?
               heat_pump.setRatedCOP(3.5)
             else

data/lib/to_openstudio.rb

@@ -79,6 +79,7 @@ require 'to_openstudio/load/ventilation'
 require 'to_openstudio/load/setpoint_thermostat'
 require 'to_openstudio/load/setpoint_humidistat'
 require 'to_openstudio/load/daylight'
+require 'to_openstudio/load/process'
 
 # extend the schedule objects
 require 'to_openstudio/schedule/type_limit'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: honeybee-openstudio
 version: !ruby/object:Gem::Version
-  version: 2.25.0
+  version: 2.26.0
 platform: ruby
 authors:
 - Tanushree Charan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-10 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -219,6 +219,7 @@ files:
 - lib/honeybee/load/infiltration.rb
 - lib/honeybee/load/lighting.rb
 - lib/honeybee/load/people.rb
+- lib/honeybee/load/process.rb
 - lib/honeybee/load/service_hot_water.rb
 - lib/honeybee/load/setpoint_humidistat.rb
 - lib/honeybee/load/setpoint_thermostat.rb
@@ -298,6 +299,7 @@ files:
 - lib/to_openstudio/load/infiltration.rb
 - lib/to_openstudio/load/lighting.rb
 - lib/to_openstudio/load/people.rb
+- lib/to_openstudio/load/process.rb
 - lib/to_openstudio/load/service_hot_water.rb
 - lib/to_openstudio/load/setpoint_humidistat.rb
 - lib/to_openstudio/load/setpoint_thermostat.rb