openstudio-model-articulation 0.9.0 → 0.10.0

data/lib/measures/create_bar_from_building_type_ratios/README.md

@@ -350,7 +350,7 @@ Number of units argument not currently used by this measure
 **Required:** true,
 **Model Dependent:** false
 
-**Choice Display Names** ["SecondarySchool", "PrimarySchool", "SmallOffice", "MediumOffice", "LargeOffice", "SmallHotel", "LargeHotel", "Warehouse", "RetailStandalone", "RetailStripmall", "QuickServiceRestaurant", "FullServiceRestaurant", "MidriseApartment", "HighriseApartment", "Hospital", "Outpatient", "SuperMarket", "Laboratory", "LargeDataCenterLowITE", "LargeDataCenterHighITE", "SmallDataCenterLowITE", "SmallDataCenterHighITE", "Courthouse", "College", "Asm", "DMo", "ECC", "EPr", "ERC", "ESe", "EUn", "GHs", "Gro", "Hsp", "Htl", "MBT", "MFm", "MLI", "Mtl", "Nrs", "OfL", "OfS", "RFF", "RSD", "Rt3", "RtL", "RtS", "SCn", "SFm", "SUn", "WRf"]
+**Choice Display Names** ["SecondarySchool", "PrimarySchool", "SmallOffice", "MediumOffice", "LargeOffice", "SmallHotel", "LargeHotel", "Warehouse", "RetailStandalone", "RetailStripmall", "QuickServiceRestaurant", "FullServiceRestaurant", "MidriseApartment", "HighriseApartment", "Hospital", "Outpatient", "SuperMarket", "Laboratory", "LargeDataCenterLowITE", "LargeDataCenterHighITE", "SmallDataCenterLowITE", "SmallDataCenterHighITE", "Courthouse", "College"]
 
 
 ### Building Type C Fraction of Building Floor Area
@@ -471,7 +471,7 @@ Set Building Rotation off of North (positive value is clockwise). Rotation appli
 **Required:** true,
 **Model Dependent:** false
 
-**Choice Display Names** ["DOE Ref Pre-1980", "DOE Ref 1980-2004", "90.1-2004", "90.1-2007", "90.1-2010", "90.1-2013", "90.1-2016", "90.1-2019", "ComStock DOE Ref Pre-1980", "ComStock DOE Ref 1980-2004", "ComStock 90.1-2004", "ComStock 90.1-2007", "ComStock 90.1-2010", "ComStock 90.1-2013", "ComStock 90.1-2016", "ComStock 90.1-2019", "NREL ZNE Ready 2017", "DEER Pre-1975", "DEER 1985", "DEER 1996", "DEER 2003", "DEER 2007", "DEER 2011", "DEER 2014", "DEER 2015", "DEER 2017", "DEER 2020", "DEER 2025", "DEER 2030", "DEER 2035", "DEER 2040", "DEER 2045", "DEER 2050", "DEER 2055", "DEER 2060", "DEER 2065", "DEER 2070", "DEER 2075"]
+**Choice Display Names** ["DOE Ref Pre-1980", "DOE Ref 1980-2004", "90.1-2004", "90.1-2007", "90.1-2010", "90.1-2013", "90.1-2016", "90.1-2019", "ComStock DOE Ref Pre-1980", "ComStock DOE Ref 1980-2004", "ComStock 90.1-2004", "ComStock 90.1-2007", "ComStock 90.1-2010", "ComStock 90.1-2013", "ComStock 90.1-2016", "ComStock 90.1-2019", "DEER Pre-1975", "DEER 1985", "DEER 1996", "DEER 2003", "DEER 2007", "DEER 2011", "DEER 2014", "DEER 2015", "DEER 2017", "DEER 2020", "ComStock DEER Pre-1975", "ComStock DEER 1985", "ComStock DEER 1996", "ComStock DEER 2003", "ComStock DEER 2007", "ComStock DEER 2011", "ComStock DEER 2014", "ComStock DEER 2015", "ComStock DEER 2017", "ComStock DEER 2020"]
 
 
 ### Ratio of North/South Facade Length Relative to East/West Facade Length
@@ -644,17 +644,6 @@ When true this will look for arguments or registerValues in upstream measures th
 **Model Dependent:** false
 
 
-### Climate Zone
-Climate Zone argument is not used by this measure
-**Name:** climate_zone,
-**Type:** Choice,
-**Units:** ,
-**Required:** true,
-**Model Dependent:** false
-
-**Choice Display Names** ["Lookup From Stat File", "ASHRAE 169-2013-1A", "ASHRAE 169-2013-1B", "ASHRAE 169-2013-2A", "ASHRAE 169-2013-2B", "ASHRAE 169-2013-3A", "ASHRAE 169-2013-3B", "ASHRAE 169-2013-3C", "ASHRAE 169-2013-4A", "ASHRAE 169-2013-4B", "ASHRAE 169-2013-4C", "ASHRAE 169-2013-5A", "ASHRAE 169-2013-5B", "ASHRAE 169-2013-5C", "ASHRAE 169-2013-6A", "ASHRAE 169-2013-6B", "ASHRAE 169-2013-7A", "ASHRAE 169-2013-8A", "CEC T24-CEC1", "CEC T24-CEC2", "CEC T24-CEC3", "CEC T24-CEC4", "CEC T24-CEC5", "CEC T24-CEC6", "CEC T24-CEC7", "CEC T24-CEC8", "CEC T24-CEC9", "CEC T24-CEC10", "CEC T24-CEC11", "CEC T24-CEC12", "CEC T24-CEC13", "CEC T24-CEC14", "CEC T24-CEC15", "CEC T24-CEC16"]
-
-
 
 
 

data/lib/measures/create_bar_from_building_type_ratios/measure.rb

@@ -8,20 +8,8 @@
 
 require 'openstudio-standards'
 
-# load OpenStudio measure libraries fro m openstudio-extension gem
-require 'openstudio-extension'
-require 'openstudio/extension/core/os_lib_helper_methods'
-require 'openstudio/extension/core/os_lib_geometry'
-require 'openstudio/extension/core/os_lib_model_generation'
-require 'openstudio/extension/core/os_lib_model_simplification'
-
 # start the measure
 class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
-  # resource file modules
-  include OsLib_HelperMethods
-  include OsLib_Geometry
-  include OsLib_ModelGeneration
-  include OsLib_ModelSimplification
 
   # human readable name
   def name
@@ -43,12 +31,82 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     return 'Envelope.Form'
   end
 
+  # remove existing non resource objects from the model
+  # technically thermostats and building stories are resources but still want to remove them.
+  def remove_non_resource_objects(runner, model, options = nil)
+    if options.nil?
+      options = {}
+      options[:remove_building_stories] = true
+      options[:remove_thermostats] = true
+      options[:remove_air_loops] = true
+      options[:remove_non_swh_plant_loops] = true
+
+      # leave these in by default unless requsted when method called
+      options[:remove_swh_plant_loops] = false
+      options[:remove_exterior_lights] = false
+      options[:remove_site_shading] = false
+    end
+
+    num_model_objects = model.objects.size
+
+    # remove non-resource objects not removed by removing the building
+    if options[:remove_building_stories] then model.getBuildingStorys.each(&:remove) end
+    if options[:remove_thermostats] then model.getThermostats.each(&:remove) end
+    if options[:remove_air_loops] then model.getAirLoopHVACs.each(&:remove) end
+    if options[:remove_exterior_lights] then model.getFacility.exteriorLights.each(&:remove) end
+    if options[:remove_site_shading] then model.getSite.shadingSurfaceGroups.each(&:remove) end
+
+    # see if plant loop is swh or not and take proper action (booter loop doesn't have water use equipment)
+    model.getPlantLoops.each do |plant_loop|
+      is_swh_loop = false
+      plant_loop.supplyComponents.each do |component|
+        if component.to_WaterHeaterMixed.is_initialized
+          is_swh_loop = true
+          next
+        end
+      end
+
+      if is_swh_loop
+        if options[:remove_swh_plant_loops] then plant_loop.remove end
+      else
+        if options[:remove_non_swh_plant_loops] then plant_loop.remove end
+      end
+    end
+
+    # remove water use connections (may be removed when loop is removed)
+    if options[:remove_swh_plant_loops] then model.getWaterConnectionss.each(&:remove) end
+    if options[:remove_swh_plant_loops] then model.getWaterUseEquipments.each(&:remove) end
+
+    # remove building but reset fields on new building object.
+    building_fields = []
+    building = model.getBuilding
+    num_fields = building.numFields
+    num_fields.times.each do |i|
+      building_fields << building.getString(i).get
+    end
+    # removes spaces, space's child objects, thermal zones, zone equipment, non site surfaces, building stories and water use connections.
+    model.getBuilding.remove
+    building = model.getBuilding
+    num_fields.times.each do |i|
+      next if i == 0 # don't try and set handle
+      building_fields << building.setString(i, building_fields[i])
+    end
+
+    # other than optionally site shading and exterior lights not messing with site characteristics
+
+    if num_model_objects - model.objects.size > 0
+      runner.registerInfo("Removed #{num_model_objects - model.objects.size} non resource objects from the model.")
+    end
+
+    return true
+  end
+
   # define the arguments that the user will input
   def arguments(model)
     args = OpenStudio::Measure::OSArgumentVector.new
 
     # Make an argument for the bldg_type_a
-    bldg_type_a = OpenStudio::Measure::OSArgument.makeChoiceArgument('bldg_type_a', get_building_types, true)
+    bldg_type_a = OpenStudio::Measure::OSArgument.makeChoiceArgument('bldg_type_a', OpenstudioStandards::CreateTypical.get_building_types, true)
     bldg_type_a.setDisplayName('Primary Building Type')
     bldg_type_a.setDefaultValue('SmallOffice')
     args << bldg_type_a
@@ -61,7 +119,7 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     args << bldg_type_a_num_units
 
     # Make an argument for the bldg_type_b
-    bldg_type_b = OpenStudio::Measure::OSArgument.makeChoiceArgument('bldg_type_b', get_building_types, true)
+    bldg_type_b = OpenStudio::Measure::OSArgument.makeChoiceArgument('bldg_type_b', OpenstudioStandards::CreateTypical.get_building_types, true)
     bldg_type_b.setDisplayName('Building Type B')
     bldg_type_b.setDefaultValue('SmallOffice')
     args << bldg_type_b
@@ -70,6 +128,8 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     bldg_type_b_fract_bldg_area = OpenStudio::Measure::OSArgument.makeDoubleArgument('bldg_type_b_fract_bldg_area', true)
     bldg_type_b_fract_bldg_area.setDisplayName('Building Type B Fraction of Building Floor Area')
     bldg_type_b_fract_bldg_area.setDefaultValue(0.0)
+    bldg_type_b_fract_bldg_area.setMinValue(0.0)
+    bldg_type_b_fract_bldg_area.setMaxValue(1.0)
     args << bldg_type_b_fract_bldg_area
 
     # Make argument for bldg_type_b_num_units
@@ -80,7 +140,7 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     args << bldg_type_b_num_units
 
     # Make an argument for the bldg_type_c
-    bldg_type_c = OpenStudio::Measure::OSArgument.makeChoiceArgument('bldg_type_c', get_building_types, true)
+    bldg_type_c = OpenStudio::Measure::OSArgument.makeChoiceArgument('bldg_type_c', OpenstudioStandards::CreateTypical.get_doe_building_types, true)
     bldg_type_c.setDisplayName('Building Type C')
     bldg_type_c.setDefaultValue('SmallOffice')
     args << bldg_type_c
@@ -89,6 +149,8 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     bldg_type_c_fract_bldg_area = OpenStudio::Measure::OSArgument.makeDoubleArgument('bldg_type_c_fract_bldg_area', true)
     bldg_type_c_fract_bldg_area.setDisplayName('Building Type C Fraction of Building Floor Area')
     bldg_type_c_fract_bldg_area.setDefaultValue(0.0)
+    bldg_type_c_fract_bldg_area.setMinValue(0.0)
+    bldg_type_c_fract_bldg_area.setMaxValue(1.0)
     args << bldg_type_c_fract_bldg_area
 
     # Make argument for bldg_type_c_num_units
@@ -99,7 +161,7 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     args << bldg_type_c_num_units
 
     # Make an argument for the bldg_type_d
-    bldg_type_d = OpenStudio::Measure::OSArgument.makeChoiceArgument('bldg_type_d', get_building_types, true)
+    bldg_type_d = OpenStudio::Measure::OSArgument.makeChoiceArgument('bldg_type_d', OpenstudioStandards::CreateTypical.get_building_types, true)
     bldg_type_d.setDisplayName('Building Type D')
     bldg_type_d.setDefaultValue('SmallOffice')
     args << bldg_type_d
@@ -108,6 +170,8 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     bldg_type_d_fract_bldg_area = OpenStudio::Measure::OSArgument.makeDoubleArgument('bldg_type_d_fract_bldg_area', true)
     bldg_type_d_fract_bldg_area.setDisplayName('Building Type D Fraction of Building Floor Area')
     bldg_type_d_fract_bldg_area.setDefaultValue(0.0)
+    bldg_type_d_fract_bldg_area.setMinValue(0.0)
+    bldg_type_d_fract_bldg_area.setMaxValue(1.0)
     args << bldg_type_d_fract_bldg_area
 
     # Make argument for bldg_type_d_num_units
@@ -122,6 +186,7 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     total_bldg_floor_area.setDisplayName('Total Building Floor Area')
     total_bldg_floor_area.setUnits('ft^2')
     total_bldg_floor_area.setDefaultValue(10000.0)
+    total_bldg_floor_area.setMinValue(0.0)
     args << total_bldg_floor_area
 
     # Make argument for single_floor_area
@@ -130,6 +195,7 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     single_floor_area.setDescription('Non-zero value will fix the single floor area, overriding a user entry for Total Building Floor Area')
     single_floor_area.setUnits('ft^2')
     single_floor_area.setDefaultValue(0.0)
+    single_floor_area.setMinValue(0.0)
     args << single_floor_area
 
     # Make argument for floor_height
@@ -138,6 +204,7 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     floor_height.setDescription('Selecting a typical floor height of 0 will trigger a smart building type default.')
     floor_height.setUnits('ft')
     floor_height.setDefaultValue(0.0)
+    floor_height.setMinValue(0.0)
     args << floor_height
 
     # add argument to enable/disable multi custom space height bar
@@ -151,12 +218,14 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     num_stories_above_grade = OpenStudio::Measure::OSArgument.makeDoubleArgument('num_stories_above_grade', true)
     num_stories_above_grade.setDisplayName('Number of Stories Above Grade')
     num_stories_above_grade.setDefaultValue(1.0)
+    num_stories_above_grade.setMinValue(1.0)
     args << num_stories_above_grade
 
     # Make argument for num_stories_below_grade
     num_stories_below_grade = OpenStudio::Measure::OSArgument.makeIntegerArgument('num_stories_below_grade', true)
     num_stories_below_grade.setDisplayName('Number of Stories Below Grade')
     num_stories_below_grade.setDefaultValue(0)
+    num_stories_below_grade.setMinValue(0)
     args << num_stories_below_grade
 
     # Make argument for building_rotation
@@ -165,10 +234,11 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     building_rotation.setDescription('Set Building Rotation off of North (positive value is clockwise). Rotation applied after geometry generation. Values greater than +/- 45 will result in aspect ratio and party wall orientations that do not match cardinal directions of the inputs.')
     building_rotation.setUnits('Degrees')
     building_rotation.setDefaultValue(0.0)
+    building_rotation.setDefaultValue(0.0)
     args << building_rotation
 
     # Make argument for template
-    template = OpenStudio::Measure::OSArgument.makeChoiceArgument('template', get_templates(true), true)
+    template = OpenStudio::Measure::OSArgument.makeChoiceArgument('template', OpenstudioStandards::CreateTypical.get_templates(false), true)
     template.setDisplayName('Target Standard')
     template.setDefaultValue('90.1-2004')
     args << template
@@ -178,6 +248,7 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     ns_to_ew_ratio.setDisplayName('Ratio of North/South Facade Length Relative to East/West Facade Length')
     ns_to_ew_ratio.setDescription('Selecting an aspect ratio of 0 will trigger a smart building type default. Aspect ratios less than one are not recommended for sliced bar geometry, instead rotate building and use a greater than 1 aspect ratio.')
     ns_to_ew_ratio.setDefaultValue(0.0)
+    ns_to_ew_ratio.setMinValue(0.0)
     args << ns_to_ew_ratio
 
     # Make argument for perim_mult
@@ -185,6 +256,7 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     perim_mult.setDisplayName('Perimeter Multiplier')
     perim_mult.setDescription('Selecting a value of 0 will trigger a smart building type default. This represents a multiplier for the building perimeter relative to the perimeter of a rectangular building that meets the area and aspect ratio inputs. Other than the smart default of 0.0 this argument should have a value of 1.0 or higher and is only applicable Multiple Space Types - Individual Stories Sliced division method.')
     perim_mult.setDefaultValue(0.0)
+    perim_mult.setMinValue(0.0)
     args << perim_mult
 
     # Make argument for bar_width
@@ -193,6 +265,7 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     bar_width.setDescription('Non-zero value will fix the building width, overriding user entry for Perimeter Multiplier. NS/EW Aspect Ratio may be limited based on target width.')
     bar_width.setUnits('ft')
     bar_width.setDefaultValue(0.0)
+    bar_width.setMinValue(0.0)
     args << bar_width
 
     # Make argument for bar_sep_dist_mult
@@ -207,6 +280,8 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     wwr.setDisplayName('Window to Wall Ratio')
     wwr.setDescription('Selecting a window to wall ratio of 0 will trigger a smart building type default.')
     wwr.setDefaultValue(0.0)
+    wwr.setMinValue(0.0)
+    wwr.setMaxValue(1.0)
     args << wwr
 
     # Make argument for party_wall_fraction
@@ -214,6 +289,8 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     party_wall_fraction.setDisplayName('Fraction of Exterior Wall Area with Adjacent Structure')
     party_wall_fraction.setDescription('This will impact how many above grade exterior walls are modeled with adiabatic boundary condition.')
     party_wall_fraction.setDefaultValue(0.0)
+    party_wall_fraction.setMinValue(0.0)
+    party_wall_fraction.setMaxValue(1.0)
     args << party_wall_fraction
 
     # party_wall_fraction was used where we wanted to represent some party walls but didn't know where they are, it ends up using methods to make whole surfaces adiabiatc by story and orientaiton to try to come close to requested fraction
@@ -223,6 +300,7 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     party_wall_stories_north.setDisplayName('Number of North facing stories with party wall')
     party_wall_stories_north.setDescription('This will impact how many above grade exterior north walls are modeled with adiabatic boundary condition. If this is less than the number of above grade stoes, upper flor will reamin exterior')
     party_wall_stories_north.setDefaultValue(0)
+    party_wall_stories_north.setMinValue(0)
     args << party_wall_stories_north
 
     # Make argument for party_wall_stories_south
@@ -230,6 +308,7 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     party_wall_stories_south.setDisplayName('Number of South facing stories with party wall')
     party_wall_stories_south.setDescription('This will impact how many above grade exterior south walls are modeled with adiabatic boundary condition. If this is less than the number of above grade stoes, upper flor will reamin exterior')
     party_wall_stories_south.setDefaultValue(0)
+    party_wall_stories_south.setMinValue(0)
     args << party_wall_stories_south
 
     # Make argument for party_wall_stories_east
@@ -237,6 +316,7 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     party_wall_stories_east.setDisplayName('Number of East facing stories with party wall')
     party_wall_stories_east.setDescription('This will impact how many above grade exterior east walls are modeled with adiabatic boundary condition. If this is less than the number of above grade stoes, upper flor will reamin exterior')
     party_wall_stories_east.setDefaultValue(0)
+    party_wall_stories_east.setMinValue(0)
     args << party_wall_stories_east
 
     # Make argument for party_wall_stories_west
@@ -244,6 +324,7 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     party_wall_stories_west.setDisplayName('Number of West facing stories with party wall')
     party_wall_stories_west.setDescription('This will impact how many above grade exterior west walls are modeled with adiabatic boundary condition. If this is less than the number of above grade stoes, upper flor will reamin exterior')
     party_wall_stories_west.setDefaultValue(0)
+    party_wall_stories_west.setMinValue(0)
     args << party_wall_stories_west
 
     # make an argument for bottom_story_ground_exposed_floor
@@ -318,15 +399,6 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     use_upstream_args.setDefaultValue(true)
     args << use_upstream_args
 
-    # TODO: - expose perimeter depth as an argument
-
-    # Argument used to make ComStock tsv workflow run correctly
-    climate_zone = OpenStudio::Measure::OSArgument.makeChoiceArgument('climate_zone', get_climate_zones(false, 'Lookup From Stat File'), true)
-    climate_zone.setDisplayName('Climate Zone')
-    climate_zone.setDefaultValue('Lookup From Stat File')
-    climate_zone.setDescription('Climate Zone argument is not used by this measure')
-    args << climate_zone
-
     return args
   end
 
@@ -334,9 +406,6 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
   def run(model, runner, user_arguments)
     super(model, runner, user_arguments)
 
-    # require 'openstudio-extension'
-    # puts OpenStudio::Extension::VERSION
-
     # temporary bypass of openstudio surface intersection to avoid problematic behavior
     # can be removed after fixes to core OS geometry methods are made. # aka, force argument false
     orig_val = user_arguments['make_mid_story_surfaces_adiabatic']
@@ -345,9 +414,32 @@ class CreateBarFromBuildingTypeRatios < OpenStudio::Measure::ModelMeasure
     end
     user_arguments['make_mid_story_surfaces_adiabatic'].setValue(true)
 
-    result = bar_from_building_type_ratios(model, runner, user_arguments)
+    # assign the user inputs to variables
+    args = runner.getArgumentValues(arguments(model), user_arguments)
+    args = Hash[args.collect{ |k, v| [k.to_sym, v] }]
+    if !args then return false end
+
+    # todo - need to make use of this before pass to standards
+    use_upstream_args = args['use_upstream_args']
+      
+    # open channel to log messages
+    reset_log
+
+    # Turn debugging output on/off
+    debug = false
+
+    # remove_non_resource_objects (this was not moved to standards, so added method in measure for now)
+    remove_non_resource_objects(runner, model)
+
+    # method run from os_lib_model_generation.rb
+    result = OpenstudioStandards::Geometry.create_bar_from_building_type_ratios(model, args)
+
+    # gather log
+    log_messages_to_runner(runner, debug)
+    reset_log
 
     if result == false
+      runner.registerError("Measure did not complete successfully")
       return false
     else
       return true