openstudio-standards 0.4.0 → 0.5.0

data/lib/openstudio-standards/standards/necb/NECB2011/data/standards_data.rb

@@ -115,7 +115,7 @@ class StandardsData
   # desired search criteria, as passed via a hash.
   # Returns an Array (empty if nothing found) of matching objects.
   #
-  # @param hash_of_objects [Hash] hash of objects to search through
+  # @param table_name [String] table name
   # @param search_criteria [Hash] hash of search criteria
   # @param capacity [Double] capacity of the object in question.  If capacity is supplied,
   #   the objects will only be returned if the specified capacity is between
@@ -125,7 +125,7 @@ class StandardsData
   #   rules = model_find_objects(self, standards_data['schedules'], {'name'=>schedule_name})
   #   if rules.size == 0
   #     OpenStudio::logFree(OpenStudio::Warn, 'openstudio.standards.Model', "Cannot find data for schedule: #{schedule_name}, will not be created.")
-  #     return false #TODO change to return empty optional schedule:ruleset?
+  #     return false # @todo change to return empty optional schedule:ruleset?
   #   end
   def model_find_objects(table_name: , search_criteria: {}, capacity:nil)
     #    matching_objects = hash_of_objects.clone
@@ -247,7 +247,7 @@ class StandardsData
   # the minimum_capacity and maximum_capacity values.
   #
   #
-  # @param hash_of_objects [Hash] hash of objects to search through
+  # @param table_name [String] table name
   # @param search_criteria [Hash] hash of search criteria
   # @param capacity [Double] capacity of the object in question.  If capacity is supplied,
   #   the objects will only be returned if the specified capacity is between

data/lib/openstudio-standards/standards/necb/NECB2011/hvac_system_1_multi_speed.rb

@@ -94,7 +94,7 @@ class NECB2011
         raise("#{mau_heating_coil_type} is not a valid heating coil type.)")
       end
 
-      # TODO: other fuel-fired heating coil types? (not available in OpenStudio/E+ - may need to play with efficiency to mimic other fuel types)
+      # @todo other fuel-fired heating coil types? (not available in OpenStudio/E+ - may need to play with efficiency to mimic other fuel types)
 
       # This method will seem like an error in number of args..but this is due to swig voodoo.
       air_to_air_heatpump = OpenStudio::Model::AirLoopHVACUnitaryHeatPumpAirToAirMultiSpeed.new(model,

data/lib/openstudio-standards/standards/necb/NECB2011/hvac_systems.rb

@@ -9,7 +9,7 @@ class NECB2011
 
   # NECB does not change damper positions
   #
-  # return [Bool] returns true if successful, false if not
+  # return [Boolean] returns true if successful, false if not
   def air_loop_hvac_apply_multizone_vav_outdoor_air_sizing(air_loop_hvac)
     # Do not change anything.
     return true
@@ -18,7 +18,7 @@ class NECB2011
   # Determine whether or not this system
   # is required to have an economizer.
   #
-  # @return [Bool] returns true if an economizer is required, false if not
+  # @return [Boolean] returns true if an economizer is required, false if not
   def air_loop_hvac_economizer_required?(air_loop_hvac)
     economizer_required = false
 
@@ -86,7 +86,7 @@ class NECB2011
   # @note this method assumes you previously checked that an economizer is required at all
   #   via #economizer_required?
   # @param (see #economizer_required?)
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def air_loop_hvac_apply_economizer_integration(air_loop_hvac, climate_zone)
     # Get the OA system and OA controller
     oa_sys = air_loop_hvac.airLoopHVACOutdoorAirSystem
@@ -105,7 +105,7 @@ class NECB2011
   # Check if ERV is required on this airloop.
   #
   # @param (see #economizer_required?)
-  # @return [Bool] Returns true if required, false if not.
+  # @return [Boolean] Returns true if required, false if not.
   # @todo Add exception logic for systems serving parking garage, warehouse, or multifamily
   def air_loop_hvac_energy_recovery_ventilator_required?(air_loop_hvac, climate_zone)
     # ERV Not Applicable for AHUs that serve
@@ -283,7 +283,7 @@ class NECB2011
   # Will be a rotary-type HX
   #
   # @param (see #economizer_required?)
-  # @return [Bool] Returns true if required, false if not.
+  # @return [Boolean] Returns true if required, false if not.
   # @todo Add exception logic for systems serving parking garage, warehouse, or multifamily
   def air_loop_hvac_apply_energy_recovery_ventilator(air_loop_hvac, climate = nil)
     # Get the oa system
@@ -401,7 +401,7 @@ class NECB2011
   # required for this air loop.
   #
   # @param (see #economizer_required?)
-  # @return [Bool] Returns true if required, false if not.
+  # @return [Boolean] Returns true if required, false if not.
   # @todo Add exception logic for
   #   systems that serve multifamily, parking garage, warehouse
   def air_loop_hvac_demand_control_ventilation_required?(air_loop_hvac, climate_zone)
@@ -413,7 +413,7 @@ class NECB2011
   # Set the VAV damper control to single maximum or
   # dual maximum control depending on the standard.
   #
-  # @return [Bool] Returns true if successful, false if not
+  # @return [Boolean] Returns true if successful, false if not
   # @todo see if this impacts the sizing run.
   def air_loop_hvac_apply_vav_damper_action(air_loop_hvac)
     damper_action = 'Single Maximum'
@@ -462,7 +462,7 @@ class NECB2011
 
   # NECB has no single zone air loop control requirements
   #
-  # @return [Bool] returns true if successful, false if not
+  # @return [Boolean] returns true if successful, false if not
   def air_loop_hvac_apply_single_zone_controls(air_loop_hvac, climate_zone)
     OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.AirLoopHVAC', "For #{air_loop_hvac.name}: No special economizer controls were modeled.")
     return true
@@ -470,7 +470,7 @@ class NECB2011
 
   # NECB doesn't require static pressure reset.
   #
-  # return [Bool] returns true if static pressure reset is required, false if not
+  # return [Boolean] returns true if static pressure reset is required, false if not
   def air_loop_hvac_static_pressure_reset_required?(air_loop_hvac, has_ddc)
     # static pressure reset not required
     sp_reset_required = false
@@ -490,7 +490,7 @@ class NECB2011
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
   # @param boiler_hot_water [OpenStudio::Model::BoilerHotWater] the object to modify
-  # @return [Bool] true if successful, false if not
+  # @return [Boolean] true if successful, false if not
   def boiler_hot_water_apply_efficiency_and_curves(boiler_hot_water)
     successfully_set_all_properties = false
 
@@ -519,7 +519,11 @@ class NECB2011
         boiler_capacity = capacity_w / 2
       elsif (capacity_w / 1000.0) <= 176.0
         if boiler_hot_water.name.to_s.include?('Primary Boiler')
-          boiler_capacity = capacity_w
+          if capacity_w <= 1.0
+            boiler_capacity = 1.0
+          else
+            boiler_capacity = capacity_w
+          end
         elsif boiler_hot_water.name.to_s.include?('Secondary Boiler')
           boiler_capacity = 0.001
         end
@@ -588,10 +592,8 @@ class NECB2011
 
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
-  # @return [Bool] true if successful, false if not
+  # @return [Boolean] true if successful, false if not
   def chiller_electric_eir_apply_efficiency_and_curves(chiller_electric_eir, clg_tower_objs)
-    chillers = standards_data['chillers']
-
     # Define the criteria to find the chiller properties
     # in the hvac standards data set.
     search_criteria = chiller_electric_eir_find_search_criteria(chiller_electric_eir)
@@ -624,7 +626,24 @@ class NECB2011
     # Convert capacity to tons
     capacity_tons = OpenStudio.convert(chiller_capacity, 'W', 'ton').get
 
+    # Get chiller compressor type if needed
+    chiller_types = ['reciprocating','scroll','rotary screw','centrifugal']
+    chiller_name_has_type = chiller_types.any? {|type| chiller_electric_eir.name.to_s.downcase.include? type}
+    unless chiller_name_has_type
+      chlr_type_search_criteria = {}
+      chlr_type_search_criteria['cooling_type'] = cooling_type
+      chlr_types_table = @standards_data['chiller_types']
+      chlr_type_props = model_find_object(chlr_types_table, chlr_type_search_criteria, capacity_tons)
+      unless chlr_type_props
+        OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.ChillerElectricEIR', "For #{chiller_electric_eir.name}, cannot find chiller type information")
+        successfully_set_all_properties = false
+        return successfully_set_all_properties
+      end
+      compressor_type = chlr_type_props['compressor_type']
+      chiller_electric_eir.setName(chiller_electric_eir.name.to_s + ' ' + compressor_type)
+    end
     # Get the chiller properties
+    search_criteria['compressor_type'] = compressor_type
     chlr_table = @standards_data['chillers']
     chlr_props = model_find_object(chlr_table, search_criteria, capacity_tons, Date.today)
     unless chlr_props
@@ -789,7 +808,7 @@ class NECB2011
 
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
-  # @return [Bool] true if successful, false if not
+  # @return [Boolean] true if successful, false if not
   def coil_heating_gas_apply_efficiency_and_curves(coil_heating_gas)
     successfully_set_all_properties = true
 
@@ -830,7 +849,7 @@ class NECB2011
 
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
-  # @return [Bool] true if successful, false if not
+  # @return [Boolean] true if successful, false if not
   def coil_cooling_dx_multi_speed_apply_efficiency_and_curves(coil_cooling_dx_multi_speed, sql_db_vars_map)
     successfully_set_all_properties = true
     model = coil_cooling_dx_multi_speed.model
@@ -1078,7 +1097,7 @@ class NECB2011
 
   # Applies the standard efficiency ratings and typical performance curves to this object.
   #
-  # @return [Bool] true if successful, false if not
+  # @return [Boolean] true if successful, false if not
   def coil_heating_gas_multi_stage_apply_efficiency_and_curves(coil_heating_gas_multi_stage)
     successfully_set_all_properties = true
     model = coil_heating_gas_multi_stage.model
@@ -1264,11 +1283,11 @@ class NECB2011
   # @todo Add fan type to data model and modify this method
   def fan_baseline_impeller_efficiency(fan)
     # Assume that the fan efficiency is 65% for normal fans
-    # TODO add fan type to fan data model
+    # @todo add fan type to fan data model
     # and infer impeller efficiency from that?
     # or do we always assume a certain type of
     # fan impeller for the baseline system?
-    # TODO check COMNET and T24 ACM and PNNL 90.1 doc
+    # @todo check COMNET and T24 ACM and PNNL 90.1 doc
     fan_impeller_eff = 0.65
 
     return fan_impeller_eff
@@ -1448,7 +1467,7 @@ class NECB2011
   # Does not account for System requirements like ERV, economizer, etc.
   # Those are accounted for in the AirLoopHVAC method of the same name.
   #
-  # @return [Bool] Returns true if required, false if not.
+  # @return [Boolean] Returns true if required, false if not.
   # @todo Add exception logic for 90.1-2013
   #   for cells, sickrooms, labs, barbers, salons, and bowling alleys
   def thermal_zone_demand_control_ventilation_required?(thermal_zone, climate_zone)
@@ -1596,13 +1615,13 @@ class NECB2011
     hw_loop.setName('Hot Water Loop')
     sizing_plant = hw_loop.sizingPlant
     sizing_plant.setLoopType('Heating')
-    sizing_plant.setDesignLoopExitTemperature(82.0) # TODO: units
+    sizing_plant.setDesignLoopExitTemperature(82.0) #@todo units
     sizing_plant.setLoopDesignTemperatureDifference(16.0)
 
     # pump (set to variable speed for now till fix to run away plant temperature is found)
     # pump = OpenStudio::Model::PumpConstantSpeed.new(model)
     pump = OpenStudio::Model::PumpVariableSpeed.new(model)
-    # TODO: the keyword "setPumpFlowRateSchedule" does not seem to work. A message
+    # @todo the keyword "setPumpFlowRateSchedule" does not seem to work. A message
     # was sent to NREL to let them know about this. Once there is a fix for this,
     # use the proper pump schedule depending on whether we have two-pipe or four-pipe
     # fan coils.
@@ -1662,9 +1681,9 @@ class NECB2011
     chiller2 = OpenStudio::Model::ChillerElectricEIR.new(model)
     chiller1.setCondenserType('WaterCooled')
     chiller2.setCondenserType('WaterCooled')
-    chiller1_name = "Primary Chiller WaterCooled #{chiller_type}"
+    chiller1_name = "Primary Chiller WaterCooled #{chiller_type}".strip
     chiller1.setName(chiller1_name)
-    chiller2_name = "Secondary Chiller WaterCooled #{chiller_type}"
+    chiller2_name = "Secondary Chiller WaterCooled #{chiller_type}".strip
     chiller2.setName(chiller2_name)
 
     chiller_bypass_pipe = OpenStudio::Model::PipeAdiabatic.new(model)
@@ -1699,7 +1718,10 @@ class NECB2011
     cw_sizing_plant.setDesignLoopExitTemperature(29.0)
     cw_sizing_plant.setLoopDesignTemperatureDifference(6.0)
 
-    cw_pump = OpenStudio::Model::PumpConstantSpeed.new(model)
+    # Note: pump of 'Condenser water loop' has been changed to the variable one as the constant one caused fatal errors for LargeOffice-Montreal-NaturalGas for some ECMs and inputs.
+    # Fatal error was: 'Plant temperatures are getting far too cold, check controls and relative loads and capacities'.
+    # Note that the variable speed pump has been already used for 'Hot Water Loop' and 'Chilled Water Loop'.
+    cw_pump = OpenStudio::Model::PumpVariableSpeed.new(model)
 
     clg_tower = OpenStudio::Model::CoolingTowerSingleSpeed.new(model)
 
@@ -2070,7 +2092,7 @@ class NECB2011
   end
 
   def create_heating_cooling_on_off_availability_schedule(model)
-    # TODO: Create a feature to derive start and end heating and cooling seasons from weather file.
+    # @todo Create a feature to derive start and end heating and cooling seasons from weather file.
     avail_data = [{ start_month: 1, start_day: 1, end_month: 6, end_day: 30, htg_value: 1, clg_value: 0 },
                   { start_month: 7, start_day: 1, end_month: 10, end_day: 31, htg_value: 0, clg_value: 1 },
                   { start_month: 11, start_day: 1, end_month: 12, end_day: 31, htg_value: 1, clg_value: 0 }]
@@ -2361,7 +2383,7 @@ class NECB2011
   # heating type rules need to be flexible to account for 
   # 1.  DX htg/cooling + gas supplement htg
   # 2.  Potential lack of AirLoopHVACUnitaryHeatPumpAirToAir or AirLoopHVACUnitarySystem  
-  # @param necb_ref_hp [Bool] if true, NECB reference model rules for heat pumps will be used.
+  # @param necb_reference_hp [Boolean] if true, NECB reference model rules for heat pumps will be used.
   def coil_dx_heating_type(coil_dx, necb_reference_hp = false)
     supp_htg_type = nil