openstudio-standards 0.8.3 → 0.8.4

data/lib/openstudio-standards/constructions/modify.rb

@@ -347,7 +347,8 @@ module OpenstudioStandards
         return false
       end
       # Change construction name
-      construction.setName("#{construction.name}_#{surface.name}_#{target_f_factor_ip}")
+      construction_name = "Foundation F #{f_factor_si.round(2)}W/m*K Perim #{perimeter.round(2)}m Area #{area.round(2)}m2"
+      construction.setName(construction_name)
       construction.setFFactor(f_factor_si)
       construction.setArea(area)
       construction.setPerimeterExposed(perimeter)

data/lib/openstudio-standards/standards/Standards.Model.rb

@@ -555,7 +555,7 @@ class Standard
           # the PRM-RM; Note that the PRM-RM only suggest to increase
           # air zone air flow, but the zone sizing factor in EnergyPlus
           # increase both air flow and load.
-          umlh = OpenstudioStandards::SqlFile.model_get_annual_occupied_unmet_hours(proposed_model)
+          umlh = OpenstudioStandards::SqlFile.model_get_annual_occupied_unmet_hours(model)
           if umlh > 300
             model.getThermalZones.each do |thermal_zone|
               # Cooling adjustments
@@ -3054,11 +3054,24 @@ if !applicable_zones.nil? && !applicable_zones.include?(zone)
   # @return [OpenStudio::Model::Construction] construction object
   # @todo make return an OptionalConstruction
   def model_add_construction(model, construction_name, construction_props = nil, surface = nil)
+    intended_surface_type = construction_props&.[]('intended_surface_type') || ''
+
     # First check model and return construction if it already exists
     model.getConstructions.sort.each do |construction|
       if construction.name.get.to_s == construction_name
         OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.Model', "Already added construction: #{construction_name}")
-        return construction
+        valid = true
+        if !surface.nil?
+          if intended_surface_type == 'GroundContactFloor' && construction.iddObjectType.valueName != 'OS_Construction_FfactorGroundFloor'
+            valid = false
+          elsif intended_surface_type == 'GroundContactWall' && construction.iddObjectType.valueName != 'OS_Construction_CfactorUndergroundWall'
+            valid = false
+          end
+        end
+        if valid
+          return construction
+        end
+        OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.Model', "Already added construction: '#{construction_name}' but its type '#{construction.iddObjectType.valueName}' is not valid for the intended surface type '#{intended_surface_type}'. A new construction will be created.")
       end
     end
 
@@ -3076,12 +3089,31 @@ if !applicable_zones.nil? && !applicable_zones.include?(zone)
       return OpenStudio::Model::OptionalConstruction.new
     end
 
+    intended_surface_type = data["intended_surface_type"]
+    intended_surface_type ||= ''
+
     # Make a new construction and set the standards details
-    if data['intended_surface_type'] == 'GroundContactFloor' && !surface.nil?
-      construction = OpenStudio::Model::FFactorGroundFloorConstruction.new(model)
-    elsif data['intended_surface_type'] == 'GroundContactWall' && !surface.nil?
-      construction = OpenStudio::Model::CFactorUndergroundWallConstruction.new(model)
-    else
+    is_layered_construction = true
+
+    if intended_surface_type == 'GroundContactFloor' && !surface.nil?
+      if construction_props
+        construction = OpenStudio::Model::FFactorGroundFloorConstruction.new(model)
+        is_layered_construction = false
+      else
+        OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.Model', "Construction properties not specified for '#{construction_name}', cannot create F-Factor Ground Floor Construction.  A regular construction will be created instead, and Surface '#{surface.name}' will be set to use the 'Ground' outside boundary condition (previously '#{surface.outsideBoundaryCondition}').")
+        surface.setOutsideBoundaryCondition('Ground')
+      end
+    elsif intended_surface_type == 'GroundContactWall' && !surface.nil?
+      if construction_props
+        construction = OpenStudio::Model::CFactorUndergroundWallConstruction.new(model)
+        is_layered_construction = false
+      else
+        OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.Model', "Construction properties not specified for '#{construction_name}', cannot create C-Factor Underground Wall Construction.  A regular construction will be created instead, and Surface '#{surface.name}' will be set to use the 'Ground' outside boundary condition (previously '#{surface.outsideBoundaryCondition}').")
+        surface.setOutsideBoundaryCondition('Ground')
+      end
+    end
+
+    if is_layered_construction
       construction = OpenStudio::Model::Construction.new(model)
       # Add the material layers to the construction
       layers = OpenStudio::Model::MaterialVector.new
@@ -3096,8 +3128,6 @@ if !applicable_zones.nil? && !applicable_zones.include?(zone)
     construction.setName(construction_name)
     standards_info = construction.standardsInformation
 
-    intended_surface_type = data['intended_surface_type']
-    intended_surface_type ||= ''
     standards_info.setIntendedSurfaceType(intended_surface_type)
 
     standards_construction_type = data['standards_construction_type']

data/lib/openstudio-standards/standards/ashrae_90_1_prm/ashrae_90_1_prm.Model.rb

@@ -2071,7 +2071,8 @@ class ASHRAE901PRM < Standard
 
     if surfaces_with_fc_factor_boundary
       # Remove existing FCFactor temperature profile
-      model.getSiteGroundTemperatureFCfactorMethod.remove
+      ground_temp = model.getSiteGroundTemperatureFCfactorMethod
+      ground_temp.resetAllMonths
 
       # Get path to weather file specified in the model
       weather_file_path = prm_get_optional_handler(model.getWeatherFile, @sizing_run_dir, 'path').to_s
@@ -2089,7 +2090,6 @@ class ASHRAE901PRM < Standard
         stat_file_path = OpenstudioStandards::Weather.get_standards_weather_file_path(weather_file).sub('.epw', '.stat').to_s
       end
 
-      ground_temp = OpenStudio::Model::SiteGroundTemperatureFCfactorMethod.new(model)
       stat_file = OpenstudioStandards::Weather::StatFile.load(stat_file_path)
       ground_temperatures = stat_file.monthly_lagged_dry_bulb
       unless ground_temperatures.empty?

data/lib/openstudio-standards/standards/ashrae_90_1_prm/userdata_csv/ashrae_90_1_prm.UserData.rb

@@ -6,6 +6,7 @@ class UserDataCSV
   def initialize(model, save_dir)
     @model = model
     @component_name = nil
+    @unique_model_object = false
     unless Dir.exist?(save_dir)
       raise ArgumentError "Saving directory #{save_dir} does not exist!"
     end
@@ -70,6 +71,9 @@ class UserDataCSV
   # subclass shall determine what data group to extract from a modle.
   # @return [Array] array of OpenStudio components.
   def load_component
+    if @unique_model_object
+      return [@model.public_send("get#{@component_name}")]
+    end
     return @model.public_send("get#{@component_name}")
   end
 end
@@ -145,6 +149,7 @@ class UserDataCSVBuilding < UserDataCSV
   def initialize(model, save_dir)
     super
     @component_name = 'Building'
+    @unique_model_object = true
     @file_name = UserDataFiles::BUILDING
   end
 
@@ -274,7 +279,7 @@ class UserDataWaterUseConnection < UserDataCSV
   # @param save_dir [String] directory to save user data files
   def initialize(model, save_dir)
     super
-    @component_name = 'WaterUseConnections'
+    @component_name = 'WaterUseConnectionss'
     @file_name = UserDataFiles::WATERUSE_CONNECTIONS
   end
 

data/lib/openstudio-standards/standards/necb/BTAPPRE1980/btap_pre1980.rb

@@ -64,10 +64,10 @@ class BTAPPRE1980 < NECB2011
   end
 
   def apply_standard_efficiencies(model:, sizing_run_dir:, dcv_type: 'NECB_Default', necb_reference_hp:false)
-    raise('validation of model failed.') unless validate_initial_model(model)
+    # Do a sizing run
+    try_sizing_run(model: model, sizing_run_dir: sizing_run_dir, sizing_run_subdir: 'plant_loops')
 
     climate_zone = 'NECB HDD Method'
-    raise("sizing run 1 failed! check #{sizing_run_dir}") if model_run_sizing_run(model, "#{sizing_run_dir}/plant_loops") == false
 
     # This is needed for NECB2011 as a workaround for sizing the reheat boxes
     model.getAirTerminalSingleDuctVAVReheats.each { |iobj| air_terminal_single_duct_vav_reheat_set_heating_cap(iobj) }
@@ -86,29 +86,4 @@ class BTAPPRE1980 < NECB2011
     return true
   end
 
-  # This method sets the primary heating fuel to either NaturalGas or Electricity if a HP fuel type is set.
-  def validate_primary_heating_fuel(primary_heating_fuel:, model:)
-    if primary_heating_fuel.to_s.downcase == 'defaultfuel' || primary_heating_fuel.to_s.downcase == 'necb_default'
-      epw = OpenStudio::EpwFile.new(model.weatherFile.get.path.get)
-      default_fuel = @standards_data['regional_fuel_use'].detect { |fuel_sources| fuel_sources['state_province_regions'].include?(epw.stateProvinceRegion) }['fueltype_set']
-      if default_fuel.nil?
-        OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.swh', "Could not find a default fuel for #{epw.stateProvinceRegion}.  Using Electricity as the fuel type instead.")
-        return 'Electricity'
-      end
-      return default_fuel
-    end
-    return primary_heating_fuel unless primary_heating_fuel == 'NaturalGasHPGasBackup' || primary_heating_fuel == 'NaturalGasHPElecBackupMixed' || primary_heating_fuel == 'ElectricityHPElecBackup' || primary_heating_fuel == 'ElectricityHPGasBackupMixed'
-    case primary_heating_fuel
-    when "NaturalGasHPGasBackup"
-      primary_heating_fuel = 'NaturalGas'
-    when "NaturalGasHPElecBackupMixed"
-      primary_heating_fuel = 'NaturalGas'
-    when "ElectricityHPElecBackup"
-      primary_heating_fuel = 'Electricity'
-    when "ElectricityHPGasBackupMixed"
-      primary_heating_fuel = 'Electricity'
-    end
-    OpenStudio.logFree(OpenStudio::Info, 'openstudio.Standards.Model', "Attemted to apply an NECB HP primary_heating_fuel to a vintage building type.  Replacing the selected primary_heating_fuel with #{primary_heating_fuel}.")
-    return primary_heating_fuel
-  end
 end

data/lib/openstudio-standards/standards/necb/BTAPPRE1980/hvac_system_3_and_8_single_speed.rb

@@ -52,7 +52,10 @@ class BTAPPRE1980
       air_loop = add_system_3_and_8_airloop(heating_coil_type,
                                             model,
                                             system_data,
-                                            determine_control_zone(zones))
+                                            determine_control_zone(zones),
+                                            necb_reference_hp: necb_reference_hp,
+                                            necb_reference_hp_supp_fuel: necb_reference_hp_supp_fuel,
+                                            hw_loop: hw_loop)
       # Add Zone equipment
       zones.each do |zone| # Zone sizing temperature
         sizing_zone = zone.sizingZone
@@ -60,8 +63,13 @@ class BTAPPRE1980
         sizing_zone.setZoneCoolingDesignSupplyAirTemperatureDifference(system_data[:ZoneCoolingDesignSupplyAirTemperatureDifference])
         sizing_zone.setZoneHeatingDesignSupplyAirTemperatureInputMethod(system_data[:ZoneHeatingDesignSupplyAirTemperatureInputMethod])
         sizing_zone.setZoneHeatingDesignSupplyAirTemperatureDifference(system_data[:ZoneHeatingDesignSupplyAirTemperatureDifference])
-        sizing_zone.setZoneCoolingSizingFactor(system_data[:ZoneCoolingSizingFactor])
-        sizing_zone.setZoneHeatingSizingFactor(system_data[:ZoneHeatingSizingFactor])
+        if necb_reference_hp
+          sizing_zone.setZoneCoolingSizingFactor(system_data[:ZoneDXCoolingSizingFactor])
+          sizing_zone.setZoneHeatingSizingFactor(system_data[:ZoneDXHeatingSizingFactor])
+        else
+          sizing_zone.setZoneCoolingSizingFactor(system_data[:ZoneCoolingSizingFactor])
+          sizing_zone.setZoneHeatingSizingFactor(system_data[:ZoneHeatingSizingFactor])
+        end
         add_sys3_and_8_zone_equip(air_loop,
                                   baseboard_type,
                                   hw_loop,
@@ -70,7 +78,7 @@ class BTAPPRE1980
       end
     else
       zones.each do |zone|
-        air_loop = add_system_3_and_8_airloop(heating_coil_type, model, system_data, zone)
+        air_loop = add_system_3_and_8_airloop(heating_coil_type, model, system_data, zone, necb_reference_hp: necb_reference_hp, necb_reference_hp_supp_fuel: necb_reference_hp_supp_fuel, hw_loop: hw_loop)
         add_sys3_and_8_zone_equip(air_loop,
                                   baseboard_type,
                                   hw_loop,
@@ -83,19 +91,22 @@ class BTAPPRE1980
     sys_name_pars = {}
     sys_name_pars['sys_hr'] = 'none'
     sys_name_pars['sys_clg'] = 'dx'
+    sys_name_pars['sys_clg'] = 'ashp' if necb_reference_hp
     sys_name_pars['sys_htg'] = heating_coil_type
+    sys_name_pars['sys_htg'] = 'ashp>c-g' if necb_reference_hp && (necb_reference_hp_supp_fuel == "NaturalGas" || necb_reference_hp_supp_fuel == "Gas")
+    sys_name_pars['sys_htg'] = 'ashp>c-e' if necb_reference_hp && (necb_reference_hp_supp_fuel == "Electricity" || necb_reference_hp_supp_fuel == "Electric" || necb_reference_hp_supp_fuel == "FuelOilNo2")
+    sys_name_pars['sys_htg'] = 'ashp>c-hw' if necb_reference_hp && (necb_reference_hp_supp_fuel == "Hot Water" || necb_reference_hp_supp_fuel == "HotWater")
     sys_name_pars['sys_sf'] = 'cv'
     sys_name_pars['zone_htg'] = baseboard_type
     sys_name_pars['zone_clg'] = 'none'
     sys_name_pars['sys_rf'] = 'none'
-    assign_base_sys_name(air_loop,
+    return assign_base_sys_name(air_loop: air_loop,
                          sys_abbr: 'sys_3',
                          sys_oa: 'mixed',
                          sys_name_pars: sys_name_pars)
-    return true
   end
 
-  def add_system_3_and_8_airloop(heating_coil_type, model, system_data, control_zone)
+  def add_system_3_and_8_airloop(heating_coil_type, model, system_data, control_zone, necb_reference_hp:false, necb_reference_hp_supp_fuel:'DefaultFuel', necb_reference_hp_fancoil: false, hw_loop: nil)
     # System Type 3: PSZ-AC
     # This measure creates:
     # -a constant volume packaged single-zone A/C unit
@@ -118,25 +129,43 @@ class BTAPPRE1980
     sizing_zone.setZoneCoolingDesignSupplyAirTemperatureDifference(system_data[:ZoneCoolingDesignSupplyAirTemperatureDifference])
     sizing_zone.setZoneHeatingDesignSupplyAirTemperatureInputMethod(system_data[:ZoneHeatingDesignSupplyAirTemperatureInputMethod])
     sizing_zone.setZoneHeatingDesignSupplyAirTemperatureDifference(system_data[:ZoneHeatingDesignSupplyAirTemperatureDifference])
-    sizing_zone.setZoneCoolingSizingFactor(system_data[:ZoneCoolingSizingFactor])
-    sizing_zone.setZoneHeatingSizingFactor(system_data[:ZoneHeatingSizingFactor])
+    if necb_reference_hp
+      sizing_zone.setZoneCoolingSizingFactor(system_data[:ZoneDXCoolingSizingFactor])
+      sizing_zone.setZoneHeatingSizingFactor(system_data[:ZoneDXHeatingSizingFactor])
+    else
+      sizing_zone.setZoneCoolingSizingFactor(system_data[:ZoneCoolingSizingFactor])
+      sizing_zone.setZoneHeatingSizingFactor(system_data[:ZoneHeatingSizingFactor])
+    end
 
     fan = OpenStudio::Model::FanConstantVolume.new(model, always_on)
 
+    # Set up DX coil
+    if necb_reference_hp #NECB curve characteristics
+      clg_coil = add_onespeed_DX_coil(model, always_on)
+      clg_coil.setName('CoilCoolingDXSingleSpeed_ashp')
+    else
+      clg_coil = OpenStudio::Model::CoilCoolingDXSingleSpeed.new(model) #sets default OS curve (but will be replaced with NECB curves later)
+      clg_coil.setName('CoilCoolingDXSingleSpeed_dx')
+    end
     # Create a return fan for BTAPPRE1980 system 3 systems
     return_fan = OpenStudio::Model::FanConstantVolume.new(model, always_on)
     return_fan.setName('Sys3 Return Fan')
     return_fan.setEndUseSubcategory('Return_Fan')
 
+    raise("Flag 'necb_reference_hp' is set to true while parameter 'heating_coil_type' is not set to DX") if (necb_reference_hp && (heating_coil_type != 'DX'))
     case heating_coil_type
-    when 'Electric' # electric coil
+    when 'Electric', 'Electricity', "FuelOilNo2" # electric coil
       htg_coil = OpenStudio::Model::CoilHeatingElectric.new(model, always_on)
-    when 'Gas'
+    when 'Gas', 'NaturalGas'
       htg_coil = OpenStudio::Model::CoilHeatingGas.new(model, always_on)
+    when 'Hot Water', 'HotWater'
+      htg_coil = OpenStudio::Model::CoilHeatingWater.new(model, always_on)
+      hw_loop.addDemandBranchForComponent(htg_coil)
     when 'DX'
-      htg_coil = OpenStudio::Model::CoilHeatingDXSingleSpeed.new(model)
-      supplemental_htg_coil = OpenStudio::Model::CoilHeatingElectric.new(model, always_on)
+      #create main DX heating coil
+      htg_coil = add_onespeed_htg_DX_coil(model, always_on)
       htg_coil.setMinimumOutdoorDryBulbTemperatureforCompressorOperation(system_data[:MinimumOutdoorDryBulbTemperatureforCompressorOperation])
+      htg_coil.setName('CoilHeatingDXSingleSpeed_ashp')
       sizing_zone.setZoneHeatingSizingFactor(system_data[:ZoneDXHeatingSizingFactor])
       sizing_zone.setZoneCoolingSizingFactor(system_data[:ZoneDXCoolingSizingFactor])
     else
@@ -145,9 +174,7 @@ class BTAPPRE1980
 
     # TO DO: other fuel-fired heating coil types? (not available in OpenStudio/E+ - may need to play with efficiency to mimic other fuel types)
 
-    # Set up DX coil with NECB performance curve characteristics;
-    clg_coil = OpenStudio::Model::CoilCoolingDXSingleSpeed.new(model)
-    clg_coil.setName('CoilCoolingDXSingleSpeed_dx')
+
 
     # oa_controller
     oa_controller = OpenStudio::Model::ControllerOutdoorAir.new(model)
@@ -163,17 +190,31 @@ class BTAPPRE1980
     # Add the components to the air loop
     # in order from closest to zone to furthest from zone
     supply_inlet_node = air_loop.supplyInletNode
-    if heating_coil_type == 'DX'
-      air_to_air_heatpump = OpenStudio::Model::AirLoopHVACUnitaryHeatPumpAirToAir.new(model, always_on, fan, htg_coil, clg_coil, supplemental_htg_coil)
-      air_to_air_heatpump.setName("#{control_zone.name} ASHP")
-      air_to_air_heatpump.setControllingZone(control_zone)
-      air_to_air_heatpump.setSupplyAirFanOperatingModeSchedule(always_on)
-      air_to_air_heatpump.addToNode(supply_inlet_node)
-    else
-      fan.addToNode(supply_inlet_node)
-      htg_coil.addToNode(supply_inlet_node)
-      clg_coil.addToNode(supply_inlet_node)
+    fan.addToNode(supply_inlet_node)
+    if necb_reference_hp
+      #create supplemental heating coil based on default regional fuel type
+      if necb_reference_hp_supp_fuel == 'DefaultFuel'
+        epw = OpenStudio::EpwFile.new(model.weatherFile.get.path.get)
+        necb_reference_hp_supp_fuel = @standards_data['regional_fuel_use'].detect { |fuel_sources| fuel_sources['state_province_regions'].include?(epw.stateProvinceRegion) }['fueltype_set']
+      end
+      if necb_reference_hp_supp_fuel == 'NaturalGas' || necb_reference_hp_supp_fuel == 'Gas'
+        supplemental_htg_coil = OpenStudio::Model::CoilHeatingGas.new(model, always_on)
+      elsif necb_reference_hp_supp_fuel == 'Electricity' || necb_reference_hp_supp_fuel == 'Electric' || necb_reference_hp_supp_fuel == 'FuelOilNo2'
+        supplemental_htg_coil = OpenStudio::Model::CoilHeatingElectric.new(model, always_on)
+      elsif necb_reference_hp_supp_fuel == 'Hot Water' || necb_reference_hp_supp_fuel == "HotWater"
+        supplemental_htg_coil = OpenStudio::Model::CoilHeatingWater.new(model, always_on)
+        hw_loop.addDemandBranchForComponent(supplemental_htg_coil)
+      else
+        raise('Invalid fuel type selected for heat pump supplemental coil')
+      end
+      #air_to_air_heatpump.setName("#{control_zone.name} ASHP")
+      #air_to_air_heatpump.setControllingZone(control_zone)
+      #air_to_air_heatpump.setSupplyAirFanOperatingModeSchedule(always_on)
+      #air_to_air_heatpump.addToNode(supply_inlet_node)
+      supplemental_htg_coil.addToNode(supply_inlet_node)
     end
+    htg_coil.addToNode(supply_inlet_node)
+    clg_coil.addToNode(supply_inlet_node)
     oa_system.addToNode(supply_inlet_node)
 
     # Find return air node and add a return air fan to it for BTAPPRE1980 system 3 airloops.
@@ -195,8 +236,8 @@ class BTAPPRE1980
                                 hw_loop, model,
                                 zone)
     always_on = model.alwaysOnDiscreteSchedule
+    add_zone_baseboards(baseboard_type: baseboard_type, hw_loop: hw_loop, model: model, zone: zone)
     diffuser = OpenStudio::Model::AirTerminalSingleDuctUncontrolled.new(model, always_on)
     air_loop.addBranchForZone(zone, diffuser.to_StraightComponent)
-    add_zone_baseboards(baseboard_type: baseboard_type, hw_loop: hw_loop, model: model, zone: zone)
   end
 end

data/lib/openstudio-standards/standards/necb/BTAPPRE1980/hvac_system_4.rb

@@ -37,6 +37,9 @@ class BTAPPRE1980
     system_data[:ZoneCoolingDesignSupplyAirTemperatureDifference] = 11.0
     system_data[:ZoneHeatingDesignSupplyAirTemperatureInputMethod] = 'TemperatureDifference'
     system_data[:ZoneHeatingDesignSupplyAirTemperatureDifference] = 21.0
+    system_data[:ZoneHeatingDesignSupplyAirTemperature] = 43.0
+    system_data[:ZoneDXCoolingSizingFactor] = 1.0
+    system_data[:ZoneDXHeatingSizingFactor] = 1.3
     system_data[:ZoneCoolingSizingFactor] = 1.1
     system_data[:ZoneHeatingSizingFactor] = 1.3
 
@@ -53,9 +56,7 @@ class BTAPPRE1980
     # NOTE: This is the same as system type 3 (single zone make-up air unit and single zone rooftop unit are both PSZ systems)
     # SHOULD WE COMBINE sys3 and sys4 into one script?
     #
-    # control_zone = determine_control_zone(zones)
-    # Todo change this when control zone method is working.
-    control_zone = zones.first
+    control_zone = determine_control_zone(zones)
 
     always_on = model.alwaysOnDiscreteSchedule
 
@@ -73,27 +74,37 @@ class BTAPPRE1980
     sizing_zone.setZoneCoolingDesignSupplyAirTemperatureInputMethod(system_data[:ZoneCoolingDesignSupplyAirTemperatureInputMethod])
     sizing_zone.setZoneCoolingDesignSupplyAirTemperatureDifference(system_data[:ZoneCoolingDesignSupplyAirTemperatureDifference])
     sizing_zone.setZoneHeatingDesignSupplyAirTemperatureInputMethod(system_data[:ZoneHeatingDesignSupplyAirTemperatureInputMethod])
-    sizing_zone.setZoneHeatingDesignSupplyAirTemperatureDifference(system_data[:ZoneHeatingDesignSupplyAirTemperatureDifference])
-    sizing_zone.setZoneCoolingSizingFactor(system_data[:ZoneCoolingSizingFactor])
-    sizing_zone.setZoneHeatingSizingFactor(system_data[:ZoneHeatingSizingFactor])
+    sizing_zone.setZoneCoolingDesignSupplyAirTemperatureDifference(system_data[:ZoneHeatingDesignSupplyAirTemperatureDifference])
+    if necb_reference_hp
+      sizing_zone.setZoneCoolingSizingFactor(system_data[:ZoneDXCoolingSizingFactor])
+      sizing_zone.setZoneHeatingSizingFactor(system_data[:ZoneDXHeatingSizingFactor])
+    else
+      sizing_zone.setZoneCoolingSizingFactor(system_data[:ZoneCoolingSizingFactor])
+      sizing_zone.setZoneHeatingSizingFactor(system_data[:ZoneHeatingSizingFactor])
+    end
 
     fan = OpenStudio::Model::FanConstantVolume.new(model, always_on)
 
-    if heating_coil_type == 'Electric' # electric coil
-      htg_coil = OpenStudio::Model::CoilHeatingElectric.new(model, always_on)
-    end
+    # Set up DX coil with NECB performance curve characteristics;
+    clg_coil = add_onespeed_DX_coil(model, always_on)
+    clg_coil.setName('CoilCoolingDXSingleSpeed_dx')
+    clg_coil.setName('CoilCoolingDXSingleSpeed_ashp') if necb_reference_hp
 
-    if heating_coil_type == 'Gas'
+    raise("Flag 'necb_reference_hp' is set to true while parameter 'heating_coil_type' is not set to DX") if (necb_reference_hp && (heating_coil_type != 'DX'))
+    if heating_coil_type == 'Electric' || heating_coil_type == 'FuelOilNo2' # electric coil
+      htg_coil = OpenStudio::Model::CoilHeatingElectric.new(model, always_on)
+    elsif heating_coil_type == 'Gas'
       htg_coil = OpenStudio::Model::CoilHeatingGas.new(model, always_on)
+    elsif heating_coil_type == 'DX'
+      htg_coil = add_onespeed_htg_DX_coil(model, always_on)
+      htg_coil.setName('CoilHeatingDXSingleSpeed_ashp')
+    elsif heating_coil_type == 'Hot Water'
+      htg_coil = OpenStudio::Model::CoilHeatingWater.new(model, always_on)
+      hw_loop.addDemandBranchForComponent(htg_coil)
     end
 
     # TO DO: other fuel-fired heating coil types? (not available in OpenStudio/E+ - may need to play with efficiency to mimic other fuel types)
 
-    # Set up DX coil with NECB performance curve characteristics;
-
-    clg_coil = add_onespeed_DX_coil(model, always_on)
-    clg_coil.setName('CoilCoolingDXSingleSpeed_dx')
-
     # oa_controller
     oa_controller = OpenStudio::Model::ControllerOutdoorAir.new(model)
     oa_controller.autosizeMinimumOutdoorAirFlowRate
@@ -109,10 +120,33 @@ class BTAPPRE1980
     # in order from closest to zone to furthest from zone
     supply_inlet_node = air_loop.supplyInletNode
     fan.addToNode(supply_inlet_node)
+    if necb_reference_hp
+      #create supplemental heating coil based on default regional fuel type
+      if necb_reference_hp_supp_fuel == 'DefaultFuel'
+        epw = OpenStudio::EpwFile.new(model.weatherFile.get.path.get)
+        necb_reference_hp_supp_fuel = @standards_data['regional_fuel_use'].detect { |fuel_sources| fuel_sources['state_province_regions'].include?(epw.stateProvinceRegion) }['fueltype_set']
+      end
+      if necb_reference_hp_supp_fuel == 'NaturalGas'
+        supplemental_htg_coil = OpenStudio::Model::CoilHeatingGas.new(model, always_on)
+      elsif necb_reference_hp_supp_fuel == 'Electricity' or  necb_reference_hp_supp_fuel == 'FuelOilNo2'
+        supplemental_htg_coil = OpenStudio::Model::CoilHeatingElectric.new(model, always_on)
+      elsif necb_reference_hp_supp_fuel == 'Hot Water'
+        supplemental_htg_coil = OpenStudio::Model::CoilHeatingWater.new(model, always_on)
+        hw_loop.addDemandBranchForComponent(supplemental_htg_coil)
+      else
+        raise('Invalid fuel type selected for heat pump supplemental coil')
+      end
+      supplemental_htg_coil.addToNode(supply_inlet_node)
+      # This method will seem like an error in number of args..but this is due to swig voodoo.
+      #air_to_air_heatpump = OpenStudio::Model::AirLoopHVACUnitaryHeatPumpAirToAir.new(model, always_on, fan, htg_coil, clg_coil, supplemental_htg_coil)
+      #air_to_air_heatpump.setName("#{control_zone.name} ASHP")
+      #air_to_air_heatpump.setControllingZone(control_zone)
+      #air_to_air_heatpump.setSupplyAirFanOperatingModeSchedule(always_on)
+      #air_to_air_heatpump.addToNode(supply_inlet_node)
+    end
     htg_coil.addToNode(supply_inlet_node)
     clg_coil.addToNode(supply_inlet_node)
     oa_system.addToNode(supply_inlet_node)
-
     # Add a setpoint manager single zone reheat to control the
     # supply air temperature based on the needs of this zone
     setpoint_mgr_single_zone_reheat = OpenStudio::Model::SetpointManagerSingleZoneReheat.new(model)
@@ -144,34 +178,39 @@ class BTAPPRE1980
       sizing_zone.setZoneCoolingDesignSupplyAirTemperatureDifference(system_data[:ZoneCoolingDesignSupplyAirTemperatureDifference])
       sizing_zone.setZoneHeatingDesignSupplyAirTemperatureInputMethod(system_data[:ZoneHeatingDesignSupplyAirTemperatureInputMethod])
       sizing_zone.setZoneHeatingDesignSupplyAirTemperatureDifference(system_data[:ZoneHeatingDesignSupplyAirTemperatureDifference])
-      sizing_zone.setZoneCoolingSizingFactor(system_data[:ZoneCoolingSizingFactor])
-      sizing_zone.setZoneHeatingSizingFactor(system_data[:ZoneHeatingSizingFactor])
+      if necb_reference_hp
+        sizing_zone.setZoneCoolingSizingFactor(system_data[:ZoneDXCoolingSizingFactor])
+        sizing_zone.setZoneHeatingSizingFactor(system_data[:ZoneDXHeatingSizingFactor])
+      else
+        sizing_zone.setZoneCoolingSizingFactor(system_data[:ZoneCoolingSizingFactor])
+        sizing_zone.setZoneHeatingSizingFactor(system_data[:ZoneHeatingSizingFactor])
+      end
       # Create a diffuser and attach the zone/diffuser pair to the air loop
       # diffuser = OpenStudio::Model::AirTerminalSingleDuctUncontrolled.new(model,always_on)
-      diffuser = OpenStudio::Model::AirTerminalSingleDuctUncontrolled.new(model, always_on)
-      air_loop.addBranchForZone(zone, diffuser.to_StraightComponent)
       add_zone_baseboards(baseboard_type: baseboard_type,
                           hw_loop: hw_loop,
                           model: model,
                           zone: zone)
       add_exhaust_fan(zone: zone, model: model, name: exhaust_fan_name)
+      diffuser = OpenStudio::Model::AirTerminalSingleDuctUncontrolled.new(model, always_on)
+      air_loop.addBranchForZone(zone, diffuser.to_StraightComponent)
     end
-    # zone loop
-
-    # Modifying airloop name
     sys_name_pars = {}
     sys_name_pars['sys_hr'] = 'none'
     sys_name_pars['sys_clg'] = 'dx'
+    sys_name_pars['sys_clg'] = 'ashp' if necb_reference_hp
     sys_name_pars['sys_htg'] = heating_coil_type
+    sys_name_pars['sys_htg'] = 'ashp>c-g' if necb_reference_hp and necb_reference_hp_supp_fuel == "NaturalGas"
+    sys_name_pars['sys_htg'] = 'ashp>c-e' if necb_reference_hp and necb_reference_hp_supp_fuel == "Electricity"
+    sys_name_pars['sys_htg'] = 'ashp>c-hw' if necb_reference_hp and necb_reference_hp_supp_fuel == "Hot Water"
     sys_name_pars['sys_sf'] = 'cv'
     sys_name_pars['zone_htg'] = baseboard_type
     sys_name_pars['zone_clg'] = 'none'
     sys_name_pars['sys_rf'] = 'none'
-    assign_base_sys_name(air_loop,
+    return assign_base_sys_name(air_loop: air_loop,
                          sys_abbr: 'sys_4',
                          sys_oa: 'mixed',
                          sys_name_pars: sys_name_pars)
 
-    return true
   end
 end

data/lib/openstudio-standards/standards/necb/BTAPPRE1980/hvac_system_6.rb

@@ -131,18 +131,18 @@ class BTAPPRE1980
             reheat_coil = OpenStudio::Model::CoilHeatingElectric.new(model, always_on)
           end
 
+                    # Set zone baseboards
+                    add_zone_baseboards(model: model,
+                    zone: zone,
+                    baseboard_type: baseboard_type,
+                    hw_loop: hw_loop)
+
           vav_terminal = OpenStudio::Model::AirTerminalSingleDuctVAVReheat.new(model, always_on, reheat_coil)
           air_loop.addBranchForZone(zone, vav_terminal.to_StraightComponent)
           # NECB2011 minimum zone airflow setting
           vav_terminal.setFixedMinimumAirFlowRate(system_data[:ZoneVAVMinFlowFactorPerFloorArea] * zone.floorArea)
           vav_terminal.setMaximumReheatAirTemperature(system_data[:ZoneVAVMaxReheatTemp])
           vav_terminal.setDamperHeatingAction(system_data[:ZoneVAVDamperAction])
-
-          # Set zone baseboards
-          add_zone_baseboards(model: model,
-                              zone: zone,
-                              baseboard_type: baseboard_type,
-                              hw_loop: hw_loop)
         end
 
         # Modifying airloop name.
@@ -154,17 +154,15 @@ class BTAPPRE1980
         sys_name_pars['zone_htg'] = baseboard_type
         sys_name_pars['zone_clg'] = 'none'
         sys_name_pars['sys_rf'] = 'vv'
-        assign_base_sys_name(air_loop,
+        assign_base_sys_name(air_loop: air_loop,
                              sys_abbr: 'sys_6',
                              sys_oa: 'mixed',
                              sys_name_pars: sys_name_pars)
       end
+      # next story
     end
-    # next story
-
     # for debugging
     # puts "end add_sys6_multi_zone_built_up_with_baseboard_heating"
-
     return true
   end
 
@@ -227,7 +225,6 @@ class BTAPPRE1980
     # Make a Packaged VAV w/ PFP Boxes for each story of the building
     model.getBuildingStorys.sort.each do |story|
       unless (OpenstudioStandards::Geometry.building_story_get_thermal_zones(story) & zones).empty?
-
         air_loop = common_air_loop(model: model, system_data: system_data)
         air_loop.setName(system_data[:name])
         air_loop_sizing = air_loop.sizingSystem
@@ -323,12 +320,10 @@ class BTAPPRE1980
                               hw_loop: hw_loop)
         end
       end
+      # next story
     end
-    # next story
-
     # for debugging
     # puts "end add_sys6_multi_zone_built_up_with_baseboard_heating"
-
     return true
   end
 end