openstudio-standards 0.7.1 → 0.8.0.rc1

data/lib/openstudio-standards/refrigeration/data/refrigeration_compressors.csv

@@ -0,0 +1,13 @@
+curve_name,template,operation_type,curve_type,coefficient1,coefficient2,coefficient3,coefficient4,coefficient5,coefficient6,coefficient7,coefficient8,coefficient9,coefficient10,min_val_x,max_val_x,min_val_y,max_val_y
+Old_Low_Temp_Comp_Pwr_Curve,old,LT,Power,29669.27106,1027.632052,18.10662623,-442.1997136,11.13352877,-20.38045192,0.139980653,-0.058866918,-0.218451538,0.203858467,-40,-17.8,4.4,54.4
+Old_Med_Temp_Comp_Pwr_Curve,old,MT,Power,7438.922294,-269.5975647,-9.856104461,553.5732602,-3.385889614,14.86578782,-0.100796292,0.009822793,0.097362356,-0.039675217,-23.3,7.2,10,60
+New_Low_Temp_Comp_Pwr_Curve,new,LT,Power,170751.8339,6102.903702,78.2619862,-2959.432648,19.78765887,-90.95810147,0.435964768,-0.041157653,-0.60884596,0.459133262,-40,-17.8,4.4,54.4
+New_Med_Temp_Comp_Pwr_Curve,new,MT,Power,7438.922294,-269.5975647,-9.856104461,553.5732602,-3.385889614,14.86578782,-0.100796292,0.009822793,0.097362356,-0.039675217,-23.3,7.2,10,60
+Advanced_Low_Temp_Comp_Pwr_Curve,advanced,LT,Power,170751.8339,6102.903702,78.2619862,-2959.432648,19.78765887,-90.95810147,0.435964768,-0.041157653,-0.60884596,0.459133262,-40,-17.8,4.4,54.4
+Advanced_Med_Temp_Comp_Pwr_Curve,advanced,MT,Power,7438.922294,-269.5975647,-9.856104461,553.5732602,-3.385889614,14.86578782,-0.100796292,0.009822793,0.097362356,-0.039675217,-23.3,7.2,10,60
+Old_Low_Temp_Comp_Cap_Curve,old,LT,Capacity,170751.8339,6102.903702,78.2619862,-2959.432648,19.78765887,-90.95810147,0.435964768,-0.041157653,-0.60884596,0.459133262,-40,-17.8,4.4,54.4
+Old_Med_Temp_Comp_Cap_Curve,old,MT,Capacity,151166.4362,5266.347888,60.67271508,-1851.559382,5.731327549,-46.92771731,0.136401203,-0.035697884,-0.403053994,-0.039290478,-23.3,7.2,10,60
+New_Low_Temp_Comp_Cap_Curve,new,LT,Capacity,58336.86118,1561.7435,6.606812861,-283.6500679,-0.120234941,-12.49574858,-0.116278559,0.002277001,-0.118148325,0.032839613,-40,-17.8,4.4,54.4
+New_Med_Temp_Comp_Cap_Curve,new,MT,Capacity,61412.17466,1570.851906,13.53344913,-500.1952361,8.16391243,-3.689538504,0.054485574,-0.088096805,0.006381584,-0.037503058,-23.3,7.2,10,60
+Advanced_Low_Temp_Comp_Cap_Curve,advanced,LT,Capacity,58336.86118,1561.7435,6.606812861,-283.6500679,-0.120234941,-12.49574858,-0.116278559,0.002277001,-0.118148325,0.032839613,-40,-17.8,4.4,54.4
+Advanced_Med_Temp_Comp_Cap_Curve,advanced,MT,Capacity,61412.17466,1570.851906,13.53344913,-500.1952361,8.16391243,-3.689538504,0.054485574,-0.088096805,0.006381584,-0.037503058,-23.3,7.2,10,60

data/lib/openstudio-standards/refrigeration/data/typical_refrigerated_cases.csv

@@ -0,0 +1,17 @@
+building_type,space_type,case_type,length_ft,reference_space_type_area_ft2
+SuperMarket,Sales,Coffin - Frozen Food,80,27500
+SuperMarket,Sales,Coffin - Ice Cream,20,27500
+SuperMarket,Sales,Reach-in - Ice Cream,187,27500
+SuperMarket,Sales,Reach-in - Frozen Food,52,27500
+SuperMarket,Sales,Reach-in - Dairy Deli Beverage Case,320,27500
+SuperMarket,Sales,Service - Meat Deli Bakery,85,27500
+SuperMarket,Sales,Island - Deli Produce,18,27500
+SuperMarket,Sales,Vertical Open - All,82,27500
+Gro,GrocSales,Coffin - Frozen Food,80,40000
+Gro,GrocSales,Coffin - Ice Cream,20,40000
+Gro,GrocSales,Reach-in - Ice Cream,187,40000
+Gro,GrocSales,Reach-in - Frozen Food,52,40000
+Gro,GrocSales,Reach-in - Dairy Deli Beverage Case,320,40000
+Gro,GrocSales,Service - Meat Deli Bakery,85,40000
+Gro,GrocSales,Island - Deli Produce,18,40000
+Gro,GrocSales,Vertical Open - All,82,40000

data/lib/openstudio-standards/refrigeration/data/typical_refrigerated_walkins.csv

@@ -0,0 +1,53 @@
+building_type,space_type,walkin_name,walkin_type,size_ft2,reference_space_type_area_ft2,notes
+PrimarySchool,Kitchen,Walk-in Cooler,Walk-in Cooler,120,1800,
+PrimarySchool,Kitchen,Walk-in Freezer,Walk-in Freezer,120,1800,
+SecondarySchool,Kitchen,Walk-in Cooler,Walk-in Cooler,240,2325,
+SecondarySchool,Kitchen,Walk-in Freezer,Walk-in Freezer,240,2325,
+QuickServiceRestaurant,Kitchen,Walk-in Cooler,Walk-in Cooler,100,1250,
+QuickServiceRestaurant,Kitchen,Walk-in Freezer,Walk-in Freezer,100,1250,
+FullServiceRestaurant,Kitchen,Walk-in Cooler,Walk-in Cooler,100,1500,
+FullServiceRestaurant,Kitchen,Walk-in Freezer,Walk-in Freezer,100,1500,
+LargeHotel,Kitchen,Walk-in Cooler,Walk-in Cooler,120,1110,
+LargeHotel,Kitchen,Walk-in Freezer,Walk-in Freezer,120,1110,
+Hospital,Kitchen,Walk-in Cooler,Walk-in Cooler,360,10000,
+Hospital,Kitchen,Walk-in Freezer,Walk-in Freezer,360,10000,
+SuperMarket,DryStorage,Bakery Cooler,Walk-in Cooler,120,4500,
+SuperMarket,DryStorage,Bakery Freezer,Walk-in Freezer,150,4500,
+SuperMarket,DryStorage,Beer Cooler,Walk-in Cooler,320,4500,
+SuperMarket,DryStorage,Dairy Cooler,Walk-in Cooler,240,4500,
+SuperMarket,DryStorage,Floral Cooler,Walk-in Cooler,80,4500,
+SuperMarket,DryStorage,Grocery Freezer,Walk-in Freezer,240,4500,
+SuperMarket,DryStorage,Kitchen Cooler,Walk-in Cooler,290,4500,
+SuperMarket,DryStorage,Kitchen Freezer,Walk-in Freezer,96,4500,
+SuperMarket,DryStorage,Meat Cooler,Walk-in Cooler,570,4500,
+SuperMarket,DryStorage,Meat Freezer,Walk-in Freezer,60,4500,
+SuperMarket,DryStorage,Prep Cooler 1,Walk-in Cooler,480,4500,
+SuperMarket,DryStorage,Prep Cooler 2,Walk-in Cooler,480,4500,
+SuperMarket,DryStorage,Produce Cooler,Walk-in Cooler,620,4500,
+SuperMarket,DryStorage,Specialty Cooler,Walk-in Cooler,72,4500,
+EPr,Kitchen,Walk-in Cooler,Walk-in Cooler,120,1750,
+EPr,Kitchen,Walk-in Freezer,Walk-in Freezer,120,1750,
+ESe,Kitchen,Walk-in Cooler,Walk-in Cooler,240,2630,
+ESe,Kitchen,Walk-in Freezer,Walk-in Freezer,240,2630,
+RFF,StockRoom,Walk-in Cooler,Walk-in Cooler,100,800,
+RFF,StockRoom,Walk-in Freezer,Walk-in Freezer,100,800,
+RSD,StockRoom,Walk-in Cooler,Walk-in Cooler,100,1600,
+RSD,StockRoom,Walk-in Freezer,Walk-in Freezer,100,5000,
+Htl,Kitchen,Walk-in Cooler,Walk-in Cooler,120,1000,
+Htl,Kitchen,Walk-in Freezer,Walk-in Freezer,120,1000,
+Hsp,Kitchen,Walk-in Cooler,Walk-in Cooler,360,1875,
+Hsp,Kitchen,Walk-in Freezer,Walk-in Freezer,360,1875,
+Gro,GrocSales,Bakery Cooler,Walk-in Cooler,120,40000,
+Gro,GrocSales,Bakery Freezer,Walk-in Freezer,150,40000,
+Gro,GrocSales,Beer Cooler,Walk-in Cooler,320,40000,
+Gro,GrocSales,Dairy Cooler,Walk-in Cooler,240,40000,
+Gro,GrocSales,Floral Cooler,Walk-in Cooler,80,40000,
+Gro,GrocSales,Grocery Freezer,Walk-in Freezer,240,40000,
+Gro,GrocSales,Kitchen Cooler,Walk-in Cooler,290,40000,
+Gro,GrocSales,Kitchen Freezer,Walk-in Freezer,96,40000,
+Gro,GrocSales,Meat Cooler,Walk-in Cooler,570,40000,
+Gro,GrocSales,Meat Freezer,Walk-in Freezer,60,40000,
+Gro,GrocSales,Prep Cooler 1,Walk-in Cooler,480,40000,
+Gro,GrocSales,Prep Cooler 2,Walk-in Cooler,480,40000,
+Gro,GrocSales,Produce Cooler,Walk-in Cooler,620,40000,
+Gro,GrocSales,Specialty Cooler,Walk-in Cooler,72,40000,

data/lib/openstudio-standards/refrigeration/information.rb

@@ -0,0 +1,130 @@
+module OpenstudioStandards
+  # The Refrigeration module provides methods to create, modify, and get information about refrigeration
+  module Refrigeration
+    # @!group Information
+    # Methods to get information about model refrigeration
+
+    # Find the thermal zone that is best for adding refrigerated display cases into.
+    # First, check for space types that typically have refrigeration.
+    # Fall back to largest zone in the model if no typical space types are found.
+    #
+    # @param model [OpenStudio::Model::Model] OpenStudio model object
+    # @return [OpenStudio::Model::ThermalZone] returns a thermal zone if found, nil if not.
+    def self.refrigeration_case_zone(model)
+      # load refrigeration cases data
+      cases_csv = "#{__dir__}/data/typical_refrigerated_cases.csv"
+      unless File.exist?(cases_csv)
+        OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.Refrigeration', "Unable to find file: #{cases_csv}")
+        return nil
+      end
+      cases_tbl = CSV.table(cases_csv, encoding: 'ISO8859-1:utf-8')
+      cases_hsh = cases_tbl.map(&:to_hash)
+
+      # Look for one of the space types that would typically have refrigeration
+      display_case_zone = nil
+      display_case_zone_area_m2 = 0.0
+      model.getThermalZones.each do |zone|
+        space_type = OpenstudioStandards::ThermalZone.thermal_zone_get_space_type(zone)
+        next if space_type.empty?
+
+        space_type = space_type.get
+        next if space_type.standardsSpaceType.empty?
+        next if space_type.standardsBuildingType.empty?
+
+        stds_spc_type = space_type.standardsSpaceType.get
+        stds_bldg_type = space_type.standardsBuildingType.get
+        cases = cases_hsh.select { |r| (r[:building_type] == stds_bldg_type) && (r[:space_type] == stds_spc_type) }
+        unless cases.empty?
+          if zone.floorArea > display_case_zone_area_m2
+            display_case_zone = zone
+            display_case_zone_area_m2 = zone.floorArea
+          end
+        end
+      end
+
+      unless display_case_zone.nil?
+        OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.Refrigeration', "Display case zone is #{display_case_zone.name}, the largest zone with a space type typical for display cases.")
+        return display_case_zone
+      end
+
+      # If no typical space type was found, choose the largest zone in the model.
+      display_case_zone = nil
+      display_case_zone_area_m2 = 0
+      model.getThermalZones.each do |zone|
+        if zone.floorArea > display_case_zone_area_m2
+          display_case_zone = zone
+          display_case_zone_area_m2 = zone.floorArea
+        end
+      end
+
+      unless display_case_zone.nil?
+        OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.Refrigeration', "No space types typical for display cases were found, so the display cases will be placed in #{display_case_zone.name}, the largest zone.")
+        return display_case_zone
+      end
+
+      return display_case_zone
+    end
+
+    # Find the thermal zone that is best for adding refrigerated walkins into.
+    # First, check for space types that typically have refrigeration.
+    # Fall back to largest zone in the model if no typical space types are found.
+    #
+    # @param model [OpenStudio::Model::Model] OpenStudio model object
+    # @return [OpenStudio::Model::ThermalZone] returns a thermal zone if found, nil if not.
+    def self.refrigeration_walkin_zone(model)
+      # load refrigeration walkin data
+      walkins_csv = "#{__dir__}/data/typical_refrigerated_walkins.csv"
+      unless File.exist?(walkins_csv)
+        OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.Refrigeration', "Unable to find file: #{walkins_csv}")
+        return nil
+      end
+      walkins_tbl = CSV.table(walkins_csv, encoding: 'ISO8859-1:utf-8')
+      walkins_hsh = walkins_tbl.map(&:to_hash)
+
+      # Look for one of the space types that would typically have walkins
+      walkin_zone = nil
+      walkin_zone_area_m2 = 0.0
+      model.getThermalZones.each do |zone|
+        space_type = OpenstudioStandards::ThermalZone.thermal_zone_get_space_type(zone)
+        next if space_type.empty?
+
+        space_type = space_type.get
+        next if space_type.standardsSpaceType.empty?
+        next if space_type.standardsBuildingType.empty?
+
+        stds_spc_type = space_type.standardsSpaceType.get
+        stds_bldg_type = space_type.standardsBuildingType.get
+        walkins = walkins_hsh.select { |r| (r[:building_type] == stds_bldg_type) && (r[:space_type] == stds_spc_type) }
+        unless walkins.empty?
+          if zone.floorArea > walkin_zone_area_m2
+            walkin_zone = zone
+            walkin_zone_area_m2 = zone.floorArea
+          end
+        end
+      end
+
+      unless walkin_zone.nil?
+        OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.Refrigeration', "Walkin zone is #{walkin_zone.name}, the largest zone with a space type typical for walkins.")
+        return walkin_zone
+      end
+
+      # If no typical space type was found,
+      # choose the largest zone in the model.
+      walkin_zone = nil
+      walkin_zone_area_m2 = 0
+      model.getThermalZones.each do |zone|
+        if zone.floorArea > walkin_zone_area_m2
+          walkin_zone = zone
+          walkin_zone_area_m2 = zone.floorArea
+        end
+      end
+
+      unless walkin_zone.nil?
+        OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.Refrigeration', "No space types typical for walkins were found, so the walkins will be placed in #{walkin_zone.name}, the largest zone.")
+        return walkin_zone
+      end
+
+      return walkin_zone
+    end
+  end
+end

data/lib/openstudio-standards/schedules/parametric.rb

@@ -315,7 +315,7 @@ module OpenstudioStandards
 
           opt_space = water_use_equipment.space
           if opt_space.is_initialized
-            space = space.get
+            space = opt_space.get
             hours_of_operation = OpenstudioStandards::Space.space_hours_of_operation(space)
             OpenstudioStandards::Schedules.schedule_ruleset_get_parametric_inputs(schedule, water_use_equipment, parametric_inputs, hours_of_operation, gather_data_only: gather_data_only, hoo_var_method: hoo_var_method)
           else

data/lib/openstudio-standards/service_water_heating/create_typical.rb

@@ -0,0 +1,299 @@
+module OpenstudioStandards
+  # The ServiceWaterHeating module provides methods to create, modify, and get information about service water heating
+  module ServiceWaterHeating
+    # @!group Create Typical
+    # Methods to add typical service water heating depending on space types
+
+    # add typical swh demand and supply to model
+    #
+    # @param model [OpenStudio::Model::Model] OpenStudio model object
+    # @param water_heating_fuel [String] water heater fuel. Valid choices are NaturalGas, Electricity, and HeatPump.
+    #   If not supplied, a smart default will be determined based on building type and loop type.
+    # @param circulating [Boolean] determine whether the system is circulating (true), noncirculating (false).
+    #   A nil value will default based on the standards building type
+    # @return [Array<OpenStudio::Model::PlantLoop>] array of service hot water loops
+    # @todo add support for other loop configurations, such as by space type, space type adjacent, or building type
+    def self.create_typical_service_water_heating(model,
+                                                  water_heating_fuel: nil,
+                                                  circulating: nil)
+      # array of service hot water loops
+      swh_systems = []
+
+      # water use equipment on the building loop
+      shared_water_use_equipment = []
+      booster_water_use_equipment = []
+
+      # @todo remove once model_add_schedule is refactored
+      std = Standard.build('90.1-2013')
+
+      # loop through space types adding demand side of swh
+      model.getSpaces.sort.each do |space|
+        next unless space.spaceType.is_initialized
+
+        total_space_floor_area_m2 = space.floorArea * space.multiplier
+        total_space_floor_area_ft2 = OpenStudio.convert(total_space_floor_area_m2, 'm^2', 'ft^2').get
+        space_type = space.spaceType.get
+
+        next unless space_type.standardsSpaceType.is_initialized
+        next unless space_type.standardsBuildingType.is_initialized
+
+        standards_space_type = space_type.standardsSpaceType.get
+        standards_building_type = space_type.standardsBuildingType.get
+
+        # load typical water use equipment data
+        data = JSON.parse(File.read("#{__dir__}/data/typical_water_use_equipment.json"), symbolize_names: true)
+        space_type_properties = data[:space_types].select { |hash| (hash[:space_type] == standards_space_type) && (hash[:building_type] == standards_building_type) }
+
+        # skip spaces with no equipment defined
+        next if space_type_properties.empty?
+
+        water_use_equipment = space_type_properties[0][:water_use_equipment]
+
+        # store one per unit equipment
+        space_water_use_equipment = []
+
+        if space.hasAdditionalProperties && space.additionalProperties.hasFeature('num_units')
+          num_units = space.additionalProperties.getFeatureAsInteger('num_units').get
+        else # assume 1 space is 1 unit
+          num_units = space.multiplier
+        end
+
+        # loop through and add water use equipment to space
+        water_use_equipment.each do |w|
+          # get water use equipment properties
+          water_use_name = w[:equipment_name]
+          peak_flow_rate_gal_per_hr = w[:peak_flow_rate].to_f
+          peak_flow_rate_gal_per_hr_per_ft2 = w[:peak_flow_rate_per_area].to_f
+          loop_type = w[:loop_type]
+          temperature = w[:temperature]
+          flow_rate_schedule = w[:flow_rate_schedule]
+          sensible_fraction = w[:sensible_fraction]
+          latent_fraction = w[:latent_fraction]
+
+          # derived from equipment properties
+          is_booster = water_use_name && water_use_name.downcase.include?('booster')
+          water_use_name = water_use_name ? "#{space.name} #{water_use_name}" : "#{space.name} Water Use"
+          service_water_temperature_c = OpenStudio.convert(temperature, 'F', 'C').get
+
+          # @todo replace this line once model_add_schedule is refactored to not require a standard
+          flow_rate_schedule = std.model_add_schedule(model, flow_rate_schedule)
+
+          # skip undefined equipment
+          next unless peak_flow_rate_gal_per_hr > 0.0 || peak_flow_rate_gal_per_hr_per_ft2 > 0.0
+
+          # If there is no SWH schedule, assume no SWH use for this space type.
+          unless flow_rate_schedule
+            OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.ServiceWaterHeating', "No service water heating schedule was specified for space type #{space_type.name} with standards space type #{standards_space_type}. Assuming an always off schedule.")
+            flow_rate_schedule = model.alwaysOffDiscreteSchedule
+          end
+
+          # Determine the peak flow rate and default water heating fuel
+          case loop_type
+          when 'One Per Unit'
+            # calculate peak flow rate
+            if peak_flow_rate_gal_per_hr.zero? && peak_flow_rate_gal_per_hr_per_ft2 > 0.0
+              peak_flow_rate_gal_per_hr = num_units * peak_flow_rate_gal_per_hr_per_ft2 * total_space_floor_area_ft2
+            else
+              peak_flow_rate_gal_per_hr *= num_units
+            end
+
+            # update water use name
+            water_use_name = "#{water_use_name} #{num_units} unit(s)"
+          else
+            # calculate peak flow rate
+            if peak_flow_rate_gal_per_hr.zero? && peak_flow_rate_gal_per_hr_per_ft2 > 0.0
+              peak_flow_rate_gal_per_hr = peak_flow_rate_gal_per_hr_per_ft2 * total_space_floor_area_ft2
+            end
+          end
+
+          # convert to SI
+          peak_flow_rate_m3_per_s = OpenStudio.convert(peak_flow_rate_gal_per_hr, 'gal/hr', 'm^3/s').get
+
+          # create water use equipment
+          water_use_equip = OpenstudioStandards::ServiceWaterHeating.create_water_use(model,
+                                                                                      name: water_use_name,
+                                                                                      flow_rate: peak_flow_rate_m3_per_s,
+                                                                                      flow_rate_fraction_schedule: flow_rate_schedule,
+                                                                                      water_use_temperature: service_water_temperature_c,
+                                                                                      sensible_fraction: sensible_fraction,
+                                                                                      latent_fraction: latent_fraction,
+                                                                                      space: space)
+
+          OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.ServiceWaterHeating', "Added water use equipment #{water_use_equip.name}")
+
+          # create service hot water loop for 'One Per Space' and 'One Per Unit' dedicated equipment
+          case loop_type
+          when 'Shared'
+            if is_booster
+              booster_water_use_equipment << water_use_equip
+            else
+              shared_water_use_equipment << water_use_equip
+            end
+          when 'One Per Space', 'One Per Unit'
+            space_water_use_equipment << water_use_equip
+          else
+            OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.ServiceWaterHeating', "Water use equipment service loop type #{loop_type} not recognized. Cannot attach equipment to a loop.")
+          end
+        end
+
+        # create water loop for 'One Per Space' and 'One Per Unit' equipment
+        unless space_water_use_equipment.empty?
+          water_heater_capacity_w = num_units * OpenStudio.convert(20.0, 'kBtu/hr', 'W').get
+          water_heater_volume_m3 = num_units * OpenStudio.convert(50.0, 'gal', 'm^3').get
+          num_water_heaters = num_units
+
+          # default to electricity for single units
+          dedicated_water_heating_fuel = water_heating_fuel || 'Electricity'
+
+          # @todo add method to get service water temperature as max of space_water_use_equipment
+          service_water_temperature_c = OpenStudio.convert(140.0, 'F', 'C').get
+
+          # add service water loop with water heater
+          swh_loop = OpenstudioStandards::ServiceWaterHeating.create_service_water_heating_loop(model,
+                                                                                                system_name: "#{space.name} Service Water Loop",
+                                                                                                service_water_temperature: service_water_temperature_c,
+                                                                                                service_water_pump_head: 0.01,
+                                                                                                service_water_pump_motor_efficiency: 1.0,
+                                                                                                water_heater_capacity: water_heater_capacity_w,
+                                                                                                water_heater_volume: water_heater_volume_m3,
+                                                                                                water_heater_fuel: dedicated_water_heating_fuel,
+                                                                                                number_of_water_heaters: num_water_heaters,
+                                                                                                add_piping_losses: true,
+                                                                                                floor_area: total_space_floor_area_m2,
+                                                                                                number_of_stories: 1)
+
+          # add loop to array
+          swh_systems << swh_loop
+
+          # Attach water use equipment to the loop
+          space_water_use_equipment.each do |water_use_equip|
+            swh_connection = water_use_equip.waterUseConnections
+            swh_loop.addDemandBranchForComponent(swh_connection.get) if swh_connection.is_initialized
+          end
+        end
+      end
+
+      ############################################################################
+
+      # default to gas for shared system types and booster systems
+      shared_water_heating_fuel = water_heating_fuel || 'NaturalGas'
+      booster_water_heating_fuel = water_heating_fuel || 'Electricity'
+
+      # @todo get maximum service water temperature from shared_water_use_equipment
+      water_heater_temp_f = 140.0
+      water_heater_temp_c = OpenStudio.convert(water_heater_temp_f, 'F', 'C').get
+
+      # defaults for circulating or noncirculating systems
+      # @todo Remove hard-coded building-type-based lookups for circulating vs. non-circulating SWH systems
+      if circulating.nil?
+        if model.getBuilding.standardsBuildingType.is_initialized
+          circulating = OpenstudioStandards::ServiceWaterHeating.circulating_building_type?(model.getBuilding.standardsBuildingType.get)
+        else
+          OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.ServiceWaterHeating', 'Unable to determine the standards building type. Assuming the building does not have a circulating service water heating loop.')
+          circulating = false
+        end
+      end
+
+      # create a shared water loop
+      unless shared_water_use_equipment.empty? && booster_water_use_equipment.empty?
+        if circulating
+          # Table A.2 in PrototypeModelEnhancements_2014_0.pdf shows 10ft on everything except SecondarySchool which has 11.4ft
+          service_water_pump_head_pa = OpenStudio.convert(10.0, 'ftH_{2}O', 'Pa').get
+          service_water_pump_motor_efficiency = 0.3
+        else
+          service_water_pump_head_pa = 0.01
+          service_water_pump_motor_efficiency = 1.0
+        end
+
+        water_heater_sizing = OpenstudioStandards::ServiceWaterHeating.water_heater_sizing_from_water_use_equipment(shared_water_use_equipment)
+        water_heater_capacity_w = water_heater_sizing[:water_heater_capacity]
+        water_heater_volume_m3 = water_heater_sizing[:water_heater_volume]
+
+        # Add a shared service water heating loop with water heater
+        shared_swh_loop = OpenstudioStandards::ServiceWaterHeating.create_service_water_heating_loop(model,
+                                                                                                     system_name: 'Shared Service Water Loop',
+                                                                                                     service_water_temperature: water_heater_temp_c,
+                                                                                                     service_water_pump_head: service_water_pump_head_pa,
+                                                                                                     service_water_pump_motor_efficiency: service_water_pump_motor_efficiency,
+                                                                                                     water_heater_capacity: water_heater_capacity_w,
+                                                                                                     water_heater_volume: water_heater_volume_m3,
+                                                                                                     water_heater_fuel: shared_water_heating_fuel,
+                                                                                                     add_piping_losses: true)
+
+        # Add loop to array
+        swh_systems << shared_swh_loop
+
+        # Attach all water use equipment to the shared loop
+        shared_water_use_equipment.sort.each do |water_use_equip|
+          swh_connection = water_use_equip.waterUseConnections
+          shared_swh_loop.addDemandBranchForComponent(swh_connection.get) if swh_connection.is_initialized
+        end
+
+        # Attach booster water heater loop to shared loop
+        unless booster_water_use_equipment.empty?
+          # find_water_heater_capacity_volume_and_parasitic
+          booster_water_heater_sizing = OpenstudioStandards::ServiceWaterHeating.water_heater_sizing_from_water_use_equipment(booster_water_use_equipment,
+                                                                                                                              water_heater_efficiency: 1.0,
+                                                                                                                              inlet_temperature: 140.0,
+                                                                                                                              supply_temperature: 180.0)
+
+          # Note that booster water heaters are always assumed to be electric resistance
+          booster_water_temperature_c = OpenStudio.convert(180.0, 'F', 'C').get
+          swh_booster_loop = OpenstudioStandards::ServiceWaterHeating.create_booster_water_heating_loop(model,
+                                                                                                        system_name: 'Booster Water Loop',
+                                                                                                        water_heater_capacity: booster_water_heater_sizing[:water_heater_capacity],
+                                                                                                        service_water_temperature: booster_water_temperature_c,
+                                                                                                        service_water_loop: shared_swh_loop)
+
+          # Add loop to array
+          swh_systems << swh_booster_loop
+
+          # Attach booster water use equipment to the booster loop
+          booster_water_use_equipment.each do |booster_equip|
+            booster_swh_connection = booster_equip.waterUseConnections
+            swh_booster_loop.addDemandBranchForComponent(booster_swh_connection.get) if booster_swh_connection.is_initialized
+          end
+        end
+      end
+
+      return swh_systems
+    end
+
+    # Check if the standards building type tends to have a circulating system by default
+    #
+    # @param standards_building_type [String] standard building type
+    # @return [Boolean] return true if the building has a circulating system, false if not
+    def self.circulating_building_type?(standards_building_type)
+      circulating_bldg_types = [
+        # DOE building types
+        'Office',
+        'PrimarySchool',
+        'Outpatient',
+        'Hospital',
+        'SmallHotel',
+        'LargeHotel',
+        'FullServiceRestaurant',
+        'HighriseApartment',
+        # DEER building types
+        'Asm', # 'Assembly'
+        'ECC', # 'Education - Community College'
+        'EPr', # 'Education - Primary School'
+        'ERC', # 'Education - Relocatable Classroom'
+        'ESe', # 'Education - Secondary School'
+        'EUn', # 'Education - University'
+        'Gro', # 'Grocery'
+        'Hsp', # 'Health/Medical - Hospital'
+        'Htl', # 'Lodging - Hotel'
+        'MBT', # 'Manufacturing Biotech'
+        'MFm', # 'Residential Multi-family'
+        'Mtl', # 'Lodging - Motel'
+        'Nrs', # 'Health/Medical - Nursing Home'
+        'OfL', # 'Office - Large'
+        # 'RFF', # 'Restaurant - Fast-Food'
+        'RSD' # 'Restaurant - Sit-Down'
+      ]
+
+      return circulating_bldg_types.include?(standards_building_type)
+    end
+  end
+end

data/lib/openstudio-standards/service_water_heating/create_water_heating_loop.rb

@@ -119,19 +119,19 @@ module OpenstudioStandards
                                                                               use_ems_control: false)
       else
         OpenstudioStandards::ServiceWaterHeating.create_water_heater(model,
-                                                                      water_heater_capacity: water_heater_capacity,
-                                                                      water_heater_volume: water_heater_volume,
-                                                                      water_heater_fuel: water_heater_fuel,
-                                                                      on_cycle_parasitic_fuel_consumption_rate: on_cycle_parasitic_fuel_consumption_rate,
-                                                                      off_cycle_parasitic_fuel_consumption_rate: off_cycle_parasitic_fuel_consumption_rate,
-                                                                      service_water_temperature: service_water_temperature,
-                                                                      service_water_temperature_schedule: swh_temp_sch,
-                                                                      set_peak_use_flowrate: false,
-                                                                      peak_flowrate: 0.0,
-                                                                      flowrate_schedule: nil,
-                                                                      water_heater_thermal_zone: water_heater_thermal_zone,
-                                                                      number_of_water_heaters: number_of_water_heaters,
-                                                                      service_water_loop: service_water_loop)
+                                                                     water_heater_capacity: water_heater_capacity,
+                                                                     water_heater_volume: water_heater_volume,
+                                                                     water_heater_fuel: water_heater_fuel,
+                                                                     on_cycle_parasitic_fuel_consumption_rate: on_cycle_parasitic_fuel_consumption_rate,
+                                                                     off_cycle_parasitic_fuel_consumption_rate: off_cycle_parasitic_fuel_consumption_rate,
+                                                                     service_water_temperature: service_water_temperature,
+                                                                     service_water_temperature_schedule: swh_temp_sch,
+                                                                     set_peak_use_flowrate: false,
+                                                                     peak_flowrate: 0.0,
+                                                                     flowrate_schedule: nil,
+                                                                     water_heater_thermal_zone: water_heater_thermal_zone,
+                                                                     number_of_water_heaters: number_of_water_heaters,
+                                                                     service_water_loop: service_water_loop)
       end
 
       # add pipe losses if requested
@@ -166,6 +166,7 @@ module OpenstudioStandards
     # Creates a booster water heater on its own loop and attaches it to the main service water heating loop.
     #
     # @param model [OpenStudio::Model::Model] OpenStudio model object
+    # @param system_name [String] the name of the system. nil results in the default.
     # @param water_heater_capacity [Double] water heater capacity, in W. Defaults to 8 kW / 27.283 kBtu/hr
     # @param water_heater_volume [Double] water heater volume, in m^3. Defaults to 0.0227 m^3 / 6 gal
     # @param water_heater_fuel [String] water heating fuel. Valid choices are 'NaturalGas', 'Electricity'.
@@ -179,6 +180,7 @@ module OpenstudioStandards
     # @param service_water_loop [OpenStudio::Model::PlantLoop] if provided, add the water heater to this loop
     # @return [OpenStudio::Model::PlantLoop] The booster water loop OpenStudio PlantLoop object
     def self.create_booster_water_heating_loop(model,
+                                               system_name: 'Booster Water Loop',
                                                water_heater_capacity: 8000.0,
                                                water_heater_volume: OpenStudio.convert(6.0, 'gal', 'm^3').get,
                                                water_heater_fuel: 'Electricity',
@@ -189,7 +191,7 @@ module OpenstudioStandards
                                                water_heater_thermal_zone: nil,
                                                service_water_loop: nil)
       if service_water_loop.nil?
-        OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.ServiceWaterHeating', "#{_method_} requires the service_water_loop argument to couple the booster water heating loop with a heat exchanger.")
+        OpenStudio.logFree(OpenStudio::Error, 'openstudio.standards.ServiceWaterHeating', "#{__method__} requires the service_water_loop argument to couple the booster water heating loop with a heat exchanger.")
         return nil
       else
         OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.ServiceWaterHeating', "Adding booster water heater to #{service_water_loop.name}")