openstudio-standards 0.7.1 → 0.8.0.rc1

data/lib/openstudio-standards/standards/ashrae_90_1_prm/ashrae_90_1_prm.rb

@@ -1,4 +1,5 @@
 require 'csv'
+require 'json-schema'
 
 # This abstract class holds methods that many versions of ASHRAE 90.1 share.
 # If a method in this class is redefined by a subclass,
@@ -112,14 +113,38 @@ class ASHRAE901PRM < Standard
     return json_path
   end
 
+  def load_schemas
+    schemas = {}
+    schema_folder_path = File.expand_path('./userdata_json', __dir__)
+    Dir.glob(File.join(schema_folder_path, '*.json')).each do |file_path|
+      filename = File.basename(file_path)
+      schema = JSON.parse(File.read(file_path))
+      schemas[filename] = schema
+    end
+    schemas
+  end
+
   # Load user data from project folder into standards database data structure
   # Each user data object type is a new item in the @standards_data hash
   # @author Doug Maddox, PNNL
   # @param json_path [String path to folder containing json files
   def load_userdata_to_standards_database(json_path)
     files = Dir.glob("#{json_path}/*.json").select { |e| File.file? e }
+    # load json schema
+    schemas = load_schemas
     files.each do |file|
+      file_name = File.basename(file)
       data = JSON.parse(File.read(file))
+      # schema validation
+      begin
+        schema = schemas[file_name]
+        JSON::Validator.validate!(schema, data)
+      rescue JSON::Schema::ValidationError => e
+        puts "Validation error #{file_name} failed due to: #{e.message}"
+      rescue StandardError => e
+        puts "Error, cannot read the file. #{e.message}"
+      end
+
       data.each_pair do |key, objs|
         # Override the template in inherited files to match the instantiated template
         if @standards_data[key].nil?
@@ -128,12 +153,40 @@ class ASHRAE901PRM < Standard
           OpenStudio.logFree(OpenStudio::Debug, 'openstudio.standards.standard', "Overriding #{key} with #{File.basename(file)}")
         end
         @standards_data[key] = objs
+
+        next if objs.empty?
+      end
+    end
+  end
+
+  # Convert user csv data raw value to appropriate type
+  def convert_value(hash_value)
+    hash_value.transform_values do |value|
+      next nil if value.nil? || value.strip.empty?
+
+      # Trim white space and convert to lower case
+      value = value.strip
+      lower_case_value = value.downcase
+
+      # Convert types
+      case lower_case_value
+      when /^\d+$/
+        lower_case_value.to_i
+      when /^\d+\.\d+$/
+        lower_case_value.to_f
+      when 'true'
+        true
+      when 'false'
+        false
+      else
+        # preserve the case
+        value
       end
     end
   end
 
   # Perform user data preprocessing
-  # @param [CSV::ROW] row 2D array for each row.
+  # @param [CSV::ROW] row 2D array for each row. The row is limited to 2 indexes, representing key and value.
   def user_data_preprocessor(row)
     new_array = []
 
@@ -142,8 +195,8 @@ class ASHRAE901PRM < Standard
       new_array << sub_array.collect { |e| e ? e.strip : e }
     end
     # @todo Future expansion can added to here.
-    # Convert the 2d array to hash
-    return new_array.to_h
+    # Convert the 2d array to hash and return
+    convert_value(new_array.to_h)
   end
 
   # Perform user data validation

data/lib/openstudio-standards/standards/ashrae_90_1_prm/ashrae_90_1_prm_2019/ashrae_90_1_prm_2019.Model.rb

@@ -55,4 +55,84 @@ class ASHRAE901PRM2019 < ASHRAE901PRM
     end
     return wwr_range
   end
+
+  # Modify the existing service water heating loops to match the baseline required heating type.
+  # @param model [OpenStudio::Model::Model] OpenStudio model object
+  # @param building_type [String] the building type (For consistency with the standard class, not used in the method)
+  # @param swh_building_type [String] the swh building are type
+  # @return [Boolean] returns true if successful, false if not
+
+  def model_apply_baseline_swh_loops(model,
+                                     building_type,
+                                     swh_building_type = 'All others')
+
+    building_type_list = []
+    # Get the uniq building area type numbers.
+    model.getWaterUseEquipments.each do |wateruse_equipment|
+      additional_property = get_additional_property_as_string(wateruse_equipment, 'building_type_swh', default = nil)
+      unless additional_property.nil?
+        building_type_list << additional_property
+      end
+    end
+
+    # Apply baseline swh loops
+    # Single building area type
+    if building_type_list.uniq.size <= 1
+      if building_type_list.uniq.size == 1
+        swh_building_type_new = building_type_list.uniq[0]
+      else
+        swh_building_type_new = swh_building_type
+      end
+      model.getPlantLoops.each do |plant_loop|
+        # Skip non service water heating loops
+        next unless plant_loop_swh_loop?(plant_loop)
+
+        # Rename the loop to avoid accidentally hooking up the HVAC systems to this loop later.
+        plant_loop.setName('Service Water Heating Loop')
+
+        htg_fuels, combination_system, storage_capacity, total_heating_capacity = plant_loop_swh_system_type(plant_loop)
+
+        # Per Table G3.1 11.e, if the baseline system was a combination of heating and service water heating,
+        # delete all heating equipment and recreate a WaterHeater:Mixed.
+        if combination_system
+          a = plant_loop.supplyComponents
+          b = plant_loop.demandComponents
+          plantloop_components = a += b
+          plantloop_components.each do |component|
+            # Get the object type
+            obj_type = component.iddObjectType.valueName.to_s
+            next if ['OS_Node', 'OS_Pump_ConstantSpeed', 'OS_Pump_VariableSpeed', 'OS_Connector_Splitter', 'OS_Connector_Mixer', 'OS_Pipe_Adiabatic'].include?(obj_type)
+
+            component.remove
+          end
+
+          water_heater = OpenStudio::Model::WaterHeaterMixed.new(model)
+          water_heater.setName('Baseline Water Heater')
+          water_heater.setHeaterMaximumCapacity(total_heating_capacity)
+          water_heater.setTankVolume(storage_capacity)
+          # Apply prm parameters
+          model_apply_water_heater_prm_parameter(water_heater,
+                                                 swh_building_type_new)
+          plant_loop.addSupplyBranchForComponent(water_heater)
+
+          # If it's not a combination heating and service water heating system
+          # just apply prm parameters for all water heaters on the system
+
+        else
+          # Per Table G3.1 11.i, piping losses was deleted
+          plant_loop_adiabatic_pipes_only(plant_loop)
+          plant_loop.supplyComponents.each do |component|
+            next unless component.to_WaterHeaterMixed.is_initialized
+            water_heater = component.to_WaterHeaterMixed.get
+            model_apply_water_heater_prm_parameter(water_heater,
+                                                   swh_building_type_new)
+          end
+        end
+      end
+      # else
+      # Todo: Multiple building type
+    end
+
+    return true
+  end
 end

data/lib/openstudio-standards/standards/ashrae_90_1_prm/ashrae_90_1_prm_2019/ashrae_90_1_prm_2019.rb

@@ -14,14 +14,4 @@ class ASHRAE901PRM2019 < ASHRAE901PRM
   def load_standards_database(data_directories = [])
     super([__dir__] + data_directories)
   end
-
-  # Determine the base infiltration rate at 75 PA.
-  #
-  # @param space [OpenStudio::Model::Space] space object
-  # @return [Double] the baseline infiltration rate, in cfm/ft^2
-  # defaults to no infiltration.
-  def space_infiltration_rate_75_pa(space = nil)
-    basic_infil_rate_cfm_per_ft2 = 1.0
-    return basic_infil_rate_cfm_per_ft2
-  end
 end

data/lib/openstudio-standards/standards/ashrae_90_1_prm/ashrae_90_1_prm_2019/ashrae_90_1_prm_2019_WaterHeaterMixed.rb

@@ -0,0 +1,35 @@
+class ASHRAE901PRM2019 < ASHRAE901PRM
+
+  # Apply the prm parameter to a water heater based on the
+  # building area type.
+  # @param water_heater_mixed [OpenStudio::Model::WaterHeaterMixed] water heater mixed object
+  # @param building_type_swh [String] the swh building are type
+  # @return [Boolean] returns true if successful, false if not
+  def model_apply_water_heater_prm_parameter(water_heater_mixed, building_type_swh)
+    new_fuel = water_heater_mixed_apply_prm_baseline_fuel_type(building_type_swh)
+    water_heater_mixed_apply_efficiency(water_heater_mixed)
+    # Change the fuel type
+    water_heater_mixed.setHeaterFuelType(new_fuel)
+    OpenStudio.logFree(OpenStudio::Info, 'openstudio.standards.WaterHeaterMixed', "For #{water_heater_mixed.name}, changed baseline water heater fuel to #{new_fuel}.")
+    true
+  end
+  # Apply the prm fuel type to a water heater based on the
+  # building area type.
+  # @param building_type [String] the building type (For consistency with the standard class, not used in the method)
+  # @return [String] returns fuel type
+  def water_heater_mixed_apply_prm_baseline_fuel_type(building_type)
+    # Get the fuel type data
+    heater_prop = model_find_object(standards_data['prm_swh_bldg_type'], {'swh_building_type' => building_type})
+    new_fuel_data = heater_prop['baseline_heating_method']
+    # There are only two water heater fuel type in the prm database:
+    # ("Gas Storage" and "Electric Resistance Storage")
+    # Change the prm fuel type to openstudio fuel type
+    if new_fuel_data == "Gas Storage"
+      new_fuel = 'NaturalGas'
+    else
+      new_fuel = 'Electricity'
+    end
+    return new_fuel
+  end
+end
+