openstudio-standards 0.1.4 → 0.1.5

data/lib/openstudio-standards/prototypes/Prototype.small_office.rb

@@ -1,85 +1,77 @@
 
 # Extend the class to add Small Office specific stuff
 class OpenStudio::Model::Model
- 
-  def define_space_type_map(building_type, building_vintage, climate_zone)
+  def define_space_type_map(building_type, template, climate_zone)
     space_type_map = nil
-    
-    case building_vintage
-    when 'NECB 2011'
-      space_type_map ={
-        "- undefined -" => ["Attic"],
-        "Office - enclosed" => ["Core_ZN", "Perimeter_ZN_1", "Perimeter_ZN_2", "Perimeter_ZN_3", "Perimeter_ZN_4"]
-      }
-    else
-      space_type_map = {
-        'WholeBuilding - Sm Office' => ['Perimeter_ZN_1', 'Perimeter_ZN_2', 'Perimeter_ZN_3', 'Perimeter_ZN_4', 'Core_ZN'],
-        'Attic' => ['Attic']
-      }
-    end
-    return space_type_map
 
+    space_type_map = case template
+                     when 'NECB 2011'
+                       # dom = ?
+                       {
+                         '- undefined -' => ['Attic'],
+                         'Office - enclosed' => ['Core_ZN', 'Perimeter_ZN_1', 'Perimeter_ZN_2', 'Perimeter_ZN_3', 'Perimeter_ZN_4']
+                       }
+                     else
+                       {
+                         'WholeBuilding - Sm Office' => ['Perimeter_ZN_1', 'Perimeter_ZN_2', 'Perimeter_ZN_3', 'Perimeter_ZN_4', 'Core_ZN'],
+                         'Attic' => ['Attic']
+                       }
+                     end
+    return space_type_map
   end
 
-  def define_hvac_system_map(building_type, building_vintage, climate_zone)
-
+  def define_hvac_system_map(building_type, template, climate_zone)
     system_to_space_map = [
       {
         'type' => 'PSZ-AC',
         'name' => 'PSZ-AC-2',
         'space_names' =>
           [
-          'Perimeter_ZN_1'
-        ]
+            'Perimeter_ZN_1'
+          ]
       },
       {
         'type' => 'PSZ-AC',
         'name' => 'PSZ-AC-3',
         'space_names' =>
           [
-          'Perimeter_ZN_2'
-        ]
+            'Perimeter_ZN_2'
+          ]
       },
       {
         'type' => 'PSZ-AC',
         'name' => 'PSZ-AC-4',
         'space_names' =>
           [
-          'Perimeter_ZN_3'
-        ]
+            'Perimeter_ZN_3'
+          ]
       },
       {
         'type' => 'PSZ-AC',
         'name' => 'PSZ-AC-5',
         'space_names' =>
           [
-          'Perimeter_ZN_4'
-        ]
+            'Perimeter_ZN_4'
+          ]
       },
       {
         'type' => 'PSZ-AC',
         'name' => 'PSZ-AC-1',
         'space_names' =>
           [
-          'Core_ZN'
-        ]
+            'Core_ZN'
+          ]
       }
     ]
 
     return system_to_space_map
-
   end
 
-  def custom_hvac_tweaks(building_type, building_vintage, climate_zone, prototype_input)
-   
+  def custom_hvac_tweaks(building_type, template, climate_zone, prototype_input)
     return true
-    
   end
 
-  def custom_swh_tweaks(building_type, building_vintage, climate_zone, prototype_input)
-   
+  def custom_swh_tweaks(building_type, template, climate_zone, prototype_input)
     return true
-    
   end
-  
 end

data/lib/openstudio-standards/prototypes/Prototype.strip_model.rb

@@ -1,18 +1,18 @@
 require 'openstudio'
 require_relative 'Prototype.utilities'
 
-full_filename = "2004.osm"
+full_filename = '2004.osm'
 
 if full_filename && (File.file?(full_filename) || File.file?(File.join(Dir.pwd, full_filename)))
-	model = safe_load_model(full_filename)
+  model = safe_load_model(full_filename)
 
-	model = strip_model(model)
+  model = strip_model(model)
 
-	new_path = OpenStudio::Path.new("#{Dir.pwd}/stripped_model.osm")
+  new_path = OpenStudio::Path.new("#{Dir.pwd}/stripped_model.osm")
 
-	model.save(new_path, true)
+  model.save(new_path, true)
 
-	puts "Stripped model was saved to #{new_path}"
+  puts "Stripped model was saved to #{new_path}"
 else
-	puts "Pass a valid file path to this script"
+  puts 'Pass a valid file path to this script'
 end

data/lib/openstudio-standards/prototypes/Prototype.utilities.rb

@@ -1,195 +1,217 @@
 
-#load a model into OS & version translates, exiting and erroring if a problem is found
-def safe_load_model(model_path_string)  
+# load a model into OS & version translates, exiting and erroring if a problem is found
+def safe_load_model(model_path_string)
   model_path = OpenStudio::Path.new(model_path_string)
-  if OpenStudio::exists(model_path)
-    versionTranslator = OpenStudio::OSVersion::VersionTranslator.new 
-    model = versionTranslator.loadModel(model_path)
+  if OpenStudio.exists(model_path)
+    version_translator = OpenStudio::OSVersion::VersionTranslator.new
+    model = version_translator.loadModel(model_path)
     if model.empty?
-      OpenStudio::logFree(OpenStudio::Error, 'openstudio.model.Model', "Version translation failed for #{model_path_string}")
+      OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Model', "Version translation failed for #{model_path_string}")
       return false
     else
       model = model.get
     end
   else
-    OpenStudio::logFree(OpenStudio::Error, 'openstudio.model.Model', "#{model_path_string} couldn't be found")
+    OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Model', "#{model_path_string} couldn't be found")
     return false
   end
   return model
 end
 
-#load a sql file, exiting and erroring if a problem is found
+# load a sql file, exiting and erroring if a problem is found
 def safe_load_sql(sql_path_string)
   sql_path = OpenStudio::Path.new(sql_path_string)
-  if OpenStudio::exists(sql_path)
+  if OpenStudio.exists(sql_path)
     sql = OpenStudio::SqlFile.new(sql_path)
   else
-    OpenStudio::logFree(OpenStudio::Error, 'openstudio.model.Model', "#{sql_path} couldn't be found")
+    OpenStudio.logFree(OpenStudio::Error, 'openstudio.model.Model', "#{sql_path} couldn't be found")
     return false
   end
   return sql
 end
 
 def strip_model(model)
+  # remove all materials
+  model.getMaterials.each(&:remove)
 
+  # remove all constructions
+  model.getConstructions.each(&:remove)
 
-  #remove all materials
-  model.getMaterials.each do |mat|
-    mat.remove
-  end
-
-  #remove all constructions
-  model.getConstructions.each do |constr|
-    constr.remove
-  end
+  # remove performance curves
+  model.getCurves.each(&:remove)
 
-  #remove performance curves
-  model.getCurves.each do |curve|
-    curve.remove
-  end
-
-  #remove all zone equipment
+  # remove all zone equipment
   model.getThermalZones.each do |zone|
-    zone.equipment.each do |equip|
-      equip.remove
-    end
-  end
-    
-  #remove all thermostats
-  model.getThermostatSetpointDualSetpoints.each do |tstat|
-    tstat.remove
+    zone.equipment.each(&:remove)
   end
 
-  #remove all people
-  model.getPeoples.each do |people|
-    people.remove
-  end
-  model.getPeopleDefinitions.each do |people_def|
-    people_def.remove
-  end
+  # remove all thermostats
+  model.getThermostatSetpointDualSetpoints.each(&:remove)
 
-  #remove all lights
-  model.getLightss.each do |lights|
-   lights.remove
-  end
-  model.getLightsDefinitions.each do |lights_def|
-   lights_def.remove
-  end
+  # remove all people
+  model.getPeoples.each(&:remove)
+  model.getPeopleDefinitions.each(&:remove)
 
-  #remove all electric equipment
-  model.getElectricEquipments.each do |equip|
-    equip.remove
-  end
-  model.getElectricEquipmentDefinitions.each do |equip_def|
-    equip_def.remove
-  end
+  # remove all lights
+  model.getLightss.each(&:remove)
+  model.getLightsDefinitions.each(&:remove)
 
-  #remove all gas equipment
-  model.getGasEquipments.each do |equip|
-    equip.remove
-  end
-  model.getGasEquipmentDefinitions.each do |equip_def|
-    equip_def.remove
-  end
+  # remove all electric equipment
+  model.getElectricEquipments.each(&:remove)
+  model.getElectricEquipmentDefinitions.each(&:remove)
 
-  #remove all outdoor air
-  model.getDesignSpecificationOutdoorAirs.each do |oa_spec|
-    oa_spec.remove
-  end
+  # remove all gas equipment
+  model.getGasEquipments.each(&:remove)
+  model.getGasEquipmentDefinitions.each(&:remove)
 
-  #remove all infiltration
-  model.getSpaceInfiltrationDesignFlowRates.each do |infil|
-    infil.remove
-  end
+  # remove all outdoor air
+  model.getDesignSpecificationOutdoorAirs.each(&:remove)
+
+  # remove all infiltration
+  model.getSpaceInfiltrationDesignFlowRates.each(&:remove)
 
   # Remove all internal mass
-  model.getInternalMasss.each do |tm|
-    tm.remove
-  end
+  model.getInternalMasss.each(&:remove)
 
   # Remove all internal mass defs
-  model.getInternalMassDefinitions.each do |tmd|
-    tmd.remove
-  end
-  
+  model.getInternalMassDefinitions.each(&:remove)
+
   # Remove all thermal zones
-  model.getThermalZones.each do |zone|
-    zone.remove
-  end
-  
+  model.getThermalZones.each(&:remove)
+
   # Remove all schedules
-  model.getSchedules.each do |sch|
-    sch.remove
-  end
-  
+  model.getSchedules.each(&:remove)
+
   # Remove all schedule type limits
-  model.getScheduleTypeLimitss.each do |typ_lim|
-    typ_lim.remove
-  end
-  
+  model.getScheduleTypeLimitss.each(&:remove)
+
   # Remove the sizing parameters
   model.getSizingParameters.remove
-  
+
   # Remove the design days
-  model.getDesignDays.each do |dd|
-    dd.remove
-  end
+  model.getDesignDays.each(&:remove)
 
   # Remove the rendering colors
-  model.getRenderingColors.each do |rc|
-    rc.remove
-  end
-  
+  model.getRenderingColors.each(&:remove)
+
   # Remove the daylight controls
-  model.getDaylightingControls.each do |dc|
-    dc.remove
-  end
-  
+  model.getDaylightingControls.each(&:remove)
+
   return model
+end
 
+# Convert from SEER to COP (no fan) for cooling coils
+# per the method specified in 90.1-2013 Appendix G
+#
+# @param seer [Double] seasonal energy efficiency ratio (SEER)
+# @return [Double] Coefficient of Performance (COP)
+def seer_to_cop_cooling_no_fan(seer)
+  cop = -0.0076 * seer * seer + 0.3796 * seer
 
+  return cop
 end
 
-# Convert from SEER to COP
-# per the method specified in "Achieving the 30% Goal: Energy 
-# and cost savings analysis of ASHRAE Standard 90.1-2010
-# Thornton, et al 2011
+# Convert from COP_H to COP (no fan) for heat pump heating coils
+# per the method specified in 90.1-2013 Appendix G
 #
-# @param seer [Double] seasonal energy efficiency ratio (SEER)
+# @param coph47 [Double] coefficient of performance at 47F Tdb, 42F Twb
+# @param capacity_w [Double] the heating capacity at AHRI rating conditions, in W
 # @return [Double] Coefficient of Performance (COP)
-def seer_to_cop(seer)
-  
-  cop = nil
+def cop_heating_to_cop_heating_no_fan(coph47, capacity_w)
+  # Convert the capacity to Btu/hr
+  capacity_btu_per_hr = OpenStudio.convert(capacity_w, 'W', 'Btu/hr').get
+
+  cop = 1.48E-7 * coph47 * capacity_btu_per_hr + 1.062 * coph47
 
-  # First convert from SEER to EER
-  eer = (-0.0182 * seer * seer) + (1.1088 * seer)
-  
-  # Next convert EER to COP
-  cop = eer_to_cop(eer)
-  
   return cop
- 
 end
 
-# Convert from EER to COP
-# per the method specified in "Achieving the 30% Goal: Energy 
+# Convert from HSPF to COP (no fan) for heat pump heating coils
+# per the method specified in 90.1-2013 Appendix G
+#
+# @param hspf [Double] heating seasonal performance factor (HSPF)
+# @return [Double] Coefficient of Performance (COP)
+def hspf_to_cop_heating_no_fan(hspf)
+  cop = -0.0296 * hspf * hspf + 0.7134 * hspf
+
+  return cop
+end
+
+# Convert from COP to SEER
+# per the method specified in "Achieving the 30% Goal: Energy
 # and cost savings analysis of ASHRAE Standard 90.1-2010
 # Thornton, et al 2011
 #
+# @param [Double] COP
+# @return [Double] Seasonal Energy Efficiency Ratio
+def cop_to_seer(cop)
+  seer = nil
+
+  # First convert COP to EER
+  eer = cop_to_eer(cop)
+
+  # Next convert from EER to SEER
+  delta = 1.1088**2 - 4.0 * 0.0182 * eer
+  seer = (-delta**0.5 + 1.1088) / (2.0 * 0.0182)
+
+  return seer
+end
+
+# Convert from EER to COP
+# If capacity is not supplied, use the method specified
+# in "Achieving the 30% Goal: Energy and cost savings
+# analysis of ASHRAE Standard 90.1-2010
+# Thornton, et al 2011.
+# If capacity is supplied, use the method specified in
+# 90.1-2013.
+#
 # @param eer [Double] Energy Efficiency Ratio (EER)
+# @param capacity_w [Double] the heating capacity at AHRI rating conditions, in W
 # @return [Double] Coefficient of Performance (COP)
-def eer_to_cop(eer)
-  
+def eer_to_cop(eer, capacity_w = nil)
   cop = nil
 
+  if capacity_w.nil?
+
+    # The PNNL Method.
+
+    # r is the ratio of supply fan power to total equipment power at the rating condition,
+    # assumed to be 0.12 for the reference buildngs per PNNL.
+    r = 0.12
+
+    cop = (eer / 3.413 + r) / (1 - r)
+
+  else
+
+    # The 90.1-2013 method
+
+    # Convert the capacity to Btu/hr
+    capacity_btu_per_hr = OpenStudio.convert(capacity_w, 'W', 'Btu/hr').get
+
+    cop = 7.84E-8 * eer * capacity_btu_per_hr + 0.338 * eer
+
+  end
+
+  return cop
+end
+
+# Convert from COP to EER
+# per the method specified in "Achieving the 30% Goal: Energy
+# and cost savings analysis of ASHRAE Standard 90.1-2010
+# Thornton, et al 2011
+#
+# @param [Double] COP
+# @return [Double] Energy Efficiency Ratio (EER)
+def cop_to_eer(cop)
+  eer = nil
+
   # r is the ratio of supply fan power to total equipment power at the rating condition,
   # assumed to be 0.12 for the reference buildngs per PNNL.
   r = 0.12
-  
-  cop = (eer/3.413 + r)/(1-r)
-  
-  return cop
- 
+
+  eer = 3.413 * (cop * (1 - r) - r)
+
+  return eer
 end
 
 # Convert from COP to kW/ton
@@ -197,9 +219,7 @@ end
 # @param cop [Double] Coefficient of Performance (COP)
 # @return [Double] kW of input power per ton of cooling
 def cop_to_kw_per_ton(cop)
-  
-  return 3.517/cop
- 
+  return 3.517 / cop
 end
 
 # A helper method to convert from kW/ton to COP
@@ -207,9 +227,7 @@ end
 # @param kw_per_ton [Double] kW of input power per ton of cooling
 # @return [Double] Coefficient of Performance (COP)
 def kw_per_ton_to_cop(kw_per_ton)
-  
-  return 3.517/kw_per_ton
- 
+  return 3.517 / kw_per_ton
 end
 
 # A helper method to convert from AFUE to thermal efficiency
@@ -217,9 +235,15 @@ end
 # @param afue [Double] Annual Fuel Utilization Efficiency
 # @return [Double] Thermal efficiency (%)
 def afue_to_thermal_eff(afue)
-  
   return afue # Per PNNL doc, Boiler Addendum 90.1-04an
- 
+end
+
+# A helper method to convert from thermal efficiency to AFUE
+#
+# @param teff [Double] Thermal Efficiency
+# @return [Double] AFUE
+def thermal_eff_to_afue(teff)
+  return teff # Per PNNL doc, Boiler Addendum 90.1-04an
 end
 
 # A helper method to convert from combustion efficiency to thermal efficiency
@@ -227,9 +251,15 @@ end
 # @param combustion_eff [Double] Combustion efficiency (%)
 # @return [Double] Thermal efficiency (%)
 def combustion_eff_to_thermal_eff(combustion_eff)
-  
   return combustion_eff - 0.007 # Per PNNL doc, Boiler Addendum 90.1-04an
- 
+end
+
+# A helper method to convert from thermal efficiency to combustion efficiency
+#
+# @param combustion_eff [Double] Thermal efficiency
+# @return [Double] Thermal efficiency
+def thermal_eff_to_comb_eff(teff)
+  return teff + 0.007 # Per PNNL doc, Boiler Addendum 90.1-04an
 end
 
 # Convert one infiltration rate at a given pressure
@@ -242,21 +272,18 @@ end
 # @param final_pressure_pa [Double] desired pressure rise to adjust infiltration rate to in Pa
 # @param infiltration_coefficient [Double] infiltration coeffiecient
 def adjust_infiltration_to_lower_pressure(initial_infiltration_rate_m3_per_s, intial_pressure_pa, final_pressure_pa, infiltration_coefficient = 0.65)
-
-  adjusted_infiltration_rate_m3_per_s = initial_infiltration_rate_m3_per_s * (final_pressure_pa/intial_pressure_pa)**infiltration_coefficient
+  adjusted_infiltration_rate_m3_per_s = initial_infiltration_rate_m3_per_s * (final_pressure_pa / intial_pressure_pa)**infiltration_coefficient
 
   return adjusted_infiltration_rate_m3_per_s
-
-end 
+end
 
 # Convert the infiltration rate at a 75 Pa
 # to an infiltration rate at the typical value for the prototype buildings
 # per method described here:  http://www.taskair.net/knowledge/Infiltration%20Modeling%20Guidelines%20for%20Commercial%20Building%20Energy%20Analysis.pdf
 #
 # @param initial_infiltration_rate_m3_per_s [Double] initial infiltration rate in m^3/s
-# @return [Double] 
+# @return [Double]
 def adjust_infiltration_to_prototype_building_conditions(initial_infiltration_rate_m3_per_s)
-
   # Details of these coefficients can be found in paper
   alpha = 0.22 # unitless - terrain adjustment factor
   intial_pressure_pa = 75.0 # 75 Pa
@@ -264,14 +291,13 @@ def adjust_infiltration_to_prototype_building_conditions(initial_infiltration_ra
   rho = 1.18 # kg/m^3 - air density
   cs = 0.1617 # unitless - positive surface pressure coefficient
   n = 0.65 # unitless - infiltration coefficient
-  
+
   # Calculate the typical pressure - same for all building types
   final_pressure_pa = 0.5 * cs * rho * uh**2
-  
-  #OpenStudio::logFree(OpenStudio::Debug, "openstudio.Standards.Space", "Final pressure PA = #{final_pressure_pa.round(3)} Pa.")
 
-  adjusted_infiltration_rate_m3_per_s = (1.0 + alpha) * initial_infiltration_rate_m3_per_s * (final_pressure_pa/intial_pressure_pa)**n
+  # OpenStudio::logFree(OpenStudio::Debug, "openstudio.Standards.Space", "Final pressure PA = #{final_pressure_pa.round(3)} Pa.")
 
-  return adjusted_infiltration_rate_m3_per_s
+  adjusted_infiltration_rate_m3_per_s = (1.0 + alpha) * initial_infiltration_rate_m3_per_s * (final_pressure_pa / intial_pressure_pa)**n
 
-end 
+  return adjusted_infiltration_rate_m3_per_s
+end