urbanopt-cli 0.10.0 → 0.11.1

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/data/unavailable_periods.csv

@@ -21,8 +21,8 @@ fuel_loads_lighting,1,1
 fuel_loads_fireplace,1,1
 pool_pump,0,1
 pool_heater,0,1
-hot_tub_pump,0,1
-hot_tub_heater,0,1
+permanent_spa_pump,0,1
+permanent_spa_heater,0,1
 hot_water_fixtures,1,1
 hvac,0,1
 water_heater,0,1

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/energyplus.rb

@@ -1,3 +1,8 @@
+# *********************************************************************************
+# URBANopt (tm), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://github.com/urbanopt/urbanopt-cli/blob/develop/LICENSE.md
+# *********************************************************************************
+
 # frozen_string_literal: true
 
 class EPlus
@@ -11,7 +16,6 @@ class EPlus
   EMSActuatorScheduleConstantValue = 'Schedule:Constant', 'Schedule Value'
   EMSActuatorScheduleYearValue = 'Schedule:Year', 'Schedule Value'
   EMSActuatorScheduleFileValue = 'Schedule:File', 'Schedule Value'
-  EMSActuatorSurfaceViewFactorToGround = 'Surface', 'View Factor To Ground'
   EMSActuatorZoneInfiltrationFlowRate = 'Zone Infiltration', 'Air Exchange Flow Rate'
   EMSActuatorZoneMixingFlowRate = 'ZoneMixing', 'Air Exchange Flow Rate'
   EMSIntVarFanMFR = 'Fan Maximum Mass Flow Rate'

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/generator.rb

@@ -1,18 +1,24 @@
+# *********************************************************************************
+# URBANopt (tm), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://github.com/urbanopt/urbanopt-cli/blob/develop/LICENSE.md
+# *********************************************************************************
+
 # frozen_string_literal: true
 
 class Generator
-  def self.apply(model, nbeds, generator)
+  def self.apply(model, nbeds, generator, unit_multiplier)
     obj_name = generator.id
 
-    if not generator.is_shared_system
-      annual_consumption_kbtu = generator.annual_consumption_kbtu
-      annual_output_kwh = generator.annual_output_kwh
-    else
+    # Apply unit multiplier
+    annual_consumption_kbtu = generator.annual_consumption_kbtu * unit_multiplier
+    annual_output_kwh = generator.annual_output_kwh * unit_multiplier
+
+    if generator.is_shared_system
       # Apportion to single dwelling unit by # bedrooms
       fail if generator.number_of_bedrooms_served.to_f <= nbeds.to_f # EPvalidator.xml should prevent this
 
-      annual_consumption_kbtu = generator.annual_consumption_kbtu * nbeds.to_f / generator.number_of_bedrooms_served.to_f
-      annual_output_kwh = generator.annual_output_kwh * nbeds.to_f / generator.number_of_bedrooms_served.to_f
+      annual_consumption_kbtu = annual_consumption_kbtu * nbeds.to_f / generator.number_of_bedrooms_served.to_f
+      annual_output_kwh = annual_output_kwh * nbeds.to_f / generator.number_of_bedrooms_served.to_f
     end
 
     input_w = UnitConversions.convert(annual_consumption_kbtu, 'kBtu', 'Wh') / 8760.0

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/geometry.rb

@@ -1,10 +1,17 @@
+# *********************************************************************************
+# URBANopt (tm), Copyright (c) Alliance for Sustainable Energy, LLC.
+# See also https://github.com/urbanopt/urbanopt-cli/blob/develop/LICENSE.md
+# *********************************************************************************
+
 # frozen_string_literal: true
 
 class Geometry
-  def self.create_space_and_zone(model, spaces, location)
+  def self.create_space_and_zone(model, spaces, location, zone_multiplier)
     if not spaces.keys.include? location
       thermal_zone = OpenStudio::Model::ThermalZone.new(model)
       thermal_zone.setName(location)
+      thermal_zone.additionalProperties.setFeature('ObjectType', location)
+      thermal_zone.setMultiplier(zone_multiplier)
 
       space = OpenStudio::Model::Space.new(model)
       space.setName(location)
@@ -158,7 +165,7 @@ class Geometry
     return OpenStudio::reverse(create_floor_vertices(length, width, z_origin, default_azimuths))
   end
 
-  def self.explode_surfaces(model, hpxml, walls_top)
+  def self.explode_surfaces(model, hpxml_bldg, walls_top)
     # Re-position surfaces so as to not shade each other and to make it easier to visualize the building.
 
     gap_distance = UnitConversions.convert(10.0, 'ft', 'm') # distance between surfaces of the same azimuth
@@ -203,7 +210,7 @@ class Geometry
     end
     explode_distance = max_azimuth_length / (2.0 * Math.tan(UnitConversions.convert(180.0 / nsides, 'deg', 'rad')))
 
-    add_neighbor_shading(model, max_azimuth_length, hpxml, walls_top)
+    add_neighbor_shading(model, max_azimuth_length, hpxml_bldg, walls_top)
 
     # Initial distance of shifts at 90-degrees to horizontal outward
     azimuth_side_shifts = {}
@@ -257,15 +264,6 @@ class Geometry
           end
         end
       end
-      model.getShadingSurfaceGroups.each do |shading_group|
-        next unless [Constants.ObjectNameSkylightShade, Constants.ObjectNameWindowShade].include? shading_group.name.to_s
-
-        shading_group.shadingSurfaces.each do |window_shade|
-          next unless window_shade.additionalProperties.getFeatureAsString('ParentSurface').get == surface.name.to_s
-
-          shading_surfaces << window_shade
-        end
-      end
 
       # Push out horizontally
       distance = explode_distance
@@ -306,14 +304,14 @@ class Geometry
     end
   end
 
-  def self.add_neighbor_shading(model, length, hpxml, walls_top)
+  def self.add_neighbor_shading(model, length, hpxml_bldg, walls_top)
     z_origin = 0 # shading surface always starts at grade
 
     shading_surfaces = []
-    hpxml.neighbor_buildings.each do |neighbor_building|
+    hpxml_bldg.neighbor_buildings.each do |neighbor_building|
       height = neighbor_building.height.nil? ? walls_top : neighbor_building.height
 
-      vertices = Geometry.create_wall_vertices(length, height, z_origin, neighbor_building.azimuth)
+      vertices = create_wall_vertices(length, height, z_origin, neighbor_building.azimuth)
       shading_surface = OpenStudio::Model::ShadingSurface.new(vertices, model)
       shading_surface.additionalProperties.setFeature('Azimuth', neighbor_building.azimuth)
       shading_surface.additionalProperties.setFeature('Distance', neighbor_building.distance)
@@ -331,22 +329,24 @@ class Geometry
     end
   end
 
-  def self.calculate_zone_volume(hpxml, location)
+  def self.calculate_zone_volume(hpxml_bldg, location)
     if [HPXML::LocationBasementUnconditioned,
         HPXML::LocationCrawlspaceUnvented,
         HPXML::LocationCrawlspaceVented,
         HPXML::LocationGarage].include? location
-      floor_area = hpxml.slabs.select { |s| s.interior_adjacent_to == location }.map { |s| s.area }.sum(0.0)
-      if location == HPXML::LocationGarage
-        height = 8.0
-      else
-        height = hpxml.foundation_walls.select { |w| w.interior_adjacent_to == location }.map { |w| w.height }.max
+      floor_area = hpxml_bldg.slabs.select { |s| s.interior_adjacent_to == location }.map { |s| s.area }.sum(0.0)
+      height = hpxml_bldg.foundation_walls.select { |w| w.interior_adjacent_to == location }.map { |w| w.height }.max
+      if height.nil? # No foundation walls, need to make assumption because HPXML Wall elements don't have a height
+        height = { HPXML::LocationBasementUnconditioned => 8,
+                   HPXML::LocationCrawlspaceUnvented => 3,
+                   HPXML::LocationCrawlspaceVented => 3,
+                   HPXML::LocationGarage => 8 }[location]
       end
       return floor_area * height
     elsif [HPXML::LocationAtticUnvented,
            HPXML::LocationAtticVented].include? location
-      floor_area = hpxml.floors.select { |f| [f.interior_adjacent_to, f.exterior_adjacent_to].include? location }.map { |s| s.area }.sum(0.0)
-      roofs = hpxml.roofs.select { |r| r.interior_adjacent_to == location }
+      floor_area = hpxml_bldg.floors.select { |f| [f.interior_adjacent_to, f.exterior_adjacent_to].include? location }.map { |s| s.area }.sum(0.0)
+      roofs = hpxml_bldg.roofs.select { |r| r.interior_adjacent_to == location }
       avg_pitch = roofs.map { |r| r.pitch }.sum(0.0) / roofs.size
       # Assume square hip roof for volume calculation
       length = floor_area**0.5
@@ -355,16 +355,19 @@ class Geometry
     end
   end
 
-  def self.set_zone_volumes(spaces, hpxml, apply_ashrae140_assumptions)
-    # Living space
-    spaces[HPXML::LocationLivingSpace].thermalZone.get.setVolume(UnitConversions.convert(hpxml.building_construction.conditioned_building_volume, 'ft^3', 'm^3'))
+  def self.set_zone_volumes(spaces, hpxml_bldg, apply_ashrae140_assumptions)
+    # Conditioned space
+    volume = UnitConversions.convert(hpxml_bldg.building_construction.conditioned_building_volume, 'ft^3', 'm^3')
+    spaces[HPXML::LocationConditionedSpace].thermalZone.get.setVolume(volume)
+    spaces[HPXML::LocationConditionedSpace].setVolume(volume)
 
     # Basement, crawlspace, garage
     spaces.keys.each do |location|
       next unless [HPXML::LocationBasementUnconditioned, HPXML::LocationCrawlspaceUnvented, HPXML::LocationCrawlspaceVented, HPXML::LocationGarage].include? location
 
-      volume = calculate_zone_volume(hpxml, location)
-      spaces[location].thermalZone.get.setVolume(UnitConversions.convert(volume, 'ft^3', 'm^3'))
+      volume = UnitConversions.convert(calculate_zone_volume(hpxml_bldg, location), 'ft^3', 'm^3')
+      spaces[location].thermalZone.get.setVolume(volume)
+      spaces[location].setVolume(volume)
     end
 
     # Attic
@@ -372,12 +375,13 @@ class Geometry
       next unless [HPXML::LocationAtticUnvented, HPXML::LocationAtticVented].include? location
 
       if apply_ashrae140_assumptions
-        volume = 3463 # Hardcode the attic volume to match ASHRAE 140 Table 7-2 specification
+        volume = UnitConversions.convert(3463, 'ft^3', 'm^3') # Hardcode the attic volume to match ASHRAE 140 Table 7-2 specification
       else
-        volume = calculate_zone_volume(hpxml, location)
+        volume = UnitConversions.convert(calculate_zone_volume(hpxml_bldg, location), 'ft^3', 'm^3')
       end
 
-      spaces[location].thermalZone.get.setVolume(UnitConversions.convert(volume, 'ft^3', 'm^3'))
+      spaces[location].thermalZone.get.setVolume(volume)
+      spaces[location].setVolume(volume)
     end
   end
 
@@ -424,6 +428,15 @@ class Geometry
                outdoor_weight: 0.0,
                ground_weight: 1.0,
                f_regain: 0.83 } # From LBNL's "Technical Background for default values used for Forced Air Systems in Proposed ASHRAE Standard 152P"
+    elsif location == HPXML::LocationManufacturedHomeBelly
+      # From LBNL's "Technical Background for default values used for Forced Air Systems in Proposed ASHRAE Standard 152P"
+      # 3.5 Manufactured House Belly Pan Temperatures
+      # FUTURE: Consider modeling the belly as a separate thermal zone so that we dynamically calculate temperatures.
+      return { temp_min: nil,
+               indoor_weight: 1.0,
+               outdoor_weight: 0.0,
+               ground_weight: 0.0,
+               f_regain: 0.62 }
     end
     fail "Unhandled location: #{location}."
   end
@@ -433,14 +446,14 @@ class Geometry
     minzs = []
     maxzs = []
     spaces.each do |space|
-      zvalues = getSurfaceZValues(space.surfaces)
+      zvalues = get_surface_z_values(space.surfaces)
       minzs << zvalues.min + UnitConversions.convert(space.zOrigin, 'm', 'ft')
       maxzs << zvalues.max + UnitConversions.convert(space.zOrigin, 'm', 'ft')
     end
     return maxzs.max - minzs.min
   end
 
-  def self.getSurfaceZValues(surfaceArray)
+  def self.get_surface_z_values(surfaceArray)
     # Return an array of z values for surfaces passed in. The values will be relative to the parent origin. This was intended for spaces.
     zValueArray = []
     surfaceArray.each do |surface|
@@ -451,6 +464,46 @@ class Geometry
     return zValueArray
   end
 
+  # Return an array of x values for surfaces passed in. The values will be relative to the parent origin. This was intended for spaces.
+  def self.get_surface_x_values(surfaceArray)
+    xValueArray = []
+    surfaceArray.each do |surface|
+      surface.vertices.each do |vertex|
+        xValueArray << UnitConversions.convert(vertex.x, 'm', 'ft').round(5)
+      end
+    end
+    return xValueArray
+  end
+
+  # Return an array of y values for surfaces passed in. The values will be relative to the parent origin. This was intended for spaces.
+  def self.get_surface_y_values(surfaceArray)
+    yValueArray = []
+    surfaceArray.each do |surface|
+      surface.vertices.each do |vertex|
+        yValueArray << UnitConversions.convert(vertex.y, 'm', 'ft').round(5)
+      end
+    end
+    return yValueArray
+  end
+
+  def self.get_surface_length(surface)
+    xvalues = get_surface_x_values([surface])
+    yvalues = get_surface_y_values([surface])
+    xrange = xvalues.max - xvalues.min
+    yrange = yvalues.max - yvalues.min
+    if xrange > yrange
+      return xrange
+    end
+
+    return yrange
+  end
+
+  def self.get_surface_height(surface)
+    zvalues = get_surface_z_values([surface])
+    zrange = zvalues.max - zvalues.min
+    return zrange
+  end
+
   def self.get_z_origin_for_zone(zone)
     z_origins = []
     zone.spaces.each do |space|
@@ -470,8 +523,8 @@ class Geometry
     return UnitConversions.convert(tilts.max, 'rad', 'deg')
   end
 
-  def self.apply_occupants(model, runner, hpxml, num_occ, space, schedules_file, unavailable_periods)
-    occ_gain, _hrs_per_day, sens_frac, _lat_frac = Geometry.get_occupancy_default_values()
+  def self.apply_occupants(model, runner, hpxml_bldg, num_occ, space, schedules_file, unavailable_periods)
+    occ_gain, _hrs_per_day, sens_frac, _lat_frac = get_occupancy_default_values()
     activity_per_person = UnitConversions.convert(occ_gain, 'Btu/hr', 'W')
 
     # Hard-coded convective, radiative, latent, and lost fractions
@@ -482,21 +535,21 @@ class Geometry
     people_sch = nil
     people_col_name = SchedulesFile::ColumnOccupants
     if not schedules_file.nil?
-      people_sch = schedules_file.create_schedule_file(col_name: people_col_name)
+      people_sch = schedules_file.create_schedule_file(model, col_name: people_col_name)
     end
     if people_sch.nil?
       people_unavailable_periods = Schedule.get_unavailable_periods(runner, people_col_name, unavailable_periods)
-      weekday_sch = hpxml.building_occupancy.weekday_fractions.split(',').map(&:to_f)
+      weekday_sch = hpxml_bldg.building_occupancy.weekday_fractions.split(',').map(&:to_f)
       weekday_sch = weekday_sch.map { |v| v / weekday_sch.max }.join(',')
-      weekend_sch = hpxml.building_occupancy.weekend_fractions.split(',').map(&:to_f)
+      weekend_sch = hpxml_bldg.building_occupancy.weekend_fractions.split(',').map(&:to_f)
       weekend_sch = weekend_sch.map { |v| v / weekend_sch.max }.join(',')
-      monthly_sch = hpxml.building_occupancy.monthly_multipliers
+      monthly_sch = hpxml_bldg.building_occupancy.monthly_multipliers
       people_sch = MonthWeekdayWeekendSchedule.new(model, Constants.ObjectNameOccupants + ' schedule', weekday_sch, weekend_sch, monthly_sch, Constants.ScheduleTypeLimitsFraction, unavailable_periods: people_unavailable_periods)
       people_sch = people_sch.schedule
     else
-      runner.registerWarning("Both '#{people_col_name}' schedule file and weekday fractions provided; the latter will be ignored.") if !hpxml.building_occupancy.weekday_fractions.nil?
-      runner.registerWarning("Both '#{people_col_name}' schedule file and weekend fractions provided; the latter will be ignored.") if !hpxml.building_occupancy.weekend_fractions.nil?
-      runner.registerWarning("Both '#{people_col_name}' schedule file and monthly multipliers provided; the latter will be ignored.") if !hpxml.building_occupancy.monthly_multipliers.nil?
+      runner.registerWarning("Both '#{people_col_name}' schedule file and weekday fractions provided; the latter will be ignored.") if !hpxml_bldg.building_occupancy.weekday_fractions.nil?
+      runner.registerWarning("Both '#{people_col_name}' schedule file and weekend fractions provided; the latter will be ignored.") if !hpxml_bldg.building_occupancy.weekend_fractions.nil?
+      runner.registerWarning("Both '#{people_col_name}' schedule file and monthly multipliers provided; the latter will be ignored.") if !hpxml_bldg.building_occupancy.monthly_multipliers.nil?
     end
 
     # Create schedule