openstudio-standards 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7450bc1f7fafb6ea4c38f2460c91ce4b50881e0b
-  data.tar.gz: baefac3f3a01a848385af2328ba6a75b24fd15b9
+  metadata.gz: b08625a687a26b2b2bd1bfb397a5d58a2a021d0b
+  data.tar.gz: b5f0a2617f203d619d52acff7ed23def375cf52f
 SHA512:
-  metadata.gz: 3d5490ef495ac0e77d205668787e70870c0e89ad105d7a0a0161d3cc9a40dfb8758b16823124d44db928aebbd21e3826f26e6650ff165e7123e07a125936edb3
-  data.tar.gz: 8262a4dbea3197b71ae721ce0508f5be19049df04fa0e9e10c6f94cec179e359e8dbcfd15c494c28fbe21cb5210d8734cf515050519c9cb5298c6bcff8473a28
+  metadata.gz: 46a1fdba2ba4f46244127348a3f80f7512e7baf02121d182fabdb22e3252ed981db0ff0c1e9a4388e2e39281f777ad95330bbed2e94664dafdd4b9ae5193a640
+  data.tar.gz: 932107495b5cb807f3c48f8e229bfa2f2b78c7e72baddf4466eb7516a839162bb4ba0154872bfac59f9f39e08d2b2602eec6f93fbf380edbd0dc2ce61f9533e7

data/lib/openstudio-standards/btap/compliance.rb

@@ -608,7 +608,7 @@ module BTAP
  
       
       
-      def self.necb_spacetype_system_selection(model, heatingDesignLoad  = nil,coolingDesignLoad = nil, runner = nil  )
+      def self.necb_spacetype_system_selection( model, heatingDesignLoad  = nil,coolingDesignLoad = nil, runner = nil  )
         spacezoning_data = Struct.new( 
           :space,                   # the space object 
           :space_name,              # the space name
@@ -651,8 +651,9 @@ module BTAP
             space_system_index = nil
           else
             space_type_property = space.model.find_object($os_standards["space_types"], { "template" => 'NECB 2011', "space_type" => space.spaceType.get.standardsSpaceType.get,"building_type" => space.spaceType.get.standardsBuildingType.get })
+            raise("could not find necb system selection type for space: #{space.name} and spacetype #{space.spaceType.get.standardsSpaceType.get}") if space_type_property.nil?
             necb_hvac_system_selection_type = space_type_property['necb_hvac_system_selection_type']
-            raise("could not find necb system selection type for space: #{space.get.name}") if space_type_property.nil?
+            
           end
           
           
@@ -734,7 +735,7 @@ module BTAP
           when "Warehouse Area - refrigerated"
             system = 5
           when "Wildcard"
-            system = "Wildcard"
+            system = nil
           else
             raise ("NECB HVAC System Selection Type #{necb_hvac_system_selection_type} not valid")
           end 
@@ -866,11 +867,14 @@ module BTAP
         
         #Deal with Wildcard spaces. Might wish to have logic to do coridors first.
         space_zoning_data_array.each do |space_zone_data|
-          if space_zone_data.system_number == "Wildcard"
+          #If it is a wildcard space.
+          if space_zone_data.system_number.nil?
             #iterate through all adjacent spaces from largest shared wall area to smallest.
             # Set system type to match first space system that is not nil. 
             space_zone_data.space.get_adjacent_spaces_with_shared_wall_areas(true).each do |adj_space|
+              #if there are no adjacent zones near a wh
               raise ("Could not determine adj space to space #{space_zone_data.space.name.get}") if adj_space.nil?
+
               adj_space_data = space_zoning_data_array.find { |data| data.space == adj_space[0] }
               if adj_space_data.system_number.nil?
                 next
@@ -915,7 +919,7 @@ module BTAP
                   #puts "Spacename: #{space_info.space.name}:#{space_info.space.spaceType.get.name}"
                   if space_info.system_number == system_number and 
                       space_info.space.spaceType.get.name.get.include?("- undefined -") == false and
-                      space_info.story == story and
+                      space_info.space.buildingStory.get == story and
                       BTAP::Compliance::NECB2011::determine_necb_schedule_type(space_info.space).to_s == schedule_type and
                       space_info.horizontal_placement == horizontal_placement
 
@@ -982,8 +986,14 @@ module BTAP
             thermal_zone_ideal_loads = OpenStudio::Model::ZoneHVACIdealLoadsAirSystem.new(model)
             thermal_zone_ideal_loads.addToThermalZone(thermal_zone)
           end
-        end               
-      end
+        end 
+        #Check to ensure that all spaces are assigned to zones except undefined ones. 
+        model.getSpaces.each do |space|
+        if space.thermalZone.empty? and space.spaceType.get.name.get != 'Space Function - undefined -'
+         raise( "space #{space.name} with spacetype #{space.spaceType.get.name.get}" )
+        end    
+        end         
+      end #
     end
   end #Compliance
 end

data/lib/openstudio-standards/btap/hvac.rb

@@ -3065,7 +3065,6 @@ module BTAP
                 htg_coil.setMinimumOutdoorDryBulbTemperatureforCompressorOperation(-10.0)
                 sizing_zone.setZoneHeatingSizingFactor(1.3)
                 sizing_zone.setZoneCoolingSizingFactor(1.0)
-puts 'test1111'               
               else
                 raise("#{heating_coil_type} is not a valid heating coil type.)")
               end
@@ -3106,8 +3105,8 @@ puts 'test1111'
               # supply air temperature based on the needs of this zone
               setpoint_mgr_single_zone_reheat = OpenStudio::Model::SetpointManagerSingleZoneReheat.new(model)
               setpoint_mgr_single_zone_reheat.setControlZone(zone)
-              setpoint_mgr_single_zone_reheat.setMinimumSupplyAirTemperature(12.8)
-              setpoint_mgr_single_zone_reheat.setMaximumSupplyAirTemperature(13.0)
+              setpoint_mgr_single_zone_reheat.setMinimumSupplyAirTemperature(13)
+              setpoint_mgr_single_zone_reheat.setMaximumSupplyAirTemperature(43)
               setpoint_mgr_single_zone_reheat.addToNode(air_loop.supplyOutletNode)
 
               # Create a diffuser and attach the zone/diffuser pair to the air loop
@@ -3441,8 +3440,9 @@ puts 'test1111'
               setpoint_mgr_single_zone_reheat = OpenStudio::Model::SetpointManagerSingleZoneReheat.new(model)
               setpoint_mgr_single_zone_reheat.setControlZone(zone)
               setpoint_mgr_single_zone_reheat.setMinimumSupplyAirTemperature(13.0)
+              setpoint_mgr_single_zone_reheat.setMaximumSupplyAirTemperature(43.0)
               setpoint_mgr_single_zone_reheat.addToNode(air_loop.supplyOutletNode)
-
+     
 
               #Create sensible heat exchanger
               #              heat_exchanger = BTAP::Resources::HVAC::Plant::add_hrv(model)
@@ -3623,7 +3623,8 @@ puts 'test1111'
                   #TODO: schedule based on whether the zone is occupied or not as stipulated in 8.4.4.22 of NECB2011
                   min_flow_rate = 0.002*zone.floorArea
                   vav_terminal.setFixedMinimumAirFlowRate(min_flow_rate) 
-	                vav_terminal.setMaximumReheatAirTemperature(43)
+	              vav_terminal.setMaximumReheatAirTemperature(43)
+                  vav_terminal.setDamperHeatingAction("Reverse")
 
                   #Set zone baseboards
                   if ( baseboard_type == "Electric") then

data/lib/openstudio-standards/btap/measures.rb

@@ -22,15 +22,109 @@
 # and open the template in the editor.
 require "#{File.dirname(__FILE__)}/btap"
 
+class OSMArg
+  ARGUMENT_TYPES = [
+    "BOOL",         
+    "STRING",       
+    "INTEGER",      
+    "FLOAT",        
+    "STRINGCHOICE",
+    "WSCHOICE"     
+  ]
+        
+        
+        
+  attr_accessor :runner, 
+    :variable_name, 
+    :type,
+    :required,  
+    :model_dependant,
+    :display_name, 
+    :default_value, 
+    :min_value,  
+    :max_value,  
+    :string_choice_array,  	
+    :os_object_type
+        
+  def self.bool( variable_name,display_name,required,default_value )
+    raise "#{default_value} defaut value is not a bool." unless default_value.is_a?(Bool)
+    default_value.respond_to?(:to_s)
+    arg = OSMArg.new( "BOOL", variable_name, display_name, required)
+    arg.default_value = default_value
+    return arg
+  end
+        
+  def self.string( variable_name,display_name,required,default_value )
+    raise "#{default_value} defaut value is not a string." unless default_value.respond_to?(:to_s)
+    arg = OSMArg.new( "STRING", variable_name, display_name, required)
+    arg.default_value = default_value
+    return arg
+  end
+        
+  def self.integer( variable_name,display_name,required,default_value,min_value,max_value )
+    raise "#{default_value} defaut value is not a integer." unless default_value.respond_to?(:to_i)
+    arg = OSMArg.new( "INTEGER", variable_name, display_name, required)
+    arg.default_value = default_value
+    arg.min_value = min_value
+    arg.max_value = max_value
+    return arg          
+  end
+        
+  def self.float( variable_name, display_name, required,default_value,min_value, max_value )
+    raise "#{default_value} defaut value is not a float." unless default_value.respond_to?(:to_f)
+    arg = OSMArg.new( "INTEGER", variable_name, display_name, required)
+    arg.default_value = default_value
+    arg.min_value = min_value
+    arg.max_value = max_value
+    return arg          
+  end
+        
+  def self.choice(variable_name,display_name,required,default_value,string_choice_array)
+    raise "#{default_value} defaut value is not an array." unless default_value.is_a?(Array)    
+    arg = OSMArg.new( "STRINGCHOICE", variable_name, display_name, required)
+    arg.default_value = default_value
+    arg.string_choice_array = string_choice_array
+    return arg
+  end
+        
+  def self.wschoice( variable_name, display_name, required, default_value, os_object_type)
+    arg = OSMArg.new( "WSCHOICE", variable_name, display_name, required )
+    arg.default_value = default_value
+    arg.os_object_type = os_object_type
+    return arg          
+  end
+        
+  def initialize( type, variable_name, display_name, required )
+    self.type = type
+    self.variable_name = variable_name
+    self.display_name = display_name
+    self.required = required
+    self.model_dependant = false
+    if self.type == "WSCHOICE"
+      self.model_dependant = true
+    else
+      self.model_dependant = false
+    end
+    return self
+  end  
+end
+      
+
+
 
 
 module BTAP
   module Measures
     module OSMeasures
+      
+      
+      
+      
       class BTAPModelUserScript < OpenStudio::Ruleset::ModelUserScript
         #if and E+ measure replace OpenStudio::Ruleset::ModelUserScript with OpenStudio::Ruleset::WorkspaceUserScript
         #Array containing information of all inputs required by measure.
         attr_accessor :argument_array_of_arrays
+        attr_accessor :argument_array
         attr_accessor :file
         #Name of measure
         #attr_accessor :name
@@ -38,6 +132,7 @@ module BTAP
         #if and E+ measure replace OpenStudio::Ruleset::ModelUserScript with OpenStudio::Ruleset::WorkspaceUserScript
         def name
           "BTAPModelUserScript"
+          OSMArgument.new
         end
         
         #this method will output the ruby macro to perform the change. 
@@ -52,61 +147,6 @@ module BTAP
           BTAP::runner_register("MACRO", "\##{self.class.name} Measure End", runner)
         end
 
-        def arguments(model,argument_array_of_arrays)
-          #IF and E+ measure replace model with workspace as the argument
-
-          #Create an argument vector
-          args = OpenStudio::Ruleset::OSArgumentVector.new
-
-          @argument_array_of_arrays = argument_array_of_arrays
-
-          #***boilerplate code starts. Do not edit...
-          # this converts the 2D array to a array hash for better readability and makes
-          # column data accessible by name.
-          @argument_array_of_hashes = []
-          @argument_array_of_arrays[1..-1].each do |row|   # [1..-1] skips the first row
-            hsh = {}; @argument_array_of_arrays[0].each_with_index{ |header, idx|   hsh[header] = row[idx] }
-            @argument_array_of_hashes << hsh
-          end
-
-          #iterate through array of hashes and make arguments based on type and set
-          # max and min values where applicable.
-          @argument_array_of_hashes.each do |row|
-            arg = nil
-            case row["type"]
-            when "BOOL"
-              arg = OpenStudio::Ruleset::OSArgument::makeBoolArgument(row["variable_name"],row["required"],row["model_dependant"])
-            when "STRING"
-              arg = OpenStudio::Ruleset::OSArgument::makeStringArgument(row["variable_name"],row["required"],row["model_dependant"])
-            when "INTEGER"
-              arg = OpenStudio::Ruleset::OSArgument::makeIntegerArgument(row["variable_name"],row["required"],row["model_dependant"])
-              arg.setMaxValue( row["max_value"].to_i ) unless row["min_value"].nil?
-              arg.setMaxValue( row["max_value"].to_i ) unless  row["max_value"].nil?
-            when "FLOAT"
-              arg = OpenStudio::Ruleset::OSArgument::makeDoubleArgument(row["variable_name"],row["required"],row["model_dependant"])
-              arg.setMaxValue( row["max_value"].to_f ) unless row["min_value"].nil?
-              arg.setMaxValue( row["max_value"].to_f ) unless  row["max_value"].nil?
-            when "STRINGCHOICE"
-              # #add string choices one by one.
-              chs = OpenStudio::StringVector.new
-              row["string_choice_array"].each {|choice| chs << choice}
-              arg = OpenStudio::Ruleset::OSArgument::makeChoiceArgument(row["variable_name"], chs,row["required"],row["model_dependant"])
-            when "PATH"
-              arg = OpenStudio::Ruleset::OSArgument::makePathArgument("alternativeModelPath",true,"osm")
-            when "WSCHOICE"
-              arg = OpenStudio::Ruleset::makeChoiceArgumentOfWorkspaceObjects( row["variable_name"], row["os_object_type"].to_IddObjectType , model, row["required"])
-            end
-            # #common argument aspects.
-            unless arg.nil?
-              arg.setDisplayName(row["display_name"])
-              arg.setDefaultValue(row["default_value"]) unless row["default_value"].nil?
-              args << arg
-            end
-          end
-          return args
-        end
-
-
         def set_user_arguments_and_apply(model,argument_values,runner)
           message = "Settting Arguments"
           runner.nil? ? puts(message) : runner.registerInfo(message)
@@ -158,48 +198,44 @@ module BTAP
           generate_ruby_macro(model,runner)
           return result
         end # end method run
-  
-        def argument_setter(args)
+
+        def argument_setter(model,args)
           #***boilerplate code starts. Do not edit...
-          # this converts the 2D array to a array hash for better readability and makes
-          # column data accessible by name.
-          @argument_array_of_hashes = []
-          @argument_array_of_arrays[1..-1].each do |row|   # [1..-1] skips the first row
-            hsh = {}; @argument_array_of_arrays[0].each_with_index{ |header, idx|   hsh[header] = row[idx] }
-            @argument_array_of_hashes << hsh
-          end
+          
 
           #iterate through array of hashes and make arguments based on type and set
           # max and min values where applicable.
-          @argument_array_of_hashes.each do |row|
+          @argument_array.each do |row|
+            #strip out first char that contains the @ symbol
+            row.variable_name[0] = ''
             arg = nil
-            case row["type"]
+            case row.type
             when "BOOL"
-              arg = OpenStudio::Ruleset::OSArgument::makeBoolArgument(row["variable_name"],row["required"],row["model_dependant"])
+              arg = OpenStudio::Ruleset::OSArgument::makeBoolArgument(row.variable_name,row.required,row.model_dependant)
             when "STRING"
-              arg = OpenStudio::Ruleset::OSArgument::makeStringArgument(row["variable_name"],row["required"],row["model_dependant"])
+              arg = OpenStudio::Ruleset::OSArgument::makeStringArgument(row.variable_name,row.required,row.model_dependant)
             when "INTEGER"
-              arg = OpenStudio::Ruleset::OSArgument::makeIntegerArgument(row["variable_name"],row["required"],row["model_dependant"])
-              arg.setMaxValue( row["max_value"].to_i ) unless row["min_value"].nil?
-              arg.setMaxValue( row["max_value"].to_i ) unless  row["max_value"].nil?
+              arg = OpenStudio::Ruleset::OSArgument::makeIntegerArgument(row.variable_name,row.required,row.model_dependant)
+              arg.setMaxValue( row.max_value.to_i ) unless row.min_value.nil?
+              arg.setMaxValue( row.max_value.to_i ) unless  row.max_value.nil?
             when "FLOAT"
-              arg = OpenStudio::Ruleset::OSArgument::makeDoubleArgument(row["variable_name"],row["required"],row["model_dependant"])
-              arg.setMaxValue( row["max_value"].to_f ) unless row["min_value"].nil?
-              arg.setMaxValue( row["max_value"].to_f ) unless  row["max_value"].nil?
+              arg = OpenStudio::Ruleset::OSArgument::makeDoubleArgument(row.variable_name,row.required,row.model_dependant)
+              arg.setMaxValue( row.max_value.to_f ) unless row.min_value.nil?
+              arg.setMaxValue( row.max_value.to_f ) unless  row.max_value.nil?
             when "STRINGCHOICE"
               # #add string choices one by one.
               chs = OpenStudio::StringVector.new
-              row["string_choice_array"].each {|choice| chs << choice}
-              arg = OpenStudio::Ruleset::OSArgument::makeChoiceArgument(row["variable_name"], chs,row["required"],row["model_dependant"])
+              row.string_choice_array.each {|choice| chs << choice}
+              arg = OpenStudio::Ruleset::OSArgument::makeChoiceArgument(row.variable_name, chs,row.required,row.model_dependant)
             when "PATH"
               arg = OpenStudio::Ruleset::OSArgument::makePathArgument("alternativeModelPath",true,"osm")
             when "WSCHOICE"
-              arg = OpenStudio::Ruleset::makeChoiceArgumentOfWorkspaceObjects( row["variable_name"], row["os_object_type"].to_IddObjectType , model, row["required"])
+              arg = OpenStudio::Ruleset::makeChoiceArgumentOfWorkspaceObjects( row.variable_name, row.os_object_type.to_IddObjectType , model, row.required)
             end
             # #common argument aspects.
             unless arg.nil?
-              arg.setDisplayName(row["display_name"])
-              arg.setDefaultValue(row["default_value"]) unless row["default_value"].nil?
+              arg.setDisplayName(row.display_name)
+              arg.setDefaultValue(row.default_value) unless row.default_value.nil?
               args << arg
             end
           end
@@ -208,11 +244,11 @@ module BTAP
 
         def argument_getter(model, runner,user_arguments)
           @arg_table = []
-          unless @argument_array_of_hashes == nil
-            @argument_array_of_hashes.each do |row|
-              name = row["variable_name"]
+          unless @argument_array == nil
+            @argument_array.each do |row|
+              name = row.variable_name
             
-              case row["type"]
+              case row.type
               when "BOOL"
                 value = runner.getBoolArgumentValue(name, user_arguments)
                 instance_variable_set("@#{name}",value)
@@ -225,8 +261,8 @@ module BTAP
                 value = runner.getIntegerArgumentValue(name, user_arguments)
                 instance_variable_set("@#{name}",value)
                 @arg_table << [name,value]
-                if ( not row["min_value"].nil?  and instance_variable_get("@#{name}") < row["min_value"] ) or ( not row["max_value"].nil? and instance_variable_get("@#{name}") > row["max_value"] )
-                  runner.registerError("#{row["display_name"]} must be greater than or equal to #{row["min_value"]} and less than or equal to #{row["max_value"]}.  You entered #{instance_variable_get("@#{name}")}.")
+                if ( not row.min_value.nil?  and instance_variable_get("@#{name}") < row.min_value ) or ( not row.max_value.nil? and instance_variable_get("@#{name}") > row.max_value )
+                  runner.registerError("#{row.display_name} must be greater than or equal to #{row.min_value} and less than or equal to #{row.max_value}.  You entered #{instance_variable_get("@#{name}")}.")
                   return false
                 end
               when "FLOAT"
@@ -234,8 +270,8 @@ module BTAP
                 instance_variable_set("@#{name}",value)
                 @arg_table << [name,value]
                 
-                if ( not row["min_value"].nil?  and instance_variable_get("@#{name}") < row["min_value"] ) or ( not row["max_value"].nil? and instance_variable_get("@#{name}") > row["max_value"] )
-                  runner.registerError("#{row["display_name"]} must be greater than or equal to #{row["min_value"]} and less than or equal to #{row["max_value"]}.  You entered #{instance_variable_get("@#{name}")}.")
+                if ( not row.min_value.nil?  and instance_variable_get("@#{name}") < row.min_value ) or ( not row.max_value.nil? and instance_variable_get("@#{name}") > row.max_value )
+                  runner.registerError("#{row.display_name} must be greater than or equal to #{row.min_value} and less than or equal to #{row.max_value}.  You entered #{instance_variable_get("@#{name}")}.")
                   return false
                 end
               when "STRINGCHOICE"
@@ -254,7 +290,6 @@ module BTAP
           return @arg_table
         end        
         
-        
       end
       #Measure Template simplified. 
       class TemplateModelMeasure < BTAPModelUserScript
@@ -265,17 +300,19 @@ module BTAP
 
         def arguments(model)
 
-          #list of arguments as they will appear in the interface. They are available in the run command as @variable_name.
-          @argument_array_of_arrays = [
-            [    "variable_name",          "type",          "required",  "model_dependant","display_name",                 "default_value",  "min_value",  "max_value",  "string_choice_array",  	"os_object_type"	],
-            [    "boolean_argument_name",  "BOOL",          true,        false,            "boolean interface name",       false,            nil,          nil,          nil,                    	nil					],
-            [    "string_argument_name",   "STRING",        true,        false,            "string interface name",        "default",        nil,          nil,          nil,                    	nil					],
-            [    "integer_argument_name",  "INTEGER",       true,        false,            "integer interface name(units)", 0,               0,           100,         	 nil,                   	nil					],
-            [    "float_argument_name",    "FLOAT",         true,        false,            "float interface name(units)",   0.0,             0.0,         100.0,         nil,                   	nil					],
-            [    "choice_argument_name",   "STRINGCHOICE",  true,        false,            "choice interface name",        "choice1",        nil,          nil,          ["choice1","choice2"],  	nil					],
-            [    "ws_choice_argument_name","WSCHOICE",      true,        true,             "wschoice interface name",      nil,              nil,          nil,          nil,                    	"OS_ThermalZone"	]
-          ]
-          args = super(model,@argument_array_of_arrays)
+          #bool
+          @argument_array << OSMArgument.bool(variable_name,display_name,required,default_value)
+          #string
+          @argument_array << OSMArgument.string(variable_name,display_name,required,default_value)
+          #integer
+          @argument_array << OSMArgument.integer(variable_name,display_name,required,default_value,min_value,max_value)
+          #float
+          @argument_array << OSMArgument.float(variable_name,display_name,required,default_value,min_value,max_value)
+          #Choice
+          @argument_array << OSMArgument.choice(variable_name,display_name,required,default_value,string_choice_array)
+          #Workspace choice (using zones as an example)
+          @argument_array << OSMArgument.wschoice(variable_name,display_name,required,default_value,string_choice_array)
+          args = super(model,@argument_array)
           return args
         end
 
@@ -404,9 +441,7 @@ module BTAP
         end
       end
     end
-    module EPMeasures
-    
-    end
+
     class CSV_Measures
       def initialize(
           csv_file,