openstudio-standards 0.2.14 → 0.2.15.pre.rc1

data/lib/openstudio-standards/prototypes/common/objects/Prototype.Model.swh.rb

@@ -1,5 +1,11 @@
 class Standard
-  def model_add_swh(model, building_type, climate_zone, prototype_input, epw_file)
+  # Add service water heating to the model
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param building_type [String] building type
+  # @param prototype_input [Hash] hash of prototype inputs
+  # @return [Bool] returns true if successful, false if not
+  def model_add_swh(model, building_type, prototype_input)
     OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', 'Started Adding Service Water Heating')
 
     # Add the main service water heating loop, if specified
@@ -38,9 +44,9 @@ class Standard
       end
 
       # Attach the end uses if specified in prototype inputs
-      # TODO remove special logic for large office SWH end uses
-      # TODO remove special logic for stripmall SWH end uses and service water loops
-      # TODO remove special logic for large hotel SWH end uses
+      # @todo remove special logic for large office SWH end uses
+      # @todo remove special logic for stripmall SWH end uses and service water loops
+      # @todo remove special logic for large hotel SWH end uses
       if building_type == 'LargeOffice' && template != 'NECB2011'
 
         # Only the core spaces have service water
@@ -164,9 +170,7 @@ class Standard
         end
 
         OpenStudio.logFree(OpenStudio::Info, 'openstudio.model.Model', "Added #{water_fixtures.size} water fixtures to model")
-
       end
-
     end
 
     # Add the booster water heater, if specified
@@ -222,11 +226,12 @@ class Standard
 
   # add typical swh demand and supply to model
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param water_heater_fuel [String] water heater fuel. Valid choices are NaturalGas, Electricity, and HeatPump.
   #   If not supplied, a smart default will be determined based on building type.
   # @param pipe_insul_in [Double] thickness of the pipe insulation, in inches.
   # @param circulating [String] whether the (circulating, noncirculating, nil) nil is smart
-  # @return [Array] hot water loops
+  # @return [Array<OpenStudio::Model::PlantLoop>] hot water loops
   # @todo - add in losses from tank and pipe insulation, etc.
   def model_add_typical_swh(model,
                             water_heater_fuel: nil,
@@ -284,7 +289,8 @@ class Standard
         peak_flow_rate_m3_per_s = OpenStudio.convert(peak_flow_rate_gal_per_hr, 'gal/hr', 'm^3/s').get
         use_name = "#{space_type.name} #{num_units} units"
       else
-        # TODO: - add building type or sice specific logic or just assume Gas? (SmallOffice and Warehouse are only non unit prototypes with Electric heating)
+        # @todo add building type or sice specific logic or just assume Gas?
+        #   (SmallOffice and Warehouse are only non unit prototypes with Electric heating)
         water_heater_fuel = 'NaturalGas' if water_heater_fuel.nil?
         num_units = 1
         peak_flow_rate_gal_per_hr = peak_flow_rate_gal_per_hr_per_ft2 * floor_area_ft2
@@ -417,13 +423,13 @@ class Standard
 
     # add non-dedicated system(s) here. Separate systems for water use equipment from different building types
     water_use_equipment_hash.sort.each do |stds_bldg_type, water_use_equipment_array|
-      # TODO: find the water use equipment with the highest temperature
+      # @todo find the water use equipment with the highest temperature
       water_heater_temp_f = 140.0
       water_heater_temp_c = OpenStudio.convert(water_heater_temp_f, 'F', 'C').get
 
       # find pump values
       # Table A.2 in PrototypeModelEnhancements_2014_0.pdf shows 10ft on everything except SecondarySchool which has 11.4ft
-      # TODO: Remove hard-coded building-type-based lookups for circulating vs. non-circulating SWH systems
+      # @todo Remove hard-coded building-type-based lookups for circulating vs. non-circulating SWH systems
       circulating_bldg_types = [
         # DOE building types
         'Office',
@@ -511,11 +517,12 @@ class Standard
   # Use rules from DOE Prototype Building documentation to determine water heater capacity,
   # volume, pipe dump losses, and pipe thermal losses.
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param water_use_equipment_array [Array] array of water use equipment objects that will be using this water heater
   # @param storage_to_cap_ratio_gal_to_kbtu_per_hr [Double] storage volume gal to kBtu/hr of capacity
   # @param htg_eff [Double] water heater thermal efficiency, fraction
   # @param inlet_temp_f [Double] inlet cold water temperature, degrees Fahrenheit
-  # @param target_temp_f [Double] target supply water temperatre from the tank, degrees Fahrenheit
+  # @param target_temp_f [Double] target supply water temperature from the tank, degrees Fahrenheit
   # @return [Hash] hash with values needed to size water heater made with downstream method
   def model_find_water_heater_capacity_volume_and_parasitic(model,
                                                             water_use_equipment_array,

data/lib/openstudio-standards/prototypes/common/objects/Prototype.Model.transformers.rb

@@ -1,6 +1,13 @@
 class Standard
   # Add transformers for some prototypes
-
+  #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param wired_lighting_frac [Double] the wired lighting fraction, 0-1
+  # @param transformer_size [Double] the transformer size in VA
+  # @param transformer_efficiency [Double] the transformer efficiency, 0-1
+  # @param excluded_interiorequip_key [String] key to exclude
+  # @param excluded_interiorequip_meter [String] meter to exclude
+  # @return [OpenStudio::Model::ElectricLoadCenterTransformer] the transformer object
   def model_add_transformer(model,
                             wired_lighting_frac: nil,
                             transformer_size: nil,
@@ -13,7 +20,7 @@ class Standard
       return false
     end
 
-    # TODO: default values are for testing only.
+    # @todo default values are for testing only
     # ems sensor for interior lighting
     facility_int_ltg = OpenStudio::Model::EnergyManagementSystemSensor.new(model, 'InteriorLights:Electricity')
     facility_int_ltg.setName('Facility_Int_LTG')
@@ -77,5 +84,7 @@ class Standard
     else
       transformer.addMeter('Wired_Int_EQUIP')
     end
+
+    return transformer
   end
 end

data/lib/openstudio-standards/prototypes/common/objects/Prototype.Pump.rb

@@ -1,3 +1,4 @@
+# Prototype pump calculation methods that are the same regardless of pump type.
 module PrototypePump
   # @!group Pump
 end

data/lib/openstudio-standards/prototypes/common/objects/Prototype.PumpVariableSpeed.rb

@@ -53,20 +53,18 @@ class Standard
         area_served_m2 = plant_loop_total_floor_area_served(plant_loop)
         area_served_ft2 = OpenStudio.convert(area_served_m2, 'm^2', 'ft^2').get
 
-        if area_served_ft2 > 120_000
-          return 'VSD No Reset'
-        else
-          return 'Riding Curve'
-        end
+        return 'VSD No Reset' if area_served_ft2 > 120_000
+
+        # else
+        return 'Riding Curve'
       when 'Cooling'
         # Get plant loop capacity capacity
         cooling_capacity_w = plant_loop_total_cooling_capacity(plant_loop)
 
-        if cooling_capacity_w >= 300
-          return 'VSD No Reset'
-        else
-          return 'Riding Curve'
-        end
+        return 'VSD No Reset' if cooling_capacity_w >= 300
+
+        # else
+        return 'Riding Curve'
     end
   end
 end

data/lib/openstudio-standards/prototypes/common/objects/Prototype.ServiceWaterHeating.rb

@@ -3,6 +3,7 @@ class Standard
 
   # Creates a service water heating loop.
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param system_name [String] the name of the system, or nil in which case it will be defaulted
   # @param water_heater_thermal_zone [OpenStudio::Model::ThermalZone]
   #   zones to place water heater in.  If nil, will be assumed in 70F air for heat loss.
@@ -143,6 +144,7 @@ class Standard
 
   # Creates a water heater and attaches it to the supplied service water heating loop.
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param water_heater_capacity [Double] water heater capacity, in W
   # @param water_heater_volume [Double] water heater volume, in m^3
   # @param water_heater_fuel [Double] valid choices are NaturalGas, Electricity
@@ -171,7 +173,7 @@ class Standard
                              water_heater_thermal_zone,
                              number_water_heaters)
     # Water heater
-    # TODO Standards - Change water heater methodology to follow
+    # @todo Standards - Change water heater methodology to follow
     # 'Model Enhancements Appendix A.'
     water_heater_capacity_btu_per_hr = OpenStudio.convert(water_heater_capacity, 'W', 'Btu/hr').get
     water_heater_capacity_kbtu_per_hr = OpenStudio.convert(water_heater_capacity_btu_per_hr, 'Btu/hr', 'kBtu/hr').get
@@ -216,11 +218,11 @@ class Standard
     if water_heater_thermal_zone.nil?
       # Assume the water heater is indoors at 70F or 72F
       case template
-        when '90.1-2004', '90.1-2007', '90.1-2010', '90.1-2013', '90.1-2016', '90.1-2019'
-          indoor_temp = 71.6
-        else
-          indoor_temp = 70.0
-        end
+      when '90.1-2004', '90.1-2007', '90.1-2010', '90.1-2013', '90.1-2016', '90.1-2019'
+        indoor_temp = 71.6
+      else
+        indoor_temp = 70.0
+      end
       default_water_heater_ambient_temp_sch = model_add_constant_schedule_ruleset(model,
                                                                                   OpenStudio.convert(indoor_temp, 'F', 'C').get,
                                                                                   name = 'Water Heater Ambient Temp Schedule - ' + indoor_temp.to_s + 'f')
@@ -263,7 +265,7 @@ class Standard
       # Make a part-load efficiency modifier curve with a value above 1, which
       # is multiplied by the nominal efficiency of 100% to represent
       # the COP of a HPWH.
-      # TODO could make this workaround better by using EMS
+      # @todo could make this workaround better by using EMS
       # to modify this curve output in realtime based on
       # the OA temperature.
       hpwh_cop = 2.8
@@ -304,6 +306,7 @@ class Standard
 
   # Creates a heatpump water heater and attaches it to the supplied service water heating loop.
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param water_heater_capacity [Double] water heater capacity, in W
   # @param water_heater_volume [Double] water heater volume, in m^3
   # @param service_water_temperature [Double] water heater temperature, in C
@@ -449,7 +452,7 @@ class Standard
 
     # set coil properties
     coil.setName("#{hpwh.name} Coil")
-    coil.setRatedHeatingCapacity(water_heater_capacity * cop)
+    coil.setRatedHeatingCapacity(water_heater_capacity)
     coil.setRatedCOP(cop)
     coil.setRatedSensibleHeatRatio(shr)
     coil.setRatedEvaporatorInletAirDryBulbTemperature(OpenStudio.convert(67.5, 'F', 'C').get)
@@ -578,6 +581,7 @@ class Standard
   # Creates a booster water heater and attaches it
   # to the supplied service water heating loop.
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param main_service_water_loop [OpenStudio::Model::PlantLoop]
   # the main service water loop that this booster assists.
   # @param water_heater_capacity [Double] water heater capacity, in W
@@ -642,7 +646,7 @@ class Standard
     swh_pump.addToNode(booster_service_water_loop.supplyInletNode)
 
     # Water heater
-    # TODO Standards - Change water heater methodology to follow
+    # @todo Standards - Change water heater methodology to follow
     # 'Model Enhancements Appendix A.'
     water_heater_capacity_btu_per_hr = OpenStudio.convert(water_heater_capacity, 'W', 'Btu/hr').get
     water_heater_capacity_kbtu_per_hr = OpenStudio.convert(water_heater_capacity_btu_per_hr, 'Btu/hr', 'kBtu/hr').get
@@ -659,11 +663,11 @@ class Standard
     if booster_water_heater_thermal_zone.nil?
       # Assume the water heater is indoors at 70F or 72F
       case template
-        when '90.1-2004', '90.1-2007', '90.1-2010', '90.1-2013', '90.1-2016', '90.1-2019'
-          indoor_temp = 71.6
-        else
-          indoor_temp = 70.0
-        end
+      when '90.1-2004', '90.1-2007', '90.1-2010', '90.1-2013', '90.1-2016', '90.1-2019'
+        indoor_temp = 71.6
+      else
+        indoor_temp = 70.0
+      end
       default_water_heater_ambient_temp_sch = model_add_constant_schedule_ruleset(model,
                                                                                   OpenStudio.convert(indoor_temp, 'F', 'C').get,
                                                                                   name = 'Water Heater Ambient Temp Schedule - ' + indoor_temp.to_s)
@@ -775,6 +779,7 @@ class Standard
   # Creates water fixtures and attaches them
   # to the supplied service water loop.
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param use_name [String] The name that will be assigned
   # to the newly created fixture.
   # @param swh_loop [OpenStudio::Model::PlantLoop]
@@ -860,10 +865,10 @@ class Standard
   # Adds a WaterUseEquipment object representing the SWH loads of the supplied Space.
   # Attaches this WaterUseEquipment to the supplied PlantLoop via a new WaterUseConnections object.
   #
-  # @param model [OpenStudio::Model::Model] the model
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param swh_loop [OpenStudio::Model::PlantLoop] the SWH loop to connect the WaterUseEquipment to
-  # @space [OpenStudio::Model::Space] the Space to add a WaterUseEquipment for
-  # @space_multiplier [Double] the multiplier to use if the supplied Space actually represents
+  # @param space [OpenStudio::Model::Space] the Space to add a WaterUseEquipment for
+  # @param space_multiplier [Double] the multiplier to use if the supplied Space actually represents
   #   more area than is shown in the model.
   # @param is_flow_per_area [Bool] if true, use the value in the 'service_water_heating_peak_flow_per_area'
   #   field of the space_types JSON.  If false, use the value in the 'service_water_heating_peak_flow_rate' field.
@@ -962,24 +967,25 @@ class Standard
   end
 
   # Determine whether or not water fixtures are attached to spaces
+  # @todo For hotels and apartments, add the water fixture at the space level
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @return [Bool] returns true if successful, false if not
   def model_attach_water_fixtures_to_spaces?(model)
-    # TODO: For hotels and apartments, add the water fixture at the space level
     # if building_type!=nil && ((building_type.downcase.include?"hotel") || (building_type.downcase.include?"apartment"))
     #   return true
     # end
     return false
   end
 
-  # Creates water fixtures and attaches them
-  # to the supplied booster water loop.
+  # Creates water fixtures and attaches them to the supplied booster water loop.
   #
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param swh_booster_loop [OpenStudio::Model::PlantLoop]
   # the booster water loop to add water fixtures to.
   # @param peak_flowrate [Double] in m^3/s
   # @param flowrate_schedule [String] name of the flow rate schedule
   # @param water_use_temperature [Double] mixed water use temperature, in C
-  # @return [OpenStudio::Model::WaterUseEquipment]
-  # the resulting water fixture.
+  # @return [OpenStudio::Model::WaterUseEquipment] the resulting water fixture
   def model_add_booster_swh_end_uses(model,
                                      swh_booster_loop,
                                      peak_flowrate,
@@ -1025,13 +1031,14 @@ class Standard
   # are close to the point of use.
   # Assume that piping is located in a zone
   #
-  # @param model [OpenStudio::Model::Model] the model
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
   # @param swh_loop [OpenStudio::Model::PlantLoop] the service water heating loop
   # @param floor_area_served [Double] the area of building served by the service water heating loop, in m^2
   # @param number_of_stories [Integer] the number of stories served by the service water heating loop
   # @param pipe_insulation_thickness [Double] the thickness of the pipe insulation, in m.  Use 0 for no insulation
   # @param circulating [Bool] use true for circulating systems, false for non-circulating systems
   # @param air_temp_surrounding_piping [Double] the temperature of the air surrounding the piping, in C.
+  # @return [Bool] returns true if successful, false if not
   def model_add_piping_losses_to_swh_system(model,
                                             swh_loop,
                                             circulating,
@@ -1089,9 +1096,9 @@ class Standard
     copper_pipe.setThermalConductivity(386.0)
     copper_pipe.setDensity(OpenStudio.convert(556, 'lb/ft^3', 'kg/m^3').get)
     copper_pipe.setSpecificHeat(OpenStudio.convert(0.092, 'Btu/lb*R', 'J/kg*K').get)
-    copper_pipe.setThermalAbsorptance(0.9) # TODO: find reference for property
-    copper_pipe.setSolarAbsorptance(0.7) # TODO: find reference for property
-    copper_pipe.setVisibleAbsorptance(0.7) # TODO: find reference for property
+    copper_pipe.setThermalAbsorptance(0.9) # @todo find reference for property
+    copper_pipe.setSolarAbsorptance(0.7) # @todo find reference for property
+    copper_pipe.setVisibleAbsorptance(0.7) # @todo find reference for property
 
     # Construction for pipe
     pipe_construction = OpenStudio::Model::Construction.new(model)
@@ -1124,9 +1131,11 @@ class Standard
     heat_loss_pipe = OpenStudio::Model::PipeIndoor.new(model)
     heat_loss_pipe.setName("#{swh_loop.name} Pipe #{pipe_length_ft}ft")
     heat_loss_pipe.setEnvironmentType('Schedule')
-    # heat_loss_pipe.setAmbientTemperatureSchedule(swh_piping_air_temp_sch) # TODO: schedule type registry error for this setter
+    # @todoschedule type registry error for this setter
+    # heat_loss_pipe.setAmbientTemperatureSchedule(swh_piping_air_temp_sch)
     heat_loss_pipe.setPointer(7, swh_piping_air_temp_sch.handle)
-    # heat_loss_pipe.setAmbientAirVelocitySchedule(model.alwaysOffDiscreteSchedule) # TODO: schedule type registry error for this setter
+    # @todo schedule type registry error for this setter
+    # heat_loss_pipe.setAmbientAirVelocitySchedule(model.alwaysOffDiscreteSchedule)
     heat_loss_pipe.setPointer(8, swh_piping_air_velocity_sch.handle)
     heat_loss_pipe.setConstruction(pipe_construction)
     heat_loss_pipe.setPipeInsideDiameter(OpenStudio.convert(0.785, 'in', 'm').get)

data/lib/openstudio-standards/prototypes/common/objects/Prototype.SizingSystem.rb

@@ -3,8 +3,9 @@ class Standard
 
   # Prototype SizingSystem object
   #
-  # @param air_loop_hvac [<OpenStudio::Model::AirLoopHVAC>] air loop to set sizing system properties
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
   # @param dsgn_temps [Hash] a hash of design temperature lookups from standard_design_sizing_temperatures
+  # @return [OpenStudio::Model::SizingSystem] sizing system object
   def adjust_sizing_system(air_loop_hvac,
                            dsgn_temps,
                            type_of_load_sizing: 'Sensible',
@@ -38,16 +39,33 @@ class Standard
     return sizing_system
   end
 
+  # adjust the outdoor air sizing to the use the ventilation rate procedure
+  # @todo this needs to be changed in both the sizing system and controller mechanical ventilation objects
+  #
+  # @param air_loop_hvac [OpenStudio::Model::AirLoopHVAC] air loop
+  # @return [Bool] returns true if successful, false if not
   def model_system_outdoor_air_sizing_vrp_method(air_loop_hvac)
+    # Do not apply the adjustment to some of the system in
+    # the hospital and outpatient which have their minimum
+    # damper position determined based on AIA 2001 ventilation
+    # requirements
+    if (@instvarbuilding_type == 'Hospital' && (air_loop_hvac.name.to_s.include?('VAV_ER') || air_loop_hvac.name.to_s.include?('VAV_ICU') ||
+       air_loop_hvac.name.to_s.include?('VAV_OR') || air_loop_hvac.name.to_s.include?('VAV_LABS') ||
+       air_loop_hvac.name.to_s.include?('VAV_PATRMS'))) ||
+       (@instvarbuilding_type == 'Outpatient' && air_loop_hvac.name.to_s.include?('Outpatient F1'))
+      return true
+    end
+
     sizing_system = air_loop_hvac.sizingSystem
-    # sizing_system.setSystemOutdoorAirMethod("VentilationRateProcedure")
+    sizing_system.setSystemOutdoorAirMethod('VentilationRateProcedure')
     # Set the minimum zone ventilation efficiency to be 0.6
     air_loop_hvac.thermalZones.sort.each do |zone|
       sizing_zone = zone.sizingZone
-      # It is not yet possible to adjust the minimum zone ventilation efficiency
-      # @todo, update this section when OS allows to adjust minimum zone ventilation efficiency
-      # In EnergyPlus this is done through the DesignSpecification:ZoneAirDistribution object
-      # which is then assigned to a Sizing:Zone object
+      if air_loop_hvac.model.version < OpenStudio::VersionString.new('3.0.0')
+        OpenStudio.logFree(OpenStudio::Warn, 'openstudio.prototype.SizingSystem', "The design minimum zone ventilation efficiency cannot be set for #{sizing_system.name.to_s}. It can only be set OpenStudio 3.0.0 and later.")
+      else
+        sizing_zone.setDesignMinimumZoneVentilationEfficiency(0.6)
+      end
     end
 
     return true