openstudio-standards 0.2.12.rc5 → 0.2.13

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

@@ -1,4 +1,3 @@
-
 class Standard
   # @!group ThermalZone
 
@@ -37,6 +36,7 @@ class Standard
 
       dsn_oa = space.designSpecificationOutdoorAir
       next if dsn_oa.empty?
+
       dsn_oa = dsn_oa.get
 
       # compute outdoor air rates in case we need them
@@ -106,6 +106,7 @@ class Standard
       # SpaceType or directly at the Space
       dsn_oa = space.designSpecificationOutdoorAir
       next if dsn_oa.empty?
+
       dsn_oa = dsn_oa.get
       next if dsn_oa.outdoorAirMethod == 'Maximum'
 
@@ -225,10 +226,9 @@ class Standard
   # The goal is a dynamic threshold that calibrates each day.
   # @return [<OpenStudio::Model::ScheduleRuleset>] a ScheduleRuleset of fractional or discrete occupancy
   # @todo Speed up this method.  Bottleneck is ScheduleRule.getDaySchedules
-  def spaces_get_occupancy_schedule(spaces, sch_name: nil, occupied_percentage_threshold: nil, threshold_calc_method: "value")
-
+  def spaces_get_occupancy_schedule(spaces, sch_name: nil, occupied_percentage_threshold: nil, threshold_calc_method: 'value')
     annual_normalized_tol = nil
-    if threshold_calc_method == "normalized_annual_range"
+    if threshold_calc_method == 'normalized_annual_range'
       # run this method without threshold to get annual min and max
       temp_merged = spaces_get_occupancy_schedule(spaces)
       tem_min_max = schedule_ruleset_annual_min_max_value(temp_merged)
@@ -248,6 +248,7 @@ class Standard
             num_ppl_sch = num_ppl_sch.get
             num_ppl_sch = num_ppl_sch.to_ScheduleRuleset
             next if num_ppl_sch.empty? # Skip non-ruleset schedules
+
             num_ppl_sch = num_ppl_sch.get
             num_ppl = people.getNumberOfPeople(space.floorArea)
             if occ_schedules_num_occ[num_ppl_sch].nil?
@@ -266,6 +267,7 @@ class Standard
           num_ppl_sch = num_ppl_sch.get
           num_ppl_sch = num_ppl_sch.to_ScheduleRuleset
           next if num_ppl_sch.empty? # Skip non-ruleset schedules
+
           num_ppl_sch = num_ppl_sch.get
           num_ppl = people.getNumberOfPeople(space.floorArea)
           if occ_schedules_num_occ[num_ppl_sch].nil?
@@ -301,6 +303,7 @@ class Standard
       day_schedules.uniq.each do |day_sch|
         # Skip schedules that have been stored previously
         next unless day_schedule_times[day_sch].nil?
+
         # Store times
         times = []
         day_sch.times.each do |time|
@@ -320,13 +323,13 @@ class Standard
       # Get the unique time indices and corresponding day schedules
       day_sch_num_occ = {}
       occ_schedules_num_occ.each do |occ_sch, num_occ|
-        daily_sch = occ_schedules_day_schedules[occ_sch][i-1]
+        daily_sch = occ_schedules_day_schedules[occ_sch][i - 1]
         times_on_this_day += day_schedule_times[daily_sch]
         day_sch_num_occ[daily_sch] = num_occ
       end
 
       daily_normalized_tol = nil
-      if threshold_calc_method == "normalized_daily_range"
+      if threshold_calc_method == 'normalized_daily_range'
         # pre-process day to get daily min and max
         daily_spaces_occ_frac = []
         times_on_this_day.uniq.sort.each do |time|
@@ -357,19 +360,20 @@ class Standard
           tot_occ_at_time += occ_frac * num_occ
         end
 
-        # Total fraction for the spaces at each time
-        spaces_occ_frac = tot_occ_at_time / max_occ_in_spaces
+        # Total fraction for the spaces at each time,
+        # rounded to avoid decimal precision issues
+        spaces_occ_frac = (tot_occ_at_time / max_occ_in_spaces).round(3)
 
         # If occupied_percentage_threshold is specified, schedule values are boolean
         # Otherwise use the actual spaces_occ_frac
         if occupied_percentage_threshold.nil?
           occ_status = spaces_occ_frac
-        elsif threshold_calc_method == "normalized_annual_range"
+        elsif threshold_calc_method == 'normalized_annual_range'
           occ_status = 0 # unoccupied
           if spaces_occ_frac >= annual_normalized_tol
             occ_status = 1
           end
-        elsif threshold_calc_method == "normalized_daily_range"
+        elsif threshold_calc_method == 'normalized_daily_range'
           occ_status = 0 # unoccupied
           if spaces_occ_frac > daily_normalized_tol
             occ_status = 1
@@ -395,6 +399,7 @@ class Standard
       simple_daily_occs = []
       daily_values.each_with_index do |value, j|
         next if value == daily_values[j + 1]
+
         simple_daily_times << daily_times[j]
         simple_daily_os_times << daily_os_times[j]
         simple_daily_values << daily_values[j]
@@ -415,11 +420,11 @@ class Standard
     sch_ruleset.setName(sch_name.to_s)
     # add properties to schedule
     props = sch_ruleset.additionalProperties
-    props.setFeature("max_occ_in_spaces",max_occ_in_spaces)
-    props.setFeature("number_of_spaces_included",spaces.size)
+    props.setFeature('max_occ_in_spaces', max_occ_in_spaces)
+    props.setFeature('number_of_spaces_included', spaces.size)
     # nothing uses this but can make user be aware if this may be out of sync with current state of occupancy profiles
-    props.setFeature("date_parent_object_last_edited",Time.now.getgm.to_s)
-    props.setFeature("date_parent_object_created",Time.now.getgm.to_s)
+    props.setFeature('date_parent_object_last_edited', Time.now.getgm.to_s)
+    props.setFeature('date_parent_object_created', Time.now.getgm.to_s)
 
     # Default - All Occupied
     day_sch = sch_ruleset.defaultDaySchedule
@@ -448,6 +453,7 @@ class Standard
         # currently under inspection
         day = daily_data['day_of_week']
         next unless day == weekday
+
         date = daily_data['date']
         times = daily_data['times']
         values = daily_data['values']
@@ -470,6 +476,7 @@ class Standard
         daily_os_times.each_with_index do |time, t|
           value = values[t]
           next if value == values[t + 1] # Don't add breaks if same value
+
           day_sch.addValue(time, value)
         end
 
@@ -503,7 +510,7 @@ class Standard
     # todo - also merging non adjacent priority rules without getting rid of any rules between the two could create unexpected reults
     prior_rules = []
     sch_ruleset.scheduleRules.each do |rule|
-      if prior_rules.size == 0
+      if prior_rules.empty?
         prior_rules << rule
         next
       else
@@ -511,7 +518,7 @@ class Standard
         prior_rules.each do |prior_rule|
           # see if they are similar
           next if rules_combined
-          # todo - update to combine adjacent date ranges vs. just matching date ranges
+          # TODO: update to combine adjacent date ranges vs. just matching date ranges
           next if prior_rule.startDate.get != rule.startDate.get
           next if prior_rule.endDate.get != rule.endDate.get
           next if prior_rule.daySchedule.times.to_a != rule.daySchedule.times.to_a
@@ -526,7 +533,7 @@ class Standard
           if rule.applySaturday then prior_rule.setApplySaturday(true) && rules_combined = true end
           if rule.applySunday then prior_rule.setApplySunday(true) && rules_combined = true end
         end
-        if rules_combined then rule.remove else prior_rules << rule end
+        rules_combined ? rule.remove : prior_rules << rule
       end
     end
     # replace unused default profile with lowest priority rule
@@ -535,9 +542,11 @@ class Standard
     prior_rules.last.remove
     sch_ruleset.defaultDaySchedule.clearValues
     values.size.times do |i|
-      sch_ruleset.defaultDaySchedule.addValue(times[i],values[i])
+      sch_ruleset.defaultDaySchedule.addValue(times[i], values[i])
     end
 
+    OpenStudio.logFree(OpenStudio::Debug, 'openstudio.Standards.ThermalZone', "Created #{sch_ruleset.name} with #{schedule_ruleset_annual_equivalent_full_load_hrs(sch_ruleset)} annual EFLH.")
+
     return sch_ruleset
   end
 
@@ -556,6 +565,7 @@ class Standard
     thermal_zone.spaces.each do |space|
       # Ignore space if not part of total area
       next unless space.partofTotalFloorArea
+
       if space_residential?(space)
         res_area_m2 += space.floorArea
       else
@@ -746,6 +756,7 @@ class Standard
     spaces.each do |space|
       # If space is not part of floor area, we don't add it
       next unless space.partofTotalFloorArea
+
       area_m2 += space.floorArea
     end
 
@@ -773,6 +784,7 @@ class Standard
     thermal_zone.equipment.each do |equip|
       # Skip HVAC components
       next unless equip.to_HVACComponent.is_initialized
+
       equip = equip.to_HVACComponent.get
       if equip.airLoopHVAC.is_initialized
         has_air_loop = true
@@ -958,6 +970,7 @@ class Standard
       end
       # Move on if no heating schedule was found
       next if htg_sch.nil?
+
       # Get the setpoint from the schedule
       if htg_sch.to_ScheduleRuleset.is_initialized
         htg_sch = htg_sch.to_ScheduleRuleset.get
@@ -1091,6 +1104,7 @@ class Standard
       end
       # Move on if no cooling schedule was found
       next if clg_sch.nil?
+
       # Get the setpoint from the schedule
       if clg_sch.to_ScheduleRuleset.is_initialized
         clg_sch = clg_sch.to_ScheduleRuleset.get
@@ -1549,12 +1563,12 @@ class Standard
   #
   # @return [String] the building type
   def thermal_zone_building_type(thermal_zone)
-
     # determine areas of each building type
     building_type_areas = {}
     thermal_zone.spaces.each do |space|
       # ignore space if not part of total area
       next unless space.partofTotalFloorArea
+
       if space.spaceType.is_initialized
         space_type = space.spaceType.get
         if space_type.standardsBuildingType.is_initialized
@@ -1572,7 +1586,7 @@ class Standard
     building_type = building_type_areas.key(building_type_areas.values.max)
 
     if building_type.nil?
-      OpenStudio::logFree(OpenStudio::Info, "openstudio.Standards.ThermalZone", "Thermal zone #{thermal_zone.name} does not have standards building type.")
+      OpenStudio.logFree(OpenStudio::Info, 'openstudio.Standards.ThermalZone', "Thermal zone #{thermal_zone.name} does not have standards building type.")
     end
 
     return building_type
@@ -1691,12 +1705,14 @@ class Standard
     thermal_zone.spaces.each do |space|
       next unless space.spaceType.is_initialized
       next unless space.partofTotalFloorArea
+
       space_type = space.spaceType.get
       if space_type_hash.key?(space_type)
         space_type_hash[space_type] += space.floorArea # excluding space.multiplier since used to calc loads in zone
       else
         next unless space_type.standardsBuildingType.is_initialized
         next unless space_type.standardsSpaceType.is_initialized
+
         space_type_hash[space_type] = space.floorArea # excluding space.multiplier since used to calc loads in zone
       end
     end
@@ -1716,6 +1732,7 @@ class Standard
       space_type_properties = space_type_get_standards_data(space_type)
       exhaust_per_area = space_type_properties['exhaust_per_area']
       next if exhaust_per_area.nil?
+
       maximum_flow_rate_ip = exhaust_per_area * floor_area_ip
       maximum_flow_rate_si = OpenStudio.convert(maximum_flow_rate_ip, 'cfm', 'm^3/s').get
       if space_type_properties['exhaust_availability_schedule'].nil?
@@ -1726,7 +1743,7 @@ class Standard
         exhaust_schedule = model_add_schedule(thermal_zone.model, sch_name)
         flow_sch_name = space_type_properties['exhaust_flow_fraction_schedule']
         exhaust_flow_schedule = model_add_schedule(thermal_zone.model, flow_sch_name)
-          unless exhaust_schedule
+        unless exhaust_schedule
           OpenStudio.logFree(OpenStudio::Warn, 'openstudio.Standards.ThermalZone', "Could not find an exhaust schedule called #{sch_name}, exhaust fans will run continuously.")
           exhaust_schedule = thermal_zone.model.alwaysOnDiscreteSchedule
         end
@@ -1802,6 +1819,7 @@ class Standard
         # skip if space is in current thermal zone.
         next unless space.thermalZone.is_initialized
         next if k.thermalZone.get == thermal_zone
+
         adjacent_zones << k.thermalZone.get
       end
     end

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

@@ -1,4 +1,3 @@
-
 class Standard
   # @!group WaterHeaterMixed
 
@@ -9,7 +8,7 @@ class Standard
   #
   # @return [Bool] true if successful, false if not
   def water_heater_mixed_apply_efficiency(water_heater_mixed)
-    # TODO remove this once workaround for HPWHs is removed
+    # TODO: remove this once workaround for HPWHs is removed
     if water_heater_mixed.partLoadFactorCurve.is_initialized
       if water_heater_mixed.partLoadFactorCurve.get.name.get.include?('HPWH_COP')
         OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.WaterHeaterMixed', "For #{water_heater_mixed.name}, the workaround for HPWHs has been applied, efficiency will not be changed.")
@@ -30,14 +29,14 @@ class Standard
     capacity_btu_per_hr = OpenStudio.convert(capacity_w, 'W', 'Btu/hr').get
 
     # Get the volume of the water heater
-    # TODO add capability to pull autosized water heater volume
+    # TODO: add capability to pull autosized water heater volume
     # if the Sizing:WaterHeater object is ever implemented in OpenStudio.
     volume_m3 = water_heater_mixed.tankVolume
     if volume_m3.empty?
       OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.WaterHeaterMixed', "For #{water_heater_mixed.name}, cannot find volume, standard will not be applied.")
       return false
     else
-    volume_m3 = @instvarbuilding_type == 'MidriseApartment' ? volume_m3.get / 23 : volume_m3.get / water_heater_mixed.component_quantity
+      volume_m3 = @instvarbuilding_type == 'MidriseApartment' ? volume_m3.get / 23 : volume_m3.get / water_heater_mixed.component_quantity
     end
     volume_gal = OpenStudio.convert(volume_m3, 'm^3', 'gal').get
 
@@ -95,14 +94,14 @@ class Standard
         # 0.82 = (ua*67.5+cap*re)/cap
         # Solutions to the system of equations were determined
         # for discrete values of EF and modeled using a regression
-        re = -0.1137 * ef **2 + 0.1997 * ef + 0.731
+        re = -0.1137 * ef**2 + 0.1997 * ef + 0.731
         # Calculate the skin loss coefficient (UA)
         # Input capacity is assumed to be the output capacity
         # divided by a burner efficiency of 80%
         ua_btu_per_hr_per_f = (water_heater_eff - re) * capacity_btu_per_hr / 0.8 / 67.5
       end
       # Two booster water heaters
-    ua_btu_per_hr_per_f = water_heater_mixed.name.to_s.include?('Booster') ? ua_btu_per_hr_per_f * 2 : ua_btu_per_hr_per_f
+      ua_btu_per_hr_per_f = water_heater_mixed.name.to_s.include?('Booster') ? ua_btu_per_hr_per_f * 2 : ua_btu_per_hr_per_f
     end
 
     # Typically specified this way for large electric water heaters
@@ -149,7 +148,7 @@ class Standard
       # Calculate the max allowable standby loss (SL)
       # Output capacity is assumed to be 10 * Tank volume
       # Input capacity = Output capacity / Et
-	  p_on = capacity_btu_per_hr / et
+      p_on = capacity_btu_per_hr / et
       sl_btu_per_hr = p_on / sl_cap_adj + sl_vol_drt * Math.sqrt(wh_tank_volume) + sl_tank
       # Calculate the skin loss coefficient (UA)
       ua_btu_per_hr_per_f = (sl_btu_per_hr * et) / 70

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

@@ -82,16 +82,98 @@ class Standard
     return true
   end
 
+  # Default occupancy fraction threshold for determining if the spaces served by the zone hvac are occupied
+  def zone_hvac_unoccupied_threshold
+    return 0.15
+  end
+
+  # If the supply air fan operating mode schedule is always off (to follow load),
+  # and the zone requires ventilation, override it to follow the zone occupancy schedule
+  def zone_hvac_component_occupancy_ventilation_control(zone_hvac_component)
+    ventilation = false
+    # Zone HVAC operating schedule if providing ventilation
+    # Zone HVAC components return an OptionalSchedule object for supplyAirFanOperatingModeSchedule
+    # except for ZoneHVACTerminalUnitVariableRefrigerantFlow which returns a Schedule
+    existing_sch = nil
+    if zone_hvac_component.to_ZoneHVACFourPipeFanCoil.is_initialized
+      zone_hvac_component = zone_hvac_component.to_ZoneHVACFourPipeFanCoil.get
+      if zone_hvac_component.maximumOutdoorAirFlowRate.is_initialized
+        oa_rate = zone_hvac_component.maximumOutdoorAirFlowRate.get
+        ventilation = true if oa_rate > 0.0
+      end
+      ventilation = true if zone_hvac_component.isMaximumOutdoorAirFlowRateAutosized
+      fan_op_sch = zone_hvac_component.supplyAirFanOperatingModeSchedule
+      existing_sch = fan_op_sch.get if fan_op_sch.is_initialized
+    elsif zone_hvac_component.to_ZoneHVACPackagedTerminalAirConditioner.is_initialized
+      zone_hvac_component = zone_hvac_component.to_ZoneHVACPackagedTerminalAirConditioner.get
+      if zone_hvac_component.outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded.is_initialized
+        oa_rate = zone_hvac_component.outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded.get
+        ventilation = true if oa_rate > 0.0
+      end
+      ventilation = true if zone_hvac_component.isOutdoorAirFlowRateWhenNoCoolingorHeatingisNeededAutosized
+      fan_op_sch = zone_hvac_component.supplyAirFanOperatingModeSchedule
+      existing_sch = fan_op_sch.get if fan_op_sch.is_initialized
+    elsif zone_hvac_component.to_ZoneHVACPackagedTerminalHeatPump.is_initialized
+      zone_hvac_component = zone_hvac_component.to_ZoneHVACPackagedTerminalHeatPump.get
+      if zone_hvac_component.outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded.is_initialized
+        oa_rate = zone_hvac_component.outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded.get
+        ventilation = true if oa_rate > 0.0
+      end
+      ventilation = true if zone_hvac_component.isOutdoorAirFlowRateWhenNoCoolingorHeatingisNeededAutosized
+      fan_op_sch = zone_hvac_component.supplyAirFanOperatingModeSchedule
+      existing_sch = fan_op_sch.get if fan_op_sch.is_initialized
+    elsif zone_hvac_component.to_ZoneHVACTerminalUnitVariableRefrigerantFlow.is_initialized
+      zone_hvac_component = zone_hvac_component.to_ZoneHVACTerminalUnitVariableRefrigerantFlow.get
+      if zone_hvac_component.outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded.is_initialized
+        oa_rate = zone_hvac_component.outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded.get
+        ventilation = true if oa_rate > 0.0
+      end
+      ventilation = true if zone_hvac_component.isOutdoorAirFlowRateWhenNoCoolingorHeatingisNeededAutosized
+      existing_sch = zone_hvac_component.supplyAirFanOperatingModeSchedule
+    elsif zone_hvac_component.to_ZoneHVACWaterToAirHeatPump.is_initialized
+      zone_hvac_component = zone_hvac_component.to_ZoneHVACWaterToAirHeatPump.get
+      if zone_hvac_component.outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded.is_initialized
+        oa_rate = zone_hvac_component.outdoorAirFlowRateWhenNoCoolingorHeatingisNeeded.get
+        ventilation = true if oa_rate > 0.0
+      end
+      ventilation = true if zone_hvac_component.isOutdoorAirFlowRateWhenNoCoolingorHeatingisNeededAutosized
+      fan_op_sch = zone_hvac_component.supplyAirFanOperatingModeSchedule
+      existing_sch = fan_op_sch.get if fan_op_sch.is_initialized
+    end
+    return false unless ventilation
+
+    # if supply air fan operating schedule is always off,
+    # override to provide ventilation during occupied hours
+    unless existing_sch.nil?
+      if existing_sch.name.is_initialized
+        OpenStudio.logFree(OpenStudio::Info, 'openstudio.Standards.ZoneHVACComponent', "#{zone_hvac_component.name} has ventilation, and schedule is set to always on; keeping always on schedule.")
+        return false if existing_sch.name.get.to_s.downcase.include? 'always on discrete'
+      end
+    end
+
+    thermal_zone = zone_hvac_component.thermalZone.get
+    occ_threshold = zone_hvac_unoccupied_threshold
+    occ_sch = thermal_zones_get_occupancy_schedule([thermal_zone],
+                                                   sch_name: "#{zone_hvac_component.name} Occ Sch",
+                                                   occupied_percentage_threshold: occ_threshold)
+    zone_hvac_component.setSupplyAirFanOperatingModeSchedule(occ_sch)
+    OpenStudio.logFree(OpenStudio::Info, 'openstudio.Standards.ZoneHVACComponent', "#{zone_hvac_component.name} has ventilation.  Setting fan operating mode schedule to align with zone occupancy schedule.")
+
+    return true
+  end
+
   # Apply all standard required controls to the zone equipment
   #
   # @return [Bool] returns true if successful, false if not
   def zone_hvac_component_apply_standard_controls(zone_hvac_component)
-
     # Vestibule heating control
     if zone_hvac_component_vestibule_heating_control_required?(zone_hvac_component)
       zone_hvac_component_apply_vestibule_heating_control(zone_hvac_component)
     end
 
+    # zone ventilation occupancy control for systems with ventilation
+    zone_hvac_component_occupancy_ventilation_control(zone_hvac_component)
+
     return true
   end
 
@@ -108,7 +190,6 @@ class Standard
   #
   # @return [Bool] returns true if successful, false if not
   def zone_hvac_component_apply_vestibule_heating_control(zone_hvac_component)
-
     # Ensure that the equipment is assigned to a thermal zone
     if zone_hvac_component.thermalZone.empty?
       OpenStudio.logFree(OpenStudio::Warn, 'openstudio.model.ZoneHVACComponent', "For #{zone_hvac_component.name}: equipment is not assigned to a thermal zone, cannot apply vestibule heating control.")
@@ -124,8 +205,6 @@ class Standard
                   zone_hvac_component.to_ZoneHVACPackagedTerminalAirConditioner.get
                 elsif zone_hvac_component.to_ZoneHVACPackagedTerminalHeatPump.is_initialized
                   zone_hvac_component.to_ZoneHVACPackagedTerminalHeatPump.get
-                else
-                  nil
                 end
 
     # Do nothing for other types of zone HVAC equipment
@@ -185,8 +264,8 @@ class Standard
       oat_db_c_sen = zone_hvac_component.model.getEnergyManagementSystemSensorByName('OATVestibule').get
     else
       oat_db_c_sen = OpenStudio::Model::EnergyManagementSystemSensor.new(model, 'Site Outdoor Air Drybulb Temperature')
-      oat_db_c_sen.setName("OATVestibule")
-      oat_db_c_sen.setKeyName("Environment")
+      oat_db_c_sen.setName('OATVestibule')
+      oat_db_c_sen.setKeyName('Environment')
     end
 
     # Actuators
@@ -214,5 +293,4 @@ class Standard
 
     return true
   end
-
 end