urbanopt-cli 0.6.4 → 0.7.0

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/battery.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+class Battery
+  def self.apply(runner, model, battery)
+    obj_name = battery.id
+
+    rated_power_output = battery.rated_power_output # W
+    nominal_voltage = battery.nominal_voltage # V
+    if not battery.nominal_capacity_kwh.nil?
+      nominal_capacity_kwh = battery.nominal_capacity_kwh # kWh
+    else
+      nominal_capacity_kwh = get_kWh_from_Ah(battery.nominal_capacity_ah, nominal_voltage) # kWh
+    end
+
+    return if rated_power_output <= 0 || nominal_capacity_kwh <= 0 || nominal_voltage <= 0
+
+    is_outside = (battery.location == HPXML::LocationOutside)
+    if not is_outside
+      frac_sens = 1.0
+    else # Internal gains outside unit
+      frac_sens = 0.0
+    end
+
+    default_nominal_cell_voltage = 3.342 # V, EnergyPlus default
+    default_cell_capacity = 3.2 # Ah, EnergyPlus default
+
+    number_of_cells_in_series = Integer((nominal_voltage / default_nominal_cell_voltage).round)
+    number_of_strings_in_parallel = Integer(((nominal_capacity_kwh * 1000.0) / ((default_nominal_cell_voltage * number_of_cells_in_series) * default_cell_capacity)).round)
+    battery_mass = (nominal_capacity_kwh / 10.0) * 99.0 # kg
+    battery_surface_area = 0.306 * (nominal_capacity_kwh**(2.0 / 3.0)) # m^2
+
+    minimum_storage_state_of_charge_fraction = 0.15 # from SAM
+    maximum_storage_state_of_charge_fraction = 0.95 # from SAM
+    initial_fractional_state_of_charge = 0.5 # from SAM
+
+    elcs = OpenStudio::Model::ElectricLoadCenterStorageLiIonNMCBattery.new(model, number_of_cells_in_series, number_of_strings_in_parallel, battery_mass, battery_surface_area)
+    elcs.setName("#{obj_name} li ion")
+    unless is_outside
+      space = battery.additional_properties.space
+      thermal_zone = space.thermalZone.get
+      elcs.setThermalZone(thermal_zone)
+    end
+    elcs.setRadiativeFraction(0.9 * frac_sens)
+    elcs.setLifetimeModel(battery.lifetime_model)
+    elcs.setNumberofCellsinSeries(number_of_cells_in_series)
+    elcs.setNumberofStringsinParallel(number_of_strings_in_parallel)
+    elcs.setInitialFractionalStateofCharge(initial_fractional_state_of_charge)
+    elcs.setBatteryMass(battery_mass)
+    elcs.setBatterySurfaceArea(battery_surface_area)
+    elcs.setDefaultNominalCellVoltage(default_nominal_cell_voltage)
+    elcs.setCellVoltageatEndofNominalZone(default_nominal_cell_voltage)
+    elcs.setFullyChargedCellCapacity(default_cell_capacity)
+
+    model.getElectricLoadCenterDistributions.each do |elcd|
+      next unless elcd.inverter.is_initialized
+
+      elcd.setElectricalBussType('DirectCurrentWithInverterDCStorage')
+      elcd.setMinimumStorageStateofChargeFraction(minimum_storage_state_of_charge_fraction)
+      elcd.setMaximumStorageStateofChargeFraction(maximum_storage_state_of_charge_fraction)
+      elcd.setStorageOperationScheme('TrackFacilityElectricDemandStoreExcessOnSite')
+      elcd.setElectricalStorage(elcs)
+      runner.registerWarning("Due to an OpenStudio bug, the battery's rated power output will not be honored; the simulation will proceed without a maximum charge/discharge limit.")
+      elcd.setDesignStorageControlDischargePower(rated_power_output)
+      elcd.setDesignStorageControlChargePower(rated_power_output)
+    end
+  end
+
+  def self.get_battery_default_values()
+    return { location: HPXML::LocationOutside,
+             lifetime_model: HPXML::BatteryLifetimeModelNone,
+             rated_power_output: 5000.0,
+             nominal_capacity_kwh: 10.0,
+             nominal_voltage: 50.0 }
+  end
+
+  def self.get_Ah_from_kWh(nominal_capacity_kwh, nominal_voltage)
+    return nominal_capacity_kwh * 1000.0 / nominal_voltage
+  end
+
+  def self.get_kWh_from_Ah(nominal_capacity_ah, nominal_voltage)
+    return nominal_capacity_ah * nominal_voltage / 1000.0
+  end
+end

data/example_files/resources/hpxml-measures/HPXMLtoOpenStudio/resources/constants.rb

@@ -11,20 +11,42 @@ class Constants
     return 32.174 # gravity (ft/s2)
   end
 
-  def self.MonthNumDays
-    return [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
-  end
-
   def self.small
     return 1e-9
   end
 
+  def self.NumDaysInMonths(year)
+    num_days_in_months = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
+    num_days_in_months[1] += 1 if Date.leap?(year)
+    return num_days_in_months
+  end
+
+  def self.NumDaysInYear(is_leap_year)
+    num_days_in_months = NumDaysInMonths(is_leap_year)
+    num_days_in_year = num_days_in_months.sum
+    return num_days_in_year
+  end
+
+  def self.NumHoursInYear(is_leap_year)
+    num_days_in_year = NumDaysInYear(is_leap_year)
+    num_hours_in_year = num_days_in_year * 24
+    return num_hours_in_year
+  end
+
   # Strings --------------------
 
   def self.AirFilm
     return 'AirFilm'
   end
 
+  def self.Auto
+    return 'auto'
+  end
+
+  def self.AutoMaxLoad
+    return 'auto using max load'
+  end
+
   def self.CalcTypeERIRatedHome
     return 'ERI Rated Home'
   end
@@ -49,6 +71,22 @@ class Constants
     return ['2014', '2014A', '2014AD', '2014ADE', '2014ADEG', '2014ADEGL', '2019', '2019A', '2019AB']
   end
 
+  def self.FacadeFront
+    return 'front'
+  end
+
+  def self.FacadeBack
+    return 'back'
+  end
+
+  def self.FacadeLeft
+    return 'left'
+  end
+
+  def self.FacadeRight
+    return 'right'
+  end
+
   def self.FluidWater
     return 'water'
   end
@@ -109,6 +147,10 @@ class Constants
     return "#{water_heater_name} dhw energy"
   end
 
+  def self.ObjectNameCombiSpaceHeatingEnergy(water_heater_name)
+    return "#{water_heater_name} htg energy"
+  end
+
   def self.ObjectNameComponentLoadsProgram
     return 'component loads program'
   end
@@ -185,6 +227,10 @@ class Constants
     return 'furnace'
   end
 
+  def self.ObjectNamePTACHeating
+    return 'ptac heating'
+  end
+
   def self.ObjectNameFurniture
     return 'furniture'
   end
@@ -210,11 +256,7 @@ class Constants
   end
 
   def self.ObjectNameIdealAirSystem
-    return 'ideal'
-  end
-
-  def self.ObjectNameIdealAirSystemResidual
-    return 'ideal residual'
+    return 'ideal air system'
   end
 
   def self.ObjectNameInfiltration
@@ -233,8 +275,12 @@ class Constants
     return 'mech vent'
   end
 
-  def self.ObjectNameMechanicalVentilationPreconditioning
-    return 'mech vent preconditioning'
+  def self.ObjectNameMechanicalVentilationPrecooling
+    return 'mech vent precooling'
+  end
+
+  def self.ObjectNameMechanicalVentilationPreheating
+    return 'mech vent preheating'
   end
 
   def self.ObjectNameMechanicalVentilationHouseFan
@@ -261,6 +307,14 @@ class Constants
     return 'mini split heat pump'
   end
 
+  def self.ObjectNamePTHP
+    return 'packaged terminal heat pump'
+  end
+
+  def self.ObjectNamePTAC
+    return 'packaged terminal air conditioner'
+  end
+
   def self.ObjectNameMiscGrill
     return 'misc grill'
   end
@@ -404,4 +458,38 @@ class Constants
   def self.ScheduleTypeLimitsTemperature
     return 'Temperature'
   end
+
+  def self.ScheduleColNames
+    # col_name => affected_by_vacancy
+    return {
+      'occupants' => true,
+      'lighting_interior' => true,
+      'lighting_exterior' => true,
+      'lighting_garage' => true,
+      'lighting_exterior_holiday' => true,
+      'cooking_range' => true,
+      'refrigerator' => false,
+      'extra_refrigerator' => false,
+      'freezer' => false,
+      'dishwasher' => true,
+      'clothes_washer' => true,
+      'clothes_dryer' => true,
+      'ceiling_fan' => true,
+      'plug_loads_other' => true,
+      'plug_loads_tv' => true,
+      'plug_loads_vehicle' => true,
+      'plug_loads_well_pump' => true,
+      'fuel_loads_grill' => true,
+      'fuel_loads_lighting' => true,
+      'fuel_loads_fireplace' => true,
+      'pool_pump' => false,
+      'pool_heater' => false,
+      'hot_tub_pump' => false,
+      'hot_tub_heater' => false,
+      'hot_water_dishwasher' => true,
+      'hot_water_clothes_washer' => true,
+      'hot_water_fixtures' => true,
+      'vacancy' => nil,
+    }
+  end
 end