diff --git a/.github/workflows/config.yml b/.github/workflows/config.yml
index 1492416c01..c2203262a1 100644
--- a/.github/workflows/config.yml
+++ b/.github/workflows/config.yml
@@ -33,14 +33,19 @@ jobs:
git config --global --add safe.directory $(realpath .)
git diff --exit-code --ignore-cr-at-eol *.rb
- - name: Check HPXMLs
+ - name: Check HPXMLs/Schedules
shell: bash
run: |
echo "Regenerating HPXML files..."
openstudio tasks.rb update_hpxmls
- echo "Checking for HPXML differences..."
git config --global --add safe.directory $(realpath .)
+ echo "Checking for HPXML differences..."
+ echo "If differences are found below, then HPXMLs need to be regenerated using: openstudio tasks.rb update_hpxmls"
git diff --exit-code --ignore-cr-at-eol workflow/*.xml
+ echo "Checking for schedule CSV differences..."
+ echo "If differences are found below, then schedule CSVs need to be regenerated using: openstudio tasks.rb update_hpxmls"
+ git diff --stat --ignore-cr-at-eol HPXMLtoOpenStudio/resources/schedule_files/*.csv
+ git diff --quiet --ignore-cr-at-eol HPXMLtoOpenStudio/resources/schedule_files/*.csv
- name: Run measure unit tests
run: |
diff --git a/BuildResidentialHPXML/README.md b/BuildResidentialHPXML/README.md
index 0c76275dc2..0c470bdac2 100644
--- a/BuildResidentialHPXML/README.md
+++ b/BuildResidentialHPXML/README.md
@@ -174,7 +174,7 @@ Enter a date range like 'Mar 15 - Dec 15'. If not provided, the OS-HPXML default
Affects the transient calculation of indoor air temperatures. If not provided, the OS-HPXML default (see HPXML Simulation Control) is used.
- **Name:** ``simulation_control_temperature_capacitance_multiplier``
-- **Type:** ``String``
+- **Type:** ``Double``
- **Required:** ``false``
@@ -4510,6 +4510,154 @@ Number of bedrooms served by the lithium ion battery. Only needed if single-fami
+**Vehicle: Type**
+
+The type of vehicle present at the home.
+
+- **Name:** ``vehicle_type``
+- **Type:** ``String``
+
+- **Required:** ``false``
+
+
+
+**Vehicle: EV Battery Nominal Battery Capacity**
+
+The nominal capacity of the vehicle battery, only applies to electric vehicles. If not provided, the OS-HPXML default (see HPXML Vehicles) is used.
+
+- **Name:** ``vehicle_battery_capacity``
+- **Type:** ``Double``
+
+- **Units:** ``kWh``
+
+- **Required:** ``false``
+
+
+
+**Vehicle: EV Battery Usable Capacity**
+
+The usable capacity of the vehicle battery, only applies to electric vehicles. If not provided, the OS-HPXML default (see HPXML Vehicles) is used.
+
+- **Name:** ``vehicle_battery_usable_capacity``
+- **Type:** ``Double``
+
+- **Units:** ``kWh``
+
+- **Required:** ``false``
+
+
+
+**Vehicle: Combined Fuel Economy Units**
+
+The combined fuel economy units of the vehicle. Only 'kWh/mile', 'mile/kWh', or 'mpge' are allow for electric vehicles. If not provided, the OS-HPXML default (see HPXML Vehicles) is used.
+
+- **Name:** ``vehicle_fuel_economy_units``
+- **Type:** ``Choice``
+
+- **Required:** ``false``
+
+- **Choices:** `kWh/mile`, `mile/kWh`, `mpge`, `mpg`
+
+
+
+**Vehicle: Combined Fuel Economy**
+
+The combined fuel economy of the vehicle. If not provided, the OS-HPXML default (see HPXML Vehicles) is used.
+
+- **Name:** ``vehicle_fuel_economy_combined``
+- **Type:** ``Double``
+
+- **Required:** ``false``
+
+
+
+**Vehicle: Miles Driven Per Year**
+
+The annual miles the vehicle is driven. If not provided, the OS-HPXML default (see HPXML Vehicles) is used.
+
+- **Name:** ``vehicle_miles_driven_per_year``
+- **Type:** ``Double``
+
+- **Units:** ``miles``
+
+- **Required:** ``false``
+
+
+
+**Vehicle: Hours Driven Per Week**
+
+The weekly hours the vehicle is driven. If not provided, the OS-HPXML default (see HPXML Vehicles) is used.
+
+- **Name:** ``vehicle_hours_driven_per_week``
+- **Type:** ``Double``
+
+- **Units:** ``hours``
+
+- **Required:** ``false``
+
+
+
+**Vehicle: Fraction Charged at Home**
+
+The fraction of charging energy provided by the at-home charger to the vehicle, only applies to electric vehicles. If not provided, the OS-HPXML default (see HPXML Vehicles) is used.
+
+- **Name:** ``vehicle_fraction_charged_home``
+- **Type:** ``Double``
+
+- **Required:** ``false``
+
+
+
+**Electric Vehicle Charger: Present**
+
+Whether there is an electric vehicle charger present.
+
+- **Name:** ``ev_charger_present``
+- **Type:** ``Boolean``
+
+- **Required:** ``false``
+
+
+
+**Electric Vehicle Charger: Charging Level**
+
+The charging level of the EV charger. If not provided, the OS-HPXML default (see HPXML Electric Vehicle Chargers) is used.
+
+- **Name:** ``ev_charger_level``
+- **Type:** ``Choice``
+
+- **Required:** ``false``
+
+- **Choices:** `1`, `2`, `3`
+
+
+
+**Electric Vehicle Charger: Rated Charging Power**
+
+The rated power output of the EV charger. If not provided, the OS-HPXML default (see HPXML Electric Vehicle Chargers) is used.
+
+- **Name:** ``ev_charger_power``
+- **Type:** ``Double``
+
+- **Units:** ``W``
+
+- **Required:** ``false``
+
+
+
+**Electric Vehicle Charger: Location**
+
+The space type for the EV charger. If not provided, the OS-HPXML default (see HPXML Electric Vehicle Chargers) is used.
+
+- **Name:** ``ev_charger_location``
+- **Type:** ``Choice``
+
+- **Required:** ``false``
+
+- **Choices:** `garage`, `outside`
+
+
+
**Lighting: Present**
Whether there is lighting energy use.
diff --git a/BuildResidentialHPXML/measure.rb b/BuildResidentialHPXML/measure.rb
index b6b656a688..03c51f394a 100644
--- a/BuildResidentialHPXML/measure.rb
+++ b/BuildResidentialHPXML/measure.rb
@@ -114,7 +114,7 @@ def arguments(model) # rubocop:disable Lint/UnusedMethodArgument
arg.setDescription("Enter a date range like 'Mar 15 - Dec 15'. If not provided, the OS-HPXML default (see HPXML Building Site) is used.")
args << arg
- arg = OpenStudio::Measure::OSArgument::makeStringArgument('simulation_control_temperature_capacitance_multiplier', false)
+ arg = OpenStudio::Measure::OSArgument::makeDoubleArgument('simulation_control_temperature_capacitance_multiplier', false)
arg.setDisplayName('Simulation Control: Temperature Capacitance Multiplier')
arg.setDescription("Affects the transient calculation of indoor air temperatures. If not provided, the OS-HPXML default (see HPXML Simulation Control) is used.")
args << arg
@@ -2682,6 +2682,88 @@ def arguments(model) # rubocop:disable Lint/UnusedMethodArgument
arg.setUnits('#')
args << arg
+ arg = OpenStudio::Measure::OSArgument::makeStringArgument('vehicle_type', false)
+ arg.setDisplayName('Vehicle: Type')
+ arg.setDescription('The type of vehicle present at the home.')
+ arg.setDefaultValue(Constants::None)
+ args << arg
+
+ arg = OpenStudio::Measure::OSArgument::makeDoubleArgument('vehicle_battery_capacity', false)
+ arg.setDisplayName('Vehicle: EV Battery Nominal Battery Capacity')
+ arg.setDescription("The nominal capacity of the vehicle battery, only applies to electric vehicles. If not provided, the OS-HPXML default (see HPXML Vehicles) is used.")
+ arg.setUnits('kWh')
+ args << arg
+
+ arg = OpenStudio::Measure::OSArgument::makeDoubleArgument('vehicle_battery_usable_capacity', false)
+ arg.setDisplayName('Vehicle: EV Battery Usable Capacity')
+ arg.setDescription("The usable capacity of the vehicle battery, only applies to electric vehicles. If not provided, the OS-HPXML default (see HPXML Vehicles) is used.")
+ arg.setUnits('kWh')
+ args << arg
+
+ fuel_economy_units_choices = OpenStudio::StringVector.new
+ fuel_economy_units_choices << HPXML::UnitsKwhPerMile
+ fuel_economy_units_choices << HPXML::UnitsMilePerKwh
+ fuel_economy_units_choices << HPXML::UnitsMPGe
+ fuel_economy_units_choices << HPXML::UnitsMPG
+
+ arg = OpenStudio::Measure::OSArgument::makeChoiceArgument('vehicle_fuel_economy_units', fuel_economy_units_choices, false)
+ arg.setDisplayName('Vehicle: Combined Fuel Economy Units')
+ arg.setDescription("The combined fuel economy units of the vehicle. Only '#{HPXML::UnitsKwhPerMile}', '#{HPXML::UnitsMilePerKwh}', or '#{HPXML::UnitsMPGe}' are allow for electric vehicles. If not provided, the OS-HPXML default (see HPXML Vehicles) is used.")
+ args << arg
+
+ arg = OpenStudio::Measure::OSArgument::makeDoubleArgument('vehicle_fuel_economy_combined', false)
+ arg.setDisplayName('Vehicle: Combined Fuel Economy')
+ arg.setDescription("The combined fuel economy of the vehicle. If not provided, the OS-HPXML default (see HPXML Vehicles) is used.")
+ args << arg
+
+ arg = OpenStudio::Measure::OSArgument::makeDoubleArgument('vehicle_miles_driven_per_year', false)
+ arg.setDisplayName('Vehicle: Miles Driven Per Year')
+ arg.setDescription("The annual miles the vehicle is driven. If not provided, the OS-HPXML default (see HPXML Vehicles) is used.")
+ arg.setUnits('miles')
+ args << arg
+
+ arg = OpenStudio::Measure::OSArgument::makeDoubleArgument('vehicle_hours_driven_per_week', false)
+ arg.setDisplayName('Vehicle: Hours Driven Per Week')
+ arg.setDescription("The weekly hours the vehicle is driven. If not provided, the OS-HPXML default (see HPXML Vehicles) is used.")
+ arg.setUnits('hours')
+ args << arg
+
+ arg = OpenStudio::Measure::OSArgument::makeDoubleArgument('vehicle_fraction_charged_home', false)
+ arg.setDisplayName('Vehicle: Fraction Charged at Home')
+ arg.setDescription("The fraction of charging energy provided by the at-home charger to the vehicle, only applies to electric vehicles. If not provided, the OS-HPXML default (see HPXML Vehicles) is used.")
+ args << arg
+
+ arg = OpenStudio::Measure::OSArgument::makeBoolArgument('ev_charger_present', false)
+ arg.setDisplayName('Electric Vehicle Charger: Present')
+ arg.setDescription('Whether there is an electric vehicle charger present.')
+ arg.setDefaultValue(false)
+ args << arg
+
+ ev_charging_level_choices = OpenStudio::StringVector.new
+ ev_charging_level_choices << '1'
+ ev_charging_level_choices << '2'
+ ev_charging_level_choices << '3'
+
+ arg = OpenStudio::Measure::OSArgument::makeChoiceArgument('ev_charger_level', ev_charging_level_choices, false)
+ arg.setDisplayName('Electric Vehicle Charger: Charging Level')
+ arg.setDescription("The charging level of the EV charger. If not provided, the OS-HPXML default (see HPXML Electric Vehicle Chargers) is used.")
+ args << arg
+
+ arg = OpenStudio::Measure::OSArgument::makeDoubleArgument('ev_charger_power', false)
+ arg.setDisplayName('Electric Vehicle Charger: Rated Charging Power')
+ arg.setDescription("The rated power output of the EV charger. If not provided, the OS-HPXML default (see HPXML Electric Vehicle Chargers) is used.")
+ arg.setUnits('W')
+ args << arg
+
+ ev_charger_location_choices = OpenStudio::StringVector.new
+ ev_charger_location_choices << HPXML::LocationGarage
+ ev_charger_location_choices << HPXML::LocationOutside
+
+ arg = OpenStudio::Measure::OSArgument::makeChoiceArgument('ev_charger_location', ev_charger_location_choices, false)
+ arg.setDisplayName('Electric Vehicle Charger: Location')
+ arg.setDescription("The space type for the EV charger. If not provided, the OS-HPXML default (see HPXML Electric Vehicle Chargers) is used.")
+ args << arg
+
arg = OpenStudio::Measure::OSArgument::makeBoolArgument('lighting_present', true)
arg.setDisplayName('Lighting: Present')
arg.setDescription('Whether there is lighting energy use.')
@@ -3732,7 +3814,7 @@ def argument_errors(args)
args[:schedules_unavailable_period_dates].count(',')]
if !args[:schedules_unavailable_period_window_natvent_availabilities].nil?
- schedules_unavailable_period_lengths += [args[:schedules_unavailable_period_window_natvent_availabilities].count(',')]
+ schedules_unavailable_period_lengths.concat([args[:schedules_unavailable_period_window_natvent_availabilities].count(',')])
end
error = (schedules_unavailable_period_lengths.uniq.size != 1)
@@ -3809,13 +3891,13 @@ def argument_errors(args)
args[:emissions_electricity_units].count(','),
args[:emissions_electricity_values_or_filepaths].count(',')]
- emissions_scenario_lengths += [args[:emissions_electricity_number_of_header_rows].count(',')] unless args[:emissions_electricity_number_of_header_rows].nil?
- emissions_scenario_lengths += [args[:emissions_electricity_column_numbers].count(',')] unless args[:emissions_electricity_column_numbers].nil?
+ emissions_scenario_lengths.concat([args[:emissions_electricity_number_of_header_rows].count(',')]) unless args[:emissions_electricity_number_of_header_rows].nil?
+ emissions_scenario_lengths.concat([args[:emissions_electricity_column_numbers].count(',')]) unless args[:emissions_electricity_column_numbers].nil?
HPXML::fossil_fuels.each do |fossil_fuel|
underscore_case = OpenStudio::toUnderscoreCase(fossil_fuel)
- emissions_scenario_lengths += [args["emissions_#{underscore_case}_values".to_sym].count(',')] unless args["emissions_#{underscore_case}_values".to_sym].nil?
+ emissions_scenario_lengths.concat([args["emissions_#{underscore_case}_values".to_sym].count(',')]) unless args["emissions_#{underscore_case}_values".to_sym].nil?
end
error = (emissions_scenario_lengths.uniq.size != 1)
@@ -3828,8 +3910,8 @@ def argument_errors(args)
HPXML::all_fuels.each do |fuel|
underscore_case = OpenStudio::toUnderscoreCase(fuel)
- bills_scenario_lengths += [args["utility_bill_#{underscore_case}_fixed_charges".to_sym].count(',')] unless args["utility_bill_#{underscore_case}_fixed_charges".to_sym].nil?
- bills_scenario_lengths += [args["utility_bill_#{underscore_case}_marginal_rates".to_sym].count(',')] unless args["utility_bill_#{underscore_case}_marginal_rates".to_sym].nil?
+ bills_scenario_lengths.concat([args["utility_bill_#{underscore_case}_fixed_charges".to_sym].count(',')]) unless args["utility_bill_#{underscore_case}_fixed_charges".to_sym].nil?
+ bills_scenario_lengths.concat([args["utility_bill_#{underscore_case}_marginal_rates".to_sym].count(',')]) unless args["utility_bill_#{underscore_case}_marginal_rates".to_sym].nil?
end
error = (bills_scenario_lengths.uniq.size != 1)
@@ -3941,6 +4023,7 @@ def self.create(runner, model, args, epw_path, hpxml_path, existing_hpxml_path)
set_solar_thermal(hpxml_bldg, args, weather)
set_pv_systems(hpxml_bldg, args, weather)
set_battery(hpxml_bldg, args)
+ set_vehicle(hpxml_bldg, args)
set_lighting(hpxml_bldg, args)
set_dehumidifier(hpxml_bldg, args)
set_clothes_washer(hpxml_bldg, args)
@@ -6877,6 +6960,46 @@ def self.set_battery(hpxml_bldg, args)
number_of_bedrooms_served: number_of_bedrooms_served)
end
+ # Set the vehicle and electric vehicle charger properties, including:
+ # - vehicle battery nominal and usable capacity
+ # - fuel economy
+ # - fuel economy units
+ # - miles driven per year
+ # - hours driven per week
+ # - fraction charged at home
+ # - EV charger reference
+ # - EV charger location
+ # - EV charger charging power
+ #
+ # @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
+ # @param args [Hash] Map of :argument_name => value
+ # @return [nil]
+ def self.set_vehicle(hpxml_bldg, args)
+ return unless args[:vehicle_type] || args[:ev_charger_present]
+
+ charger_id = nil
+ if args[:ev_charger_present]
+ charger_id = "EVCharger#{hpxml_bldg.ev_chargers.size + 1}"
+ hpxml_bldg.ev_chargers.add(id: charger_id,
+ location: args[:ev_charger_location],
+ charging_level: args[:ev_charger_level],
+ charging_power: args[:ev_charger_power])
+ end
+
+ if args[:vehicle_type] != Constants::None
+ hpxml_bldg.vehicles.add(id: "Vehicle#{hpxml_bldg.vehicles.size + 1}",
+ vehicle_type: args[:vehicle_type],
+ nominal_capacity_kwh: args[:vehicle_battery_capacity],
+ usable_capacity_kwh: args[:vehicle_battery_usable_capacity],
+ fuel_economy_combined: args[:vehicle_fuel_economy_combined],
+ fuel_economy_units: args[:vehicle_fuel_economy_units],
+ miles_per_year: args[:vehicle_miles_driven_per_year],
+ hours_per_week: args[:vehicle_hours_driven_per_week],
+ fraction_charged_home: args[:vehicle_fraction_charged_home],
+ ev_charger_idref: charger_id)
+ end
+ end
+
# Set the lighting properties, including:
# - interior/exterior/garage fraction of lamps that are LFL/CFL/LED
# - interior/exterior/garage usage multipliers
diff --git a/BuildResidentialHPXML/measure.xml b/BuildResidentialHPXML/measure.xml
index 134e00563b..5c51a299dc 100644
--- a/BuildResidentialHPXML/measure.xml
+++ b/BuildResidentialHPXML/measure.xml
@@ -3,8 +3,8 @@
3.1
build_residential_hpxml
a13a8983-2b01-4930-8af2-42030b6e4233
- 54f3be39-bbda-4b53-8238-20c4166edca5
- 2025-01-16T23:01:22Z
+ 6b3a2a36-11b7-4a15-b2db-34b47b10d771
+ 2025-02-27T17:59:16Z
2C38F48B
BuildResidentialHPXML
HPXML Builder
@@ -149,7 +149,7 @@
simulation_control_temperature_capacitance_multiplier
Simulation Control: Temperature Capacitance Multiplier
Affects the transient calculation of indoor air temperatures. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.10.0/workflow_inputs.html#hpxml-simulation-control'>HPXML Simulation Control</a>) is used.
- String
+ Double
false
false
@@ -5519,6 +5519,161 @@
false
false
+
+ vehicle_type
+ Vehicle: Type
+ The type of vehicle present at the home.
+ String
+ false
+ false
+ none
+
+
+ vehicle_battery_capacity
+ Vehicle: EV Battery Nominal Battery Capacity
+ The nominal capacity of the vehicle battery, only applies to electric vehicles. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.10.0/workflow_inputs.html#hpxml-vehicles'>HPXML Vehicles</a>) is used.
+ Double
+ kWh
+ false
+ false
+
+
+ vehicle_battery_usable_capacity
+ Vehicle: EV Battery Usable Capacity
+ The usable capacity of the vehicle battery, only applies to electric vehicles. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.10.0/workflow_inputs.html#hpxml-vehicles'>HPXML Vehicles</a>) is used.
+ Double
+ kWh
+ false
+ false
+
+
+ vehicle_fuel_economy_units
+ Vehicle: Combined Fuel Economy Units
+ The combined fuel economy units of the vehicle. Only 'kWh/mile', 'mile/kWh', or 'mpge' are allow for electric vehicles. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.10.0/workflow_inputs.html#hpxml-vehicles'>HPXML Vehicles</a>) is used.
+ Choice
+ false
+ false
+
+
+ kWh/mile
+ kWh/mile
+
+
+ mile/kWh
+ mile/kWh
+
+
+ mpge
+ mpge
+
+
+ mpg
+ mpg
+
+
+
+
+ vehicle_fuel_economy_combined
+ Vehicle: Combined Fuel Economy
+ The combined fuel economy of the vehicle. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.10.0/workflow_inputs.html#hpxml-vehicles'>HPXML Vehicles</a>) is used.
+ Double
+ false
+ false
+
+
+ vehicle_miles_driven_per_year
+ Vehicle: Miles Driven Per Year
+ The annual miles the vehicle is driven. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.10.0/workflow_inputs.html#hpxml-vehicles'>HPXML Vehicles</a>) is used.
+ Double
+ miles
+ false
+ false
+
+
+ vehicle_hours_driven_per_week
+ Vehicle: Hours Driven Per Week
+ The weekly hours the vehicle is driven. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.10.0/workflow_inputs.html#hpxml-vehicles'>HPXML Vehicles</a>) is used.
+ Double
+ hours
+ false
+ false
+
+
+ vehicle_fraction_charged_home
+ Vehicle: Fraction Charged at Home
+ The fraction of charging energy provided by the at-home charger to the vehicle, only applies to electric vehicles. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.10.0/workflow_inputs.html#hpxml-vehicles'>HPXML Vehicles</a>) is used.
+ Double
+ false
+ false
+
+
+ ev_charger_present
+ Electric Vehicle Charger: Present
+ Whether there is an electric vehicle charger present.
+ Boolean
+ false
+ false
+ false
+
+
+ true
+ true
+
+
+ false
+ false
+
+
+
+
+ ev_charger_level
+ Electric Vehicle Charger: Charging Level
+ The charging level of the EV charger. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.10.0/workflow_inputs.html#hpxml-electric-vehicle-chargers'>HPXML Electric Vehicle Chargers</a>) is used.
+ Choice
+ false
+ false
+
+
+ 1
+ 1
+
+
+ 2
+ 2
+
+
+ 3
+ 3
+
+
+
+
+ ev_charger_power
+ Electric Vehicle Charger: Rated Charging Power
+ The rated power output of the EV charger. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.10.0/workflow_inputs.html#hpxml-electric-vehicle-chargers'>HPXML Electric Vehicle Chargers</a>) is used.
+ Double
+ W
+ false
+ false
+
+
+ ev_charger_location
+ Electric Vehicle Charger: Location
+ The space type for the EV charger. If not provided, the OS-HPXML default (see <a href='https://openstudio-hpxml.readthedocs.io/en/v1.10.0/workflow_inputs.html#hpxml-electric-vehicle-chargers'>HPXML Electric Vehicle Chargers</a>) is used.
+ Choice
+ false
+ false
+
+
+ garage
+ garage
+
+
+ outside
+ outside
+
+
+
lighting_present
Lighting: Present
@@ -7527,7 +7682,7 @@
README.md
md
readme
- ECAEDA1E
+ 4D1FBA76
README.md.erb
@@ -7544,7 +7699,7 @@
measure.rb
rb
script
- 89B21962
+ 341F5C60
constants.rb
@@ -7556,7 +7711,7 @@
geometry.rb
rb
resource
- 170EAEAB
+ C905753A
version.txt
@@ -7568,7 +7723,7 @@
test_build_residential_hpxml.rb
rb
test
- 71348C9A
+ BAC58C3D
diff --git a/BuildResidentialHPXML/resources/geometry.rb b/BuildResidentialHPXML/resources/geometry.rb
index 3530800384..1c7124c5ab 100644
--- a/BuildResidentialHPXML/resources/geometry.rb
+++ b/BuildResidentialHPXML/resources/geometry.rb
@@ -1061,10 +1061,10 @@ def self.create_apartment(model,
# Adiabatic floor/ceiling
adb_levels = []
if attic_type == HPXML::LocationOtherHousingUnit
- adb_levels += [EPlus::SurfaceTypeRoofCeiling]
+ adb_levels.concat([EPlus::SurfaceTypeRoofCeiling])
end
if foundation_type == HPXML::LocationOtherHousingUnit
- adb_levels += [EPlus::SurfaceTypeFloor]
+ adb_levels.concat([EPlus::SurfaceTypeFloor])
end
# Make conditioned space surfaces adiabatic
diff --git a/BuildResidentialHPXML/tests/test_build_residential_hpxml.rb b/BuildResidentialHPXML/tests/test_build_residential_hpxml.rb
index 1e4e7b282b..866602fc4e 100644
--- a/BuildResidentialHPXML/tests/test_build_residential_hpxml.rb
+++ b/BuildResidentialHPXML/tests/test_build_residential_hpxml.rb
@@ -68,6 +68,8 @@ def test_workflows
'extra-water-heater-attic.xml' => 'base-sfd.xml',
'extra-battery-crawlspace.xml' => 'base-sfd.xml',
'extra-battery-attic.xml' => 'base-sfd.xml',
+ 'extra-vehicle-ev.xml' => 'extra-enclosure-garage-partially-protruded.xml',
+ 'extra-two-batteries.xml' => 'base-sfd.xml',
'extra-detailed-performance-autosize.xml' => 'base-sfd.xml',
'extra-power-outage-periods.xml' => 'base-sfd.xml',
@@ -939,6 +941,14 @@ def _set_measure_argument_values(hpxml_file, args)
when 'extra-battery-attic.xml'
args['battery_present'] = true
args['battery_location'] = HPXML::LocationAttic
+ when 'extra-vehicle-ev.xml'
+ args['vehicle_type'] = HPXML::VehicleTypeBEV
+ args['ev_charger_present'] = true
+ args['ev_charger_location'] = HPXML::LocationGarage
+ when 'extra-two-batteries.xml'
+ args['vehicle_type'] = HPXML::VehicleTypeBEV
+ args['battery_present'] = true
+ args['battery_location'] = HPXML::LocationAttic
when 'extra-detailed-performance-autosize.xml'
args['heating_system_type'] = Constants::None
args['cooling_system_type'] = Constants::None
diff --git a/BuildResidentialScheduleFile/measure.rb b/BuildResidentialScheduleFile/measure.rb
index 55a29b78bd..7c481ea7b5 100644
--- a/BuildResidentialScheduleFile/measure.rb
+++ b/BuildResidentialScheduleFile/measure.rb
@@ -144,7 +144,6 @@ def run(model, runner, user_arguments)
epw_path = Location.get_epw_path(hpxml_bldg, hpxml_path)
weather = WeatherFile.new(epw_path: epw_path, runner: runner, hpxml: hpxml)
end
-
# deterministically vary schedules across building units
args[:random_seed] *= (i + 1)
@@ -201,11 +200,13 @@ def write_modified_hpxml(runner, doc, hpxml_path, hpxml_output_path, schedules_f
def create_schedules(runner, hpxml, hpxml_bldg, weather, args)
info_msgs = []
- get_simulation_parameters(hpxml, weather, args)
- get_generator_inputs(hpxml_bldg, weather, args)
+ Defaults.apply(runner, hpxml, hpxml_bldg, weather)
+
+ get_simulation_parameters(hpxml, args)
+ get_generator_inputs(hpxml_bldg, args)
args[:resources_path] = File.join(File.dirname(__FILE__), 'resources')
- schedule_generator = ScheduleGenerator.new(runner: runner, **args)
+ schedule_generator = ScheduleGenerator.new(runner: runner, hpxml_bldg: hpxml_bldg, **args)
success = schedule_generator.create(args: args, weather: weather)
return false if not success
@@ -236,32 +237,26 @@ def create_schedules(runner, hpxml, hpxml_bldg, weather, args)
# Get simulation parameters that are required for the stochastic schedule generator.
#
# @param hpxml [HPXML] HPXML object
- # @param weather [WeatherFile] Weather object containing EPW information
# @param args [Hash] Map of :argument_name => value
- def get_simulation_parameters(hpxml, weather, args)
+ def get_simulation_parameters(hpxml, args)
args[:minutes_per_step] = 60
if !hpxml.header.timestep.nil?
args[:minutes_per_step] = hpxml.header.timestep
end
args[:steps_in_day] = 24 * 60 / args[:minutes_per_step]
- args[:mkc_ts_per_day] = 96
- args[:mkc_ts_per_hour] = args[:mkc_ts_per_day] / 24
- calendar_year = Location.get_sim_calendar_year(hpxml.header.sim_calendar_year, weather)
- args[:sim_year] = calendar_year
+ args[:sim_year] = hpxml.header.sim_calendar_year
args[:sim_start_day] = DateTime.new(args[:sim_year], 1, 1)
- args[:total_days_in_year] = Calendar.num_days_in_year(calendar_year)
+ args[:total_days_in_year] = Calendar.num_days_in_year(hpxml.header.sim_calendar_year)
end
# Get generator inputs that are required for the stochastic schedule generator.
#
# @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
- # @param weather [WeatherFile] Weather object containing EPW information
# @param args [Hash] Map of :argument_name => value
- def get_generator_inputs(hpxml_bldg, weather, args)
- state_code = Defaults.get_state_code(hpxml_bldg.state_code, weather)
- if Constants::StateCodesMap.keys.include?(state_code)
- args[:state] = state_code
+ def get_generator_inputs(hpxml_bldg, args)
+ if Constants::StateCodesMap.keys.include?(hpxml_bldg.state_code)
+ args[:state] = hpxml_bldg.state_code
else
# Unhandled state code, fallback to CO
args[:state] = 'CO'
@@ -275,9 +270,9 @@ def get_generator_inputs(hpxml_bldg, weather, args)
end
args[:geometry_num_occupants] = Float(Integer(args[:geometry_num_occupants]))
- args[:time_zone_utc_offset] = Defaults.get_time_zone(hpxml_bldg.time_zone_utc_offset, weather)
- args[:latitude] = Defaults.get_latitude(hpxml_bldg.latitude, weather)
- args[:longitude] = Defaults.get_longitude(hpxml_bldg.longitude, weather)
+ args[:time_zone_utc_offset] = hpxml_bldg.time_zone_utc_offset
+ args[:latitude] = hpxml_bldg.latitude
+ args[:longitude] = hpxml_bldg.longitude
end
end
diff --git a/BuildResidentialScheduleFile/measure.xml b/BuildResidentialScheduleFile/measure.xml
index f892fc288f..2fd96ff21c 100644
--- a/BuildResidentialScheduleFile/measure.xml
+++ b/BuildResidentialScheduleFile/measure.xml
@@ -3,8 +3,8 @@
3.1
build_residential_schedule_file
f770b2db-1a9f-4e99-99a7-7f3161a594b1
- c5bb6758-f028-455a-a49d-25f4df40e500
- 2025-01-02T23:31:30Z
+ acfa3ed7-ca05-472e-832b-19f86cabf04b
+ 2025-02-18T03:57:10Z
03F02484
BuildResidentialScheduleFile
Schedule File Builder
@@ -133,7 +133,7 @@
measure.rb
rb
script
- F7D77A2C
+ 9163B41C
README.md
@@ -229,7 +229,7 @@
schedules.rb
rb
resource
- F14B1337
+ F51BA6CF
shower_cluster_size_probability.csv
@@ -931,7 +931,7 @@
test_build_residential_schedule_file.rb
rb
test
- 04AE998D
+ 9C469A27
diff --git a/BuildResidentialScheduleFile/resources/schedules.rb b/BuildResidentialScheduleFile/resources/schedules.rb
index 540d41b6eb..3f7dd4ae47 100644
--- a/BuildResidentialScheduleFile/resources/schedules.rb
+++ b/BuildResidentialScheduleFile/resources/schedules.rb
@@ -2,7 +2,6 @@
require 'csv'
require 'matrix'
-
# Collection of methods related to the generation of stochastic occupancy schedules.
class ScheduleGenerator
# @param runner [OpenStudio::Measure::OSRunner] Object typically used to display warnings
@@ -11,21 +10,18 @@ class ScheduleGenerator
# @param random_seed [Integer] the seed for the random number generator
# @param minutes_per_step [Integer] the simulation timestep (minutes)
# @param steps_in_day [Integer] the number of steps in a 24-hour day
- # @param mkc_ts_per_day [Integer] Markov chain timesteps per day
- # @param mkc_ts_per_hour [Integer] Markov chain timesteps per hour
# @param total_days_in_year [Integer] number of days in the calendar year
# @param sim_year [Integer] the calendar year
# @param sim_start_day [DateTime] the DateTime object corresponding to Jan 1 of the calendar year
# @param debug [Boolean] If true, writes extra column(s) (e.g., sleeping) for informational purposes.
# @param append_output [Boolean] If true and the output CSV file already exists, appends columns to the file rather than overwriting it. The existing output CSV file must have the same number of rows (i.e., timeseries frequency) as the new columns being appended.
def initialize(runner:,
+ hpxml_bldg:,
state:,
column_names: nil,
random_seed: nil,
minutes_per_step:,
steps_in_day:,
- mkc_ts_per_day:,
- mkc_ts_per_hour:,
total_days_in_year:,
sim_year:,
sim_start_day:,
@@ -33,14 +29,17 @@ def initialize(runner:,
append_output:,
**)
@runner = runner
+ @hpxml_bldg = hpxml_bldg
@state = state
@column_names = column_names
@random_seed = random_seed
@minutes_per_step = minutes_per_step
@steps_in_day = steps_in_day
- @mkc_ts_per_day = mkc_ts_per_day
- @mkc_ts_per_hour = mkc_ts_per_hour
@total_days_in_year = total_days_in_year
+ @mkc_ts_per_day = 96
+ @mkc_ts_per_hour = 96 / 24
+ @mkc_steps_in_a_year = @total_days_in_year * @mkc_ts_per_day
+ @mins_in_year = @total_days_in_year * 1440
@sim_year = sim_year
@sim_start_day = sim_start_day
@debug = debug
@@ -65,10 +64,6 @@ def create(args:,
weather:)
@schedules = {}
- ScheduleGenerator.export_columns.each do |col_name|
- @schedules[col_name] = Array.new(@total_days_in_year * @steps_in_day, 0.0)
- end
-
if @column_names.nil?
@column_names = SchedulesFile::Columns.values.map { |c| c.name }
end
@@ -85,6 +80,39 @@ def create(args:,
return true
end
+ # Export the generated schedules to a CSV file.
+ #
+ # @param schedules_path [String] Path to write the schedules CSV file to
+ # @return [Boolean] Returns true if successful, false if there was an error
+ def export(schedules_path:)
+ (SchedulesFile::Columns.values.map { |c| c.name } - @column_names).each do |col_to_remove|
+ @schedules.delete(col_to_remove)
+ end
+ schedule_keys = @schedules.keys
+ schedule_rows = @schedules.values.transpose.map { |row| row.map { |x| '%.3g' % x } }
+ if @append_output && File.exist?(schedules_path)
+ table = CSV.read(schedules_path)
+ if table.size != schedule_rows.size + 1
+ @runner.registerError("Invalid number of rows (#{table.size}) in file.csv. Expected #{schedule_rows.size + 1} rows (including the header row).")
+ return false
+ end
+ schedule_keys = table[0] + schedule_keys
+ schedule_rows = schedule_rows.map.with_index { |row, i| table[i + 1] + row }
+ end
+
+ # Note: We don't use the CSV library here because it's slow for large files
+ File.open(schedules_path, 'w') do |csv|
+ csv << "#{schedule_keys.join(',')}\n"
+ schedule_rows.each do |row|
+ csv << "#{row.join(',')}\n"
+ end
+ end
+
+ return true
+ end
+
+ private
+
# The main method for creating stochastic schedules.
#
# @param args [Hash] Map of :argument_name => value
@@ -92,1008 +120,1315 @@ def create(args:,
# @return [Boolean] true if successful
def create_stochastic_schedules(args:,
weather:)
- default_schedules_csv_data = Defaults.get_schedules_csv_data()
- schedules_csv_data = get_schedules_csv_data()
-
- # initialize a random number generator
- prng = Random.new(@random_seed)
+ @default_schedules_csv_data = Defaults.get_schedules_csv_data()
+ @schedules_csv_data = get_schedules_csv_data()
+
+ # Use independent random number generators for each class of enduse so that when certain
+ # enduses are removed/added in an upgrade run, the schedules for the other enduses are not affected
+ # New class of enduses can be be added to the enduse_types list at the end without loss of backwards
+ # compatibility (i.e. ability to generate same schedules for existing enduses with a given seed)
+ # For plug loads and lighting, the schedules are deterministically generated from occupancy schedule so separate
+ # prngs are not needed for them.
+ @prngs = {}
+ @prngs[:main] = Random.new(@random_seed)
+ seed_generator = Random.new(@random_seed)
+ enduse_types = [:hygiene, :dishwasher, :clothes_washer, :clothes_dryer, :ev, :cooking]
+ enduse_types.each do |key|
+ @prngs[key] = Random.new(seed_generator.rand(2**32))
+ end
+ @num_occupants = args[:geometry_num_occupants].to_i
+ @resources_path = args[:resources_path]
# pre-load the probability distribution csv files for speed
- cluster_size_prob_map = read_activity_cluster_size_probs(resources_path: args[:resources_path])
- event_duration_prob_map = read_event_duration_probs(resources_path: args[:resources_path])
- activity_duration_prob_map = read_activity_duration_prob(resources_path: args[:resources_path])
- appliance_power_dist_map = read_appliance_power_dist(resources_path: args[:resources_path])
- weekday_monthly_shift_dict = read_monthly_shift_minutes(resources_path: args[:resources_path], daytype: 'weekday')
- weekend_monthly_shift_dict = read_monthly_shift_minutes(resources_path: args[:resources_path], daytype: 'weekend')
-
- all_simulated_values = [] # holds the markov-chain state for each of the seven simulated states for each occupant.
+ @cluster_size_prob_map = read_activity_cluster_size_probs()
+ @event_duration_prob_map = read_event_duration_probs()
+ @activity_duration_prob_map = read_activity_duration_prob()
+ @appliance_power_dist_map = read_appliance_power_dist()
+ @weekday_monthly_shift_dict = read_monthly_shift_minutes(daytype: 'weekday')
+ @weekend_monthly_shift_dict = read_monthly_shift_minutes(daytype: 'weekend')
+
+ mkc_activity_schedules = simulate_occupant_activities()
+ # shape of mkc_activity_schedules is [n, 35040, 7] i.e. (geometry_num_occupants, period_in_a_year, number_of_states)
+ @ev_occupant_number = get_ev_occupant_number(mkc_activity_schedules)
+ occupancy_schedules = generate_occupancy_schedules(mkc_activity_schedules)
+ @schedules[SchedulesFile::Columns[:Occupants].name] = occupancy_schedules[:away_schedule].map { |i| 1.0 - i }
+
+ fill_plug_loads_schedule(mkc_activity_schedules, weather)
+ fill_lighting_schedule(mkc_activity_schedules, args)
+ # Generate schedules for each class of enduse
+ sink_activity_sch = generate_sink_schedule(mkc_activity_schedules)
+ shower_activity_sch, bath_activity_sch = generate_bath_shower_schedules(mkc_activity_schedules)
+
+ # Apply random offset to schedules to avoid synchronization
+ offset_range = 30 # +- 30 minutes offset
+ random_offset = (@prngs[:main].rand * 2 * offset_range).to_i - offset_range
+ if !@hpxml_bldg.dishwashers.to_a.empty?
+ dw_hot_water_sch = generate_dishwasher_schedule(mkc_activity_schedules)
+ dw_power_sch = generate_dishwasher_power_schedule(mkc_activity_schedules)
+ @schedules.merge!({
+ SchedulesFile::Columns[:HotWaterDishwasher].name => random_shift_and_normalize(dw_hot_water_sch, random_offset),
+ SchedulesFile::Columns[:Dishwasher].name => random_shift_and_normalize(dw_power_sch, random_offset)
+ })
+ end
+ if !@hpxml_bldg.clothes_washers.to_a.empty?
+ cw_hot_water_sch = generate_clothes_washer_schedule(mkc_activity_schedules)
+ cw_power_sch, cd_power_sch = generate_clothes_washer_dryer_power_schedules(mkc_activity_schedules)
+ @schedules.merge!({
+ SchedulesFile::Columns[:HotWaterClothesWasher].name => random_shift_and_normalize(cw_hot_water_sch, random_offset),
+ SchedulesFile::Columns[:ClothesWasher].name => random_shift_and_normalize(cw_power_sch, random_offset)
+ })
+ if !@hpxml_bldg.clothes_dryers.to_a.empty?
+ @schedules.merge!({
+ SchedulesFile::Columns[:ClothesDryer].name => random_shift_and_normalize(cd_power_sch, random_offset)
+ })
+ end
+ end
+ if !@hpxml_bldg.cooking_ranges.to_a.empty?
+ cooking_power_sch = generate_cooking_power_schedule(mkc_activity_schedules)
+ @schedules.merge!({
+ SchedulesFile::Columns[:CookingRange].name => random_shift_and_normalize(cooking_power_sch, random_offset)
+ })
+ end
+
+ showers = random_shift_and_normalize(shower_activity_sch, random_offset)
+ sinks = random_shift_and_normalize(sink_activity_sch, random_offset)
+ baths = random_shift_and_normalize(bath_activity_sch, random_offset)
+ fixtures = [showers, sinks, baths].transpose.map(&:sum)
+ @schedules[SchedulesFile::Columns[:HotWaterFixtures].name] = normalize(fixtures)
+ fill_ev_schedules(mkc_activity_schedules, occupancy_schedules[:ev_occupant_presence])
+ if @debug
+ @schedules[SchedulesFile::Columns[:PresentOccupants].name] = occupancy_schedules[:present_occupants]
+ @schedules[SchedulesFile::Columns[:Sleeping].name] = occupancy_schedules[:sleep_schedule]
+ end
+ return true
+ end
+
+ # TODO
+ #
+ # @return [TODO] TODO
+ def simulate_occupant_activities()
+ mkc_activity_schedules = [] # holds the markov-chain state for each of the seven simulated states for each occupant.
# States are: 'sleeping', 'shower', 'laundry', 'cooking', 'dishwashing', 'absent', 'nothingAtHome'
- # if geometry_num_occupants = 2, period_in_a_year = 35040, num_of_states = 7, then
- # shape of all_simulated_values is [2, 35040, 7]
- occupancy_types_probabilities = Schedule.validate_values(Constants::OccupancyTypesProbabilities, 4, 'occupancy types probabilities')
- for _n in 1..args[:geometry_num_occupants]
- occ_type_id = weighted_random(prng, occupancy_types_probabilities)
- init_prob_file_weekday = args[:resources_path] + "/weekday/mkv_chain_initial_prob_cluster_#{occ_type_id}.csv"
- initial_prob_weekday = CSV.read(init_prob_file_weekday)
- initial_prob_weekday = initial_prob_weekday.map { |x| x[0].to_f }
- init_prob_file_weekend = args[:resources_path] + "/weekend/mkv_chain_initial_prob_cluster_#{occ_type_id}.csv"
- initial_prob_weekend = CSV.read(init_prob_file_weekend)
- initial_prob_weekend = initial_prob_weekend.map { |x| x[0].to_f }
-
- transition_matrix_file_weekday = args[:resources_path] + "/weekday/mkv_chain_transition_prob_cluster_#{occ_type_id}.csv"
- transition_matrix_weekday = CSV.read(transition_matrix_file_weekday)
- transition_matrix_weekday = transition_matrix_weekday.map { |x| x.map { |y| y.to_f } }
- transition_matrix_file_weekend = args[:resources_path] + "/weekend/mkv_chain_transition_prob_cluster_#{occ_type_id}.csv"
- transition_matrix_weekend = CSV.read(transition_matrix_file_weekend)
- transition_matrix_weekend = transition_matrix_weekend.map { |x| x.map { |y| y.to_f } }
+ occupancy_types_probabilities = Schedule.validate_values(Constants::OccupancyTypesProbabilities, 4, 'occupancy types probabilities')
+ initial_probabilities = get_initial_probabilities()
+ transition_matrices = get_transition_matrices()
+ for _n in 1..@num_occupants
+ occ_type_id = weighted_random(@prngs[:main], occupancy_types_probabilities)
simulated_values = []
@total_days_in_year.times do |day|
today = @sim_start_day + day
- day_of_week = today.wday
- if [0, 6].include?(day_of_week)
- # Weekend
- day_type = 'weekend'
- initial_prob = initial_prob_weekend
- transition_matrix = transition_matrix_weekend
- else
- # weekday
- day_type = 'weekday'
- initial_prob = initial_prob_weekday
- transition_matrix = transition_matrix_weekday
- end
+ day_type = [0, 6].include?(today.wday) ? :weekend : :weekday
j = 0
- state_prob = initial_prob # [] shape = 1x7. probability of transitioning to each of the 7 states
- while j < @mkc_ts_per_day do
- active_state = weighted_random(prng, state_prob) # Randomly pick the next state
+ state_prob = initial_probabilities[occ_type_id][day_type] # [] shape = 1x7. probability of transitioning to each of the 7 states
+ while j < @mkc_ts_per_day
+ active_state = weighted_random(@prngs[:main], state_prob) # Randomly pick the next state
state_vector = [0] * 7 # there are 7 states
state_vector[active_state] = 1 # Transition to the new state
+
# sample the duration of the state, and skip markov-chain based state transition until the end of the duration
- activity_duration = sample_activity_duration(prng, activity_duration_prob_map, occ_type_id, active_state, day_type, j / 4)
+ activity_duration = sample_activity_duration(@prngs[:main], @activity_duration_prob_map, occ_type_id, active_state, day_type, j / 4)
+
for _i in 1..activity_duration
# repeat the same activity for the duration times
simulated_values << state_vector
j += 1
- if j >= @mkc_ts_per_day then break end # break as soon as we have filled activities for the day
+ break if j >= @mkc_ts_per_day # break as soon as we have filled activities for the day
end
- if j >= @mkc_ts_per_day then break end # break as soon as we have filled activities for the day
+ break if j >= @mkc_ts_per_day # break as soon as we have filled activities for the day
- transition_probs = transition_matrix[(j - 1) * 7..j * 7 - 1] # obtain the transition matrix for current timestep
+ # obtain the transition matrix for current timestep
+ transition_probs = transition_matrices[occ_type_id][day_type][(j - 1) * 7..j * 7 - 1]
state_prob = transition_probs[active_state]
end
end
# Markov-chain transition probabilities is based on ATUS data, and the starting time of day for the data is
# 4 am. We need to shift everything forward by 16 timesteps to make it midnight-based.
- simulated_values = simulated_values.rotate(-4 * 4) # 4am shifting (4 hours = 4 * 4 steps of 15 min intervals)
- all_simulated_values << Matrix[*simulated_values]
+ simulated_values = simulated_values.rotate(-4 * 4) # 4am shifting (4 hours = 4 * 4 steps of 15 min intervals)
+ mkc_activity_schedules << Matrix[*simulated_values]
end
- # shape of all_simulated_values is [2, 35040, 7] i.e. (geometry_num_occupants, period_in_a_year, number_of_states)
- plugload_other_weekday_sch = Schedule.validate_values(default_schedules_csv_data[SchedulesFile::Columns[:PlugLoadsOther].name]['WeekdayScheduleFractions'], 24, 'weekday') # Table C.3(1) of ANSI/RESNET/ICC 301-2022 Addendum C
- plugload_other_weekend_sch = Schedule.validate_values(default_schedules_csv_data[SchedulesFile::Columns[:PlugLoadsOther].name]['WeekendScheduleFractions'], 24, 'weekend') # Table C.3(1) of ANSI/RESNET/ICC 301-2022 Addendum C
- plugload_other_monthly_multiplier = Schedule.validate_values(schedules_csv_data[SchedulesFile::Columns[:PlugLoadsOther].name]['PlugLoadsOtherMonthlyMultipliers'], 12, 'monthly') # Figure 24 of the 2010 BAHSP
- plugload_tv_weekday_sch = Schedule.validate_values(schedules_csv_data[SchedulesFile::Columns[:PlugLoadsTV].name]['PlugLoadsTVWeekdayFractions'], 24, 'weekday') # American Time Use Survey
- plugload_tv_weekend_sch = Schedule.validate_values(schedules_csv_data[SchedulesFile::Columns[:PlugLoadsTV].name]['PlugLoadsTVWeekendFractions'], 24, 'weekend') # American Time Use Survey
- plugload_tv_monthly_multiplier = Schedule.validate_values(schedules_csv_data[SchedulesFile::Columns[:PlugLoadsTV].name]['PlugLoadsTVMonthlyMultipliers'], 12, 'monthly') # American Time Use Survey
- ceiling_fan_weekday_sch = Schedule.validate_values(default_schedules_csv_data[SchedulesFile::Columns[:CeilingFan].name]['WeekdayScheduleFractions'], 24, 'weekday') # Table C.3(5) of ANSI/RESNET/ICC 301-2022 Addendum C
- ceiling_fan_weekend_sch = Schedule.validate_values(default_schedules_csv_data[SchedulesFile::Columns[:CeilingFan].name]['WeekendScheduleFractions'], 24, 'weekend') # Table C.3(5) of ANSI/RESNET/ICC 301-2022 Addendum C
- ceiling_fan_monthly_multiplier = Schedule.validate_values(Defaults.get_ceiling_fan_months(weather).join(', '), 12, 'monthly') # based on monthly average outdoor temperatures per ANSI/RESNET/ICC 301
-
- sch = get_building_america_lighting_schedule(args[:time_zone_utc_offset], args[:latitude], args[:longitude], schedules_csv_data)
- interior_lighting_schedule = []
- num_days_in_months = Calendar.num_days_in_months(@sim_year)
- for month in 0..11
- interior_lighting_schedule << sch[month] * num_days_in_months[month]
+
+ return mkc_activity_schedules
+ end
+
+ # Get initial probabilities for each occupancy type and day type.
+ #
+ # @return [Hash] Map of occupancy type ID to weekday/weekend initial probabilities
+ def get_initial_probabilities()
+ initial_probabilities = {}
+ # get weekday/weekend initial probabilities for 4 occupancy types
+ for occ_id in 0..3
+ initial_probabilities[occ_id] = {}
+ init_prob_file_weekday_file_path = "#{@resources_path}/weekday/mkv_chain_initial_prob_cluster_#{occ_id}.csv"
+ initial_probabilities[occ_id][:weekday] = CSV.read(init_prob_file_weekday_file_path).map { |x| x[0].to_f }
+ init_prob_file_weekend_file_path = "#{@resources_path}/weekend/mkv_chain_initial_prob_cluster_#{occ_id}.csv"
+ initial_probabilities[occ_id][:weekend] = CSV.read(init_prob_file_weekend_file_path).map { |x| x[0].to_f }
+ end
+ return initial_probabilities
+ end
+
+ # Get markov-chain transition matrices for each occupancy type and day type.
+ #
+ # @return [Hash] Map of occupancy type ID to weekday/weekend transition matrices
+ def get_transition_matrices()
+ transition_matrices = {}
+ # get weekday/weekend transition matrices for 4 occupancy types
+ for occ_id in 0..3
+ transition_matrices[occ_id] = {}
+ weekday_file_path = "#{@resources_path}/weekday/mkv_chain_transition_prob_cluster_#{occ_id}.csv"
+ transition_matrices[occ_id][:weekday] = CSV.read(weekday_file_path).map { |x| x.map { |y| y.to_f } }
+ weekend_file_path = "#{@resources_path}/weekend/mkv_chain_transition_prob_cluster_#{occ_id}.csv"
+ transition_matrices[occ_id][:weekend] = CSV.read(weekend_file_path).map { |x| x.map { |y| y.to_f } }
end
- interior_lighting_schedule = interior_lighting_schedule.flatten
- m = interior_lighting_schedule.max
- interior_lighting_schedule = interior_lighting_schedule.map { |s| s / m }
+ return transition_matrices
+ end
- sleep_schedule = []
- away_schedule = []
- idle_schedule = []
+ # Aggregate array values by summing groups of elements.
+ #
+ # @param array [Array] Array of values to aggregate
+ # @param group_size [Integer] Number of consecutive elements to sum together
+ # @return [Array] New array with values aggregated by group_size
+ def aggregate_array(array, group_size)
+ new_array_size = array.size / group_size
+ new_array = [0] * new_array_size
+ new_array_size.times do |j|
+ new_array[j] = array[(j * group_size)..(j + 1) * group_size - 1].sum(0)
+ end
+ return new_array
+ end
- # fill in the yearly time_step resolution schedule for plug/lighting and ceiling fan based on weekday/weekend sch
- # States are: 0='sleeping', 1='shower', 2='laundry', 3='cooking', 4='dishwashing', 5='absent', 6='nothingAtHome'
+ # Apply monthly schedule shifts based on weekday/weekend patterns.
+ #
+ # @param array [Array] Array of minute-level schedule values to shift
+ # @param weekday_monthly_shift_dict [Hash] Map of month name to number of minutes to shift weekday schedules
+ # @param weekend_monthly_shift_dict [Hash] Map of month name to number of minutes to shift weekend schedules
+ # @return [Array] New array with values shifted according to monthly patterns
+ def apply_monthly_offsets(array:, weekday_monthly_shift_dict:, weekend_monthly_shift_dict:)
+ month_strs = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'July', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+ new_array = []
@total_days_in_year.times do |day|
today = @sim_start_day + day
- month = today.month
day_of_week = today.wday
- [0, 6].include?(day_of_week) ? is_weekday = false : is_weekday = true
- @steps_in_day.times do |step|
- minute = day * 1440 + step * @minutes_per_step
- index_15 = (minute / 15).to_i
- sleep_schedule << sum_across_occupants(all_simulated_values, 0, index_15).to_f / args[:geometry_num_occupants]
- away_schedule << sum_across_occupants(all_simulated_values, 5, index_15).to_f / args[:geometry_num_occupants]
- idle_schedule << sum_across_occupants(all_simulated_values, 6, index_15).to_f / args[:geometry_num_occupants]
- active_occupancy_percentage = 1 - (away_schedule[-1] + sleep_schedule[-1])
- @schedules[SchedulesFile::Columns[:PlugLoadsOther].name][day * @steps_in_day + step] = get_value_from_daily_sch(plugload_other_weekday_sch, plugload_other_weekend_sch, plugload_other_monthly_multiplier, month, is_weekday, minute, active_occupancy_percentage)
- @schedules[SchedulesFile::Columns[:PlugLoadsTV].name][day * @steps_in_day + step] = get_value_from_daily_sch(plugload_tv_weekday_sch, plugload_tv_weekend_sch, plugload_tv_monthly_multiplier, month, is_weekday, minute, active_occupancy_percentage)
- @schedules[SchedulesFile::Columns[:LightingInterior].name][day * @steps_in_day + step] = scale_lighting_by_occupancy(interior_lighting_schedule, minute, active_occupancy_percentage)
- @schedules[SchedulesFile::Columns[:CeilingFan].name][day * @steps_in_day + step] = get_value_from_daily_sch(ceiling_fan_weekday_sch, ceiling_fan_weekend_sch, ceiling_fan_monthly_multiplier, month, is_weekday, minute, active_occupancy_percentage)
+ month = month_strs[today.month - 1]
+ if [0, 6].include?(day_of_week)
+ # Weekend
+ lead = weekend_monthly_shift_dict[month]
+ else
+ # weekday
+ lead = weekday_monthly_shift_dict[month]
+ end
+ if lead.nil?
+ raise "Could not find the entry for month #{month}, day #{day_of_week} and state #{@state}"
end
+
+ new_array.concat(array[day * 1440, 1440].rotate(lead))
end
- @schedules[SchedulesFile::Columns[:PlugLoadsOther].name] = normalize(@schedules[SchedulesFile::Columns[:PlugLoadsOther].name])
- @schedules[SchedulesFile::Columns[:PlugLoadsTV].name] = normalize(@schedules[SchedulesFile::Columns[:PlugLoadsTV].name])
- @schedules[SchedulesFile::Columns[:LightingInterior].name] = normalize(@schedules[SchedulesFile::Columns[:LightingInterior].name])
- @schedules[SchedulesFile::Columns[:LightingGarage].name] = @schedules[SchedulesFile::Columns[:LightingInterior].name]
- @schedules[SchedulesFile::Columns[:CeilingFan].name] = normalize(@schedules[SchedulesFile::Columns[:CeilingFan].name])
+ return new_array
+ end
- # Generate the Sink Schedule
- # 1. Find indexes (minutes) when at least one occupant can have sink event (they aren't sleeping or absent)
- # 2. Determine number of cluster per day
- # 3. Sample flow-rate for the sink
- # 4. For each cluster
- # a. sample for number_of_events
- # b. Re-normalize onset probability by removing invalid indexes (invalid = where we already have sink events)
- # b. Probabilistically determine the start of the first event based on onset probability.
- # c. For each event in number_of_events
- # i. Sample the duration
- # ii. Add the time occupied by event to invalid_index
- # ii. if more events, offset by fixed wait time and goto c
- # d. if more cluster, go to 4.
- mins_in_year = 1440 * @total_days_in_year
- mkc_steps_in_a_year = @total_days_in_year * @mkc_ts_per_day
- sink_activity_probable_mins = [0] * mkc_steps_in_a_year # 0 indicates sink activity cannot happen at that time
- sink_activity_sch = [0] * 1440 * @total_days_in_year
- # mark minutes when at least one occupant is doing nothing at home as possible sink activity time
- # States are: 0='sleeping', 1='shower', 2='laundry', 3='cooking', 4='dishwashing', 5='absent', 6='nothingAtHome'
- mkc_steps_in_a_year.times do |step|
- all_simulated_values.size.times do |i| # across occupants
- # if at least one occupant is not sleeping and not absent from home, then sink event can occur at that time
- if not ((all_simulated_values[i][step, 0] == 1) || (all_simulated_values[i][step, 5] == 1))
- sink_activity_probable_mins[step] = 1
- end
- end
+ # Read monthly schedule shift minutes from CSV file for a given state and day type.
+ #
+ # @param daytype [String] Type of day ('weekday' or 'weekend') to get shifts for
+ # @return [Hash] Map of month name to number of minutes to shift schedules
+ def read_monthly_shift_minutes(daytype:)
+ shift_file = @resources_path + "/#{daytype}/state_and_monthly_schedule_shift.csv"
+ shifts = CSV.read(shift_file)
+ state_index = shifts[0].find_index('State')
+ lead_index = shifts[0].find_index('Lead')
+ month_index = shifts[0].find_index('Month')
+ state_shifts = shifts.select { |row| row[state_index] == @state }
+ monthly_shifts_dict = Hash[state_shifts.map { |row| [row[month_index], row[lead_index].to_i] }]
+ return monthly_shifts_dict
+ end
+
+ # Read appliance power distribution data from CSV files.
+ #
+ # @return [Hash] Map of appliance name to array containing duration and consumption distributions
+ def read_appliance_power_dist()
+ activity_names = ['clothes_washer', 'dishwasher', 'clothes_dryer', 'cooking']
+ power_dist_map = {}
+ activity_names.each do |activity|
+ duration_file = @resources_path + "/#{activity}_duration_dist.csv"
+ consumption_file = @resources_path + "/#{activity}_consumption_dist.csv"
+ duration_vals = CSV.read(duration_file)
+ consumption_vals = CSV.read(consumption_file)
+ duration_vals = duration_vals.map { |a| a.map { |i| i.to_i } }
+ consumption_vals = consumption_vals.map { |a| a[0].to_f }
+ power_dist_map[activity] = [duration_vals, consumption_vals]
end
+ return power_dist_map
+ end
- sink_duration_probs = Schedule.validate_values(Constants::SinkDurationProbability, 9, 'sink_duration_probability')
- events_per_cluster_probs = Schedule.validate_values(Constants::SinkEventsPerClusterProbs, 15, 'sink_events_per_cluster_probs')
- hourly_onset_prob = Schedule.validate_values(Constants::SinkHourlyOnsetProb, 24, 'sink_hourly_onset_prob')
- # Lookup avg_sink_clusters_per_hh from constants
- avg_sink_clusters_per_hh = Constants::SinkAvgSinkClustersPerHH
- # Adjust avg_sink_clusters_per_hh for number of occupants in household
- total_clusters = avg_sink_clusters_per_hh * (0.29 * args[:geometry_num_occupants] + 0.26) # Eq based on cluster scaling in Building America DHW Event Schedule Generator (fewer sink draw clusters for larger households)
- sink_minutes_between_event_gap = Constants::SinkMinutesBetweenEventGap
- cluster_per_day = (total_clusters / @total_days_in_year).to_i
- sink_flow_rate_mean = Constants::SinkFlowRateMean
- sink_flow_rate_std = Constants::SinkFlowRateStd
- sink_flow_rate = gaussian_rand(prng, sink_flow_rate_mean, sink_flow_rate_std)
- @total_days_in_year.times do |day|
- for _n in 1..cluster_per_day
- todays_probable_steps = sink_activity_probable_mins[day * @mkc_ts_per_day..((day + 1) * @mkc_ts_per_day - 1)]
- todays_probablities = todays_probable_steps.map.with_index { |p, i| p * hourly_onset_prob[i / @mkc_ts_per_hour] }
- prob_sum = todays_probablities.sum(0)
- normalized_probabilities = todays_probablities.map { |p| p * 1 / prob_sum }
- cluster_start_index = weighted_random(prng, normalized_probabilities)
- if sink_activity_probable_mins[cluster_start_index] != 0
- sink_activity_probable_mins[cluster_start_index] = 0 # mark the 15-min interval as unavailable for another sink event
- end
- num_events = weighted_random(prng, events_per_cluster_probs) + 1
- start_min = cluster_start_index * 15
- end_min = (cluster_start_index + 1) * 15
- for _i in 1..num_events
- duration = weighted_random(prng, sink_duration_probs) + 1
- if start_min + duration > end_min then duration = (end_min - start_min) end
- sink_activity_sch.fill(sink_flow_rate, (day * 1440) + start_min, duration)
- start_min += duration + sink_minutes_between_event_gap # Two minutes gap between sink activity
- if start_min >= end_min then break end
- end
- end
+ # Sample the duration and power consumption for an appliance event.
+ #
+ # @param prng [Random] Random number generator to use for sampling
+ # @param power_dist_map [Hash] Map of appliance name to array containing duration and consumption distributions
+ # @param appliance_name [String] Name of the appliance to sample duration and power for
+ # @return [Array] Array containing [duration in 15-min intervals, average power in watts]
+ def sample_appliance_duration_power(prng, power_dist_map, appliance_name)
+ # returns number number of 15-min interval the appliance runs, and the average 15-min power
+ duration_vals, consumption_vals = power_dist_map[appliance_name]
+ if @consumption_row.nil?
+ # initialize and pick the consumption and duration row only the first time
+ # checking only consumption_row is sufficient because duration_row always go side by side with consumption row
+ @consumption_row = {}
+ @duration_row = {}
+ end
+ if !@consumption_row.has_key?(appliance_name)
+ @consumption_row[appliance_name] = (prng.rand * consumption_vals.size).to_i
+ @duration_row[appliance_name] = (prng.rand * duration_vals.size).to_i
end
+ power = consumption_vals[@consumption_row[appliance_name]]
+ sample = prng.rand(0..(duration_vals[@duration_row[appliance_name]].length - 1))
+ duration = duration_vals[@duration_row[appliance_name]][sample]
+ return [duration, power]
+ end
- # Generate minute level schedule for shower and bath
- # 1. Identify the shower time slots from the mkc schedule. This corresponds to personal hygiene time
- # For each slot:
- # 2. Determine if the personal hygiene is to be bath/shower using bath_to_shower_ratio probability
- # 3. Sample for the shower and bath flow rate. (These will remain same throughout the year for a given building)
- # However, the duration of each shower/bath event can be different, so, in 15-minute aggregation, the shower/bath
- # Water consumption might appear different between different events
- # 4. If it is shower
- # a. Determine the number of events in the shower cluster (there can be multiple showers)
- # b. For each event, sample the shower duration
- # c. Fill in the time period of personal hygiene using that many events of corresponding duration
- # separated by shower_minutes_between_event_gap.
- # TODO If there is room in the mkc personal hygiene slot, shift uniform randomly
- # 5. If it is bath
- # a. Sample the bath duration
- # b. Fill in the mkc personal hygiene slot with the bath duration and flow rate.
- # TODO If there is room in the mkc personal hygiene slot, shift uniform randomly
- # 6. Repeat process 2-6 for each occupant
- shower_minutes_between_event_gap = Constants::ShowerMinutesBetweenEventGap
- shower_flow_rate_mean = Constants::ShowerFlowRateMean
- shower_flow_rate_std = Constants::ShowerFlowRateStd
- bath_ratio = Constants::BathToShowerRatio
- bath_duration_mean = Constants::BathDurationMean
- bath_duration_std = Constants::BathDurationStd
- bath_flow_rate_mean = Constants::BathFlowRateMean
- bath_flow_rate_std = Constants::BathFlowRateStd
- m = 0
- shower_activity_sch = [0] * mins_in_year
- bath_activity_sch = [0] * mins_in_year
- bath_flow_rate = gaussian_rand(prng, bath_flow_rate_mean, bath_flow_rate_std)
- shower_flow_rate = gaussian_rand(prng, shower_flow_rate_mean, shower_flow_rate_std)
- # States are: 'sleeping','shower','laundry','cooking', 'dishwashing', 'absent', 'nothingAtHome'
- step = 0
- while step < mkc_steps_in_a_year
- # shower_state will be equal to number of occupant taking shower/bath in the given 15-minute mkc interval
- shower_state = sum_across_occupants(all_simulated_values, 1, step)
- step_jump = 1
- for _n in 1..shower_state.to_i
- r = prng.rand
- if r <= bath_ratio
- # fill in bath for this time
- duration = gaussian_rand(prng, bath_duration_mean, bath_duration_std)
- int_duration = duration.ceil
- # since we are rounding duration to integer minute, we compensate by scaling flow rate
- flow_rate = bath_flow_rate * duration / int_duration
- start_min = step * 15
- m = 0
- int_duration.times do
- bath_activity_sch[start_min + m] += flow_rate
- m += 1
- if (start_min + m) >= mins_in_year then break end
- end
- step_jump = [step_jump, 1 + (m / 15)].max # jump additional step if the bath occupies multiple 15-min slots
- else
- # fill in the shower
- num_events = sample_activity_cluster_size(prng, cluster_size_prob_map, 'shower')
- start_min = step * 15
- m = 0
- num_events.times do
- duration = sample_event_duration(prng, event_duration_prob_map, 'shower')
- int_duration = duration.ceil
- flow_rate = shower_flow_rate * duration / int_duration
- # since we are rounding duration to integer minute, we compensate by scaling flow rate
- int_duration.times do
- shower_activity_sch[start_min + m] += flow_rate
- m += 1
- if (start_min + m) >= mins_in_year then break end
- end
- shower_minutes_between_event_gap.times do
- # skip the gap between events
- m += 1
- if (start_min + m) >= mins_in_year then break end
- end
- if start_min + m >= mins_in_year then break end
+ # Read activity cluster size probability distributions from CSV files.
+ #
+ # @return [Hash] Map of activity name to array containing cluster size probabilities
+ def read_activity_cluster_size_probs
+ activity_names = ['hot_water_clothes_washer', 'hot_water_dishwasher', 'shower']
+ cluster_size_prob_map = {}
+ activity_names.each do |activity|
+ cluster_size_file = @resources_path + "/#{activity}_cluster_size_probability.csv"
+ cluster_size_probabilities = CSV.read(cluster_size_file)
+ cluster_size_probabilities = cluster_size_probabilities.map { |entry| entry[0].to_f }
+ cluster_size_prob_map[activity] = cluster_size_probabilities
+ end
+ return cluster_size_prob_map
+ end
+
+ # Read event duration probability distributions from CSV files.
+ #
+ # @return [Hash] Map of activity name to array containing durations and probabilities
+ def read_event_duration_probs()
+ activity_names = ['hot_water_clothes_washer', 'hot_water_dishwasher', 'shower']
+ event_duration_probabilites_map = {}
+ activity_names.each do |activity|
+ duration_file = @resources_path + "/#{activity}_event_duration_probability.csv"
+ duration_probabilities = CSV.read(duration_file)
+ durations = duration_probabilities.map { |entry| entry[0].to_f / 60 } # convert to minute
+ probabilities = duration_probabilities.map { |entry| entry[1].to_f }
+ event_duration_probabilites_map[activity] = [durations, probabilities]
+ end
+ return event_duration_probabilites_map
+ end
+
+ # Read activity duration probability distributions from CSV files.
+ #
+ # @return [Hash] Map of activity name to array containing durations and probabilities
+ def read_activity_duration_prob()
+ cluster_types = ['0', '1', '2', '3']
+ day_types = ['weekday', 'weekend']
+ time_of_days = ['morning', 'midday', 'evening']
+ activity_names = ['shower', 'cooking', 'dishwashing', 'laundry']
+ activity_duration_prob_map = {}
+ cluster_types.each do |cluster_type|
+ day_types.each do |day_type|
+ time_of_days.each do |time_of_day|
+ activity_names.each do |activity_name|
+ duration_file = @resources_path + "/#{day_type}/duration_probability/cluster_#{cluster_type}_#{activity_name}_#{time_of_day}_duration_probability.csv"
+ duration_probabilities = CSV.read(duration_file)
+ durations = duration_probabilities.map { |entry| entry[0].to_i }
+ probabilities = duration_probabilities.map { |entry| entry[1].to_f }
+ activity_duration_prob_map["#{cluster_type}_#{activity_name}_#{day_type}_#{time_of_day}"] = [durations, probabilities]
end
- step_jump = [step_jump, 1 + (m / 15)].max
end
end
- step += step_jump
end
+ return activity_duration_prob_map
+ end
- # Generate minute level schedule for dishwasher and clothes washer
- # 1. Identify the dishwasher/clothes washer time slots from the mkc schedule.
- # 2. Sample for the flow_rate
- # 3. Determine the number of events in the dishwasher/clothes washer cluster
- # (it's typically composed of multiple water draw events)
- # 4. For each event, sample the event duration
- # 5. Fill in the dishwasher/clothes washer time slot using those water draw events
- dw_flow_rate_mean = Constants::HotWaterDishwasherFlowRateMean
- dw_flow_rate_std = Constants::HotWaterDishwasherFlowRateStd
- dw_minutes_between_event_gap = Constants::HotWaterDishwasherMinutesBetweenEventGap
- dw_activity_sch = [0] * mins_in_year
- m = 0
- dw_flow_rate = gaussian_rand(prng, dw_flow_rate_mean, dw_flow_rate_std)
+ # Sample the number of events in a cluster for a given activity type.
+ #
+ # @param cluster_size_prob_map [Hash] Map of activity name to array of probabilities for different cluster sizes
+ # @param activity_type_name [String] Name of the activity type to sample cluster size for
+ # @return [Integer] Number of events in the cluster (1-based)
+ def sample_activity_cluster_size(prng, cluster_size_prob_map, activity_type_name)
+ cluster_size_probabilities = cluster_size_prob_map[activity_type_name]
+ return weighted_random(prng, cluster_size_probabilities) + 1
+ end
- # States are: 'sleeping','shower','laundry','cooking', 'dishwashing', 'absent', 'nothingAtHome'
- # Fill in dw_water draw schedule
- step = 0
- while step < mkc_steps_in_a_year
- dish_state = sum_across_occupants(all_simulated_values, 4, step, max_clip: 1)
- step_jump = 1
- if dish_state > 0
- cluster_size = sample_activity_cluster_size(prng, cluster_size_prob_map, 'hot_water_dishwasher')
- start_minute = step * 15
- m = 0
- cluster_size.times do
- duration = sample_event_duration(prng, event_duration_prob_map, 'hot_water_dishwasher')
- int_duration = duration.ceil
- flow_rate = dw_flow_rate * duration / int_duration
- int_duration.times do
- dw_activity_sch[start_minute + m] = flow_rate
- m += 1
- if start_minute + m >= mins_in_year then break end
- end
- if start_minute + m >= mins_in_year then break end
+ # Sample a duration for a given event type based on its probability distribution.
+ #
+ # @param duration_probabilites_map [Hash] Map of event type to array containing durations and probabilities
+ # @param event_type [String] Type of event to sample duration for (e.g. 'hot_water_clothes_washer')
+ # @return [Float] Duration in minutes for the sampled event
+ def sample_event_duration(prng, duration_probabilites_map, event_type)
+ durations = duration_probabilites_map[event_type][0]
+ probabilities = duration_probabilites_map[event_type][1]
+ return durations[weighted_random(prng, probabilities)]
+ end
- dw_minutes_between_event_gap.times do
- m += 1
- if start_minute + m >= mins_in_year then break end
- end
- if start_minute + m >= mins_in_year then break end
- end
- step_jump = [step_jump, 1 + (m / 15)].max
- end
- step += step_jump
+ # Sample a duration for an activity based on occupant type, activity type, day type and hour.
+ #
+ # @param activity_duration_prob_map [Hash] Map of activity parameters to arrays containing durations and probabilities
+ # @param occ_type_id [String] Occupant type ID (cluster type)
+ # @param activity [Integer] Activity state number (1=shower, 2=laundry, 3=cooking, 4=dishwashing)
+ # @param day_type [String] Type of day ('weekday' or 'weekend')
+ # @param hour [Integer] Hour of the day (0-23)
+ # @return [Integer] Duration in minutes for the sampled activity
+ def sample_activity_duration(prng, activity_duration_prob_map, occ_type_id, activity, day_type, hour)
+ # States are: 'sleeping', 'shower', 'laundry', 'cooking', 'dishwashing', 'absent', 'nothingAtHome'
+ if hour < 8
+ time_of_day = 'morning'
+ elsif hour < 16
+ time_of_day = 'midday'
+ else
+ time_of_day = 'evening'
end
- cw_flow_rate_mean = Constants::HotWaterClothesWasherFlowRateMean
- cw_flow_rate_std = Constants::HotWaterClothesWasherFlowRateStd
- cw_minutes_between_event_gap = Constants::HotWaterClothesWasherMinutesBetweenEventGap
- cw_activity_sch = [0] * mins_in_year # this is the clothes_washer water draw schedule
- cw_load_size_probability = Schedule.validate_values(Constants::HotWaterClothesWasherLoadSizeProbability, 4, 'hot_water_clothes_washer_load_size_probability')
- m = 0
- cw_flow_rate = gaussian_rand(prng, cw_flow_rate_mean, cw_flow_rate_std)
- # States are: 'sleeping','shower','laundry','cooking', 'dishwashing', 'absent', 'nothingAtHome'
- step = 0
- # Fill in clothes washer water draw schedule based on markov-chain state 2 (laundry)
- while step < mkc_steps_in_a_year
- clothes_state = sum_across_occupants(all_simulated_values, 2, step, max_clip: 1)
- step_jump = 1
- if clothes_state > 0
- num_loads = weighted_random(prng, cw_load_size_probability) + 1
- start_minute = step * 15
- m = 0
- num_loads.times do
- cluster_size = sample_activity_cluster_size(prng, cluster_size_prob_map, 'hot_water_clothes_washer')
- cluster_size.times do
- duration = sample_event_duration(prng, event_duration_prob_map, 'hot_water_clothes_washer')
- int_duration = duration.ceil
- flow_rate = cw_flow_rate * duration.to_f / int_duration
- int_duration.times do
- cw_activity_sch[start_minute + m] = flow_rate
- m += 1
- if start_minute + m >= mins_in_year then break end
- end
- if start_minute + m >= mins_in_year then break end
+ if activity == 1
+ activity_name = 'shower'
+ elsif activity == 2
+ activity_name = 'laundry'
+ elsif activity == 3
+ activity_name = 'cooking'
+ elsif activity == 4
+ activity_name = 'dishwashing'
+ else
+ return 1 # all other activity will span only one mkc step
+ end
+ durations = activity_duration_prob_map["#{occ_type_id}_#{activity_name}_#{day_type}_#{time_of_day}"][0]
+ probabilities = activity_duration_prob_map["#{occ_type_id}_#{activity_name}_#{day_type}_#{time_of_day}"][1]
+ return durations[weighted_random(prng, probabilities)]
+ end
- cw_minutes_between_event_gap.times do
- # skip the gap between events
- m += 1
- if start_minute + m >= mins_in_year then break end
- end
- if start_minute + m >= mins_in_year then break end
- end
- end
- if start_minute + m >= mins_in_year then break end
+ # Generate a random number from a Gaussian (normal) distribution with the given parameters.
+ #
+ # @param prng [Random] Random number generator to use
+ # @param mean [Float] The mean (average) value of the distribution
+ # @param std [Float] The standard deviation of the distribution
+ # @param min [Float, nil] The minimum allowed value (defaults to 0.1)
+ # @param max [Float, nil] The maximum allowed value (optional)
+ # @return [Float] A random number drawn from the specified Gaussian distribution, clipped to min/max if specified
+ def gaussian_rand(prng, mean, std, min = 0.1, max = nil)
+ t = 2 * Math::PI * prng.rand
+ r = Math.sqrt(-2 * Math.log(1 - prng.rand))
+ scale = std * r
+ x = mean + scale * Math.cos(t)
+ if (not min.nil?) && (x < min) then x = min end
+ if (not max.nil?) && (x > max) then x = max end
+ # y = mean + scale * Math.sin(t)
+ return x
+ end
- step_jump = [step_jump, 1 + (m / 15)].max
- end
- step += step_jump
+ # Sum the activity state values across all occupants at a given time index.
+ #
+ # @param mkc_activity_schedules [Array] Array of matrices containing Markov chain activity states for each occupant
+ # @param activity_index [Integer] Index of the activity state to sum (0=sleeping, 1=shower, etc)
+ # @param time_index [Integer] Time index to sum the activity state values at
+ # @param max_clip [Integer, nil] Optional maximum value to clip the sum to
+ # @return [Integer] Sum of the activity state values across occupants, clipped to max_clip if specified
+ def sum_across_occupants(mkc_activity_schedules, activity_index, time_index, max_clip: nil)
+ sum = 0
+ mkc_activity_schedules.size.times do |i|
+ sum += mkc_activity_schedules[i][time_index, activity_index]
+ end
+ if (not max_clip.nil?) && (sum > max_clip)
+ sum = max_clip
end
+ return sum
+ end
- # States are: 'sleeping', 'shower', 'laundry', 'cooking', 'dishwashing', 'absent', 'nothingAtHome'
- # Fill in dishwasher and clothes_washer power draw schedule based on markov-chain
- # This follows similar pattern as filling in water draw events, except we use different set of probability
- # distribution csv files for power level and duration of each event. And there is only one event per mkc slot.
- dw_power_sch = [0] * mins_in_year
- step = 0
- last_state = 0
- start_time = Time.new(@sim_year, 1, 1)
- hot_water_dishwasher_monthly_multiplier = Schedule.validate_values(schedules_csv_data[SchedulesFile::Columns[:Dishwasher].name]['HotWaterDishwasherMonthlyMultiplier'], 12, 'hot_water_dishwasher_monthly_multiplier')
- while step < mkc_steps_in_a_year
- dish_state = sum_across_occupants(all_simulated_values, 4, step, max_clip: 1)
- step_jump = 1
- if (dish_state > 0) && (last_state == 0) # last_state == 0 prevents consecutive dishwasher power without gap
- duration_15min, avg_power = sample_appliance_duration_power(prng, appliance_power_dist_map, 'dishwasher')
+ # Get a binary representation of occupant presence at a given time index.
+ #
+ # @param mkc_activity_schedules [Array] Array of matrices containing Markov chain activity states for each occupant
+ # @param time_index [int] time index in the array
+ # @return [int] The integer whose binary representation indicates the presence of occupants. Bit 0 is presence of the first occupant, bit 1 is the presence of the second occupant, etc.
+ def get_present_occupants(mkc_activity_schedules, time_index)
+ sum = 0
+ multiplier = 1
+ mkc_activity_schedules.size.times do |i|
+ # Since mkc_activity_schedules[i][time_index, 5]) is 1 when the occupant is away, we need to subtract it from 1
+ sum += (1 - mkc_activity_schedules[i][time_index, 5]) * multiplier
+ multiplier *= 2
+ end
+ return sum
+ end
- month = (start_time + step * 15 * 60).month
- duration_min = (duration_15min * 15 * hot_water_dishwasher_monthly_multiplier[month - 1]).to_i
+ # Determines which occupant will be assigned as the EV driver based on their away hours.
+ #
+ # @param mkc_activity_schedules [Array] Array of matrices containing Markov chain activity states for each occupant
+ # @return [Integer] Index of the occupant assigned as EV driver (0-based)
+ def get_ev_occupant_number(mkc_activity_schedules)
+ if @hpxml_bldg.vehicles.to_a.empty?
+ return 0
+ end
- duration = [duration_min, mins_in_year - step * 15].min
- dw_power_sch.fill(avg_power, step * 15, duration)
- step_jump = duration_15min
- end
- last_state = dish_state
- step += step_jump
+ vehicle = @hpxml_bldg.vehicles[0]
+ hours_per_year = (vehicle.hours_per_week / 7) * UnitConversions.convert(1, 'yr', 'day')
+
+ occupant_away_hours_per_year = []
+ mkc_activity_schedules.size.times do |i|
+ occupant_away_hours_per_year[i] = mkc_activity_schedules[i].column(5).sum() / 4
end
+ # Only keep occupants whose 80% (the portion available for driving) away hours are sufficient to meet hours_per_year
+ elligible_occupant = occupant_away_hours_per_year.each_with_index.filter { |value, _| value * 0.8 > hours_per_year }
+ if elligible_occupant.empty?
+ # if nobody has enough away hours, find the index of the occupant with the highest away hours
+ _, ev_occupant = occupant_away_hours_per_year.each_with_index.max_by { |value, _| value }
+ return ev_occupant
+ else
+ # return the index of a random eligible occupant
+ _, ev_occupant = elligible_occupant.sample(random: @prngs[:ev])
+ return ev_occupant
+ end
+ end
- # Fill in cw and clothes dryer power schedule
- # States are: 'sleeping', 'shower', 'laundry', 'cooking', 'dishwashing', 'absent', 'nothingAtHome'
- cw_power_sch = [0] * mins_in_year
- cd_power_sch = [0] * mins_in_year
- step = 0
- last_state = 0
- start_time = Time.new(@sim_year, 1, 1)
- clothes_dryer_monthly_multiplier = Schedule.validate_values(schedules_csv_data[SchedulesFile::Columns[:ClothesDryer].name]['ClothesDryerMonthlyMultiplier'], 12, 'clothes_dryer_monthly_multiplier')
- hot_water_clothes_washer_monthly_multiplier = Schedule.validate_values(schedules_csv_data[SchedulesFile::Columns[:ClothesWasher].name]['HotWaterClothesWasherMonthlyMultiplier'], 12, 'hot_water_clothes_washer_monthly_multiplier')
- while step < mkc_steps_in_a_year
- clothes_state = sum_across_occupants(all_simulated_values, 2, step, max_clip: 1)
- step_jump = 1
- if (clothes_state > 0) && (last_state == 0) # last_state == 0 prevents consecutive washer power without gap
- cw_duration_15min, cw_avg_power = sample_appliance_duration_power(prng, appliance_power_dist_map, 'clothes_washer')
- cd_duration_15min, cd_avg_power = sample_appliance_duration_power(prng, appliance_power_dist_map, 'clothes_dryer')
+ # Normalize an array by dividing all values by the maximum value.
+ #
+ # @param arr [Array] Array of numeric values to normalize
+ # @return [Array] Array with values normalized to between 0 and 1
+ def normalize(arr)
+ m = arr.max
+ arr = arr.map { |a| a / m }
+ return arr
+ end
- month = (start_time + step * 15 * 60).month
- cd_duration_min = (cd_duration_15min * 15 * clothes_dryer_monthly_multiplier[month - 1]).to_i
- cw_duration_min = (cw_duration_15min * 15 * hot_water_clothes_washer_monthly_multiplier[month - 1]).to_i
+ # Scale lighting schedule values based on occupancy.
+ #
+ # @param sch [Array] Array of hourly lighting schedule values
+ # @param minute [Integer] Current minute in simulation
+ # @param active_occupant_percentage [Float] Percentage of occupants that are active (not sleeping/away)
+ # @return [Float] Scaled lighting schedule value based on occupancy
+ def scale_lighting_by_occupancy(sch, minute, active_occupant_percentage)
+ day_start = minute / 1440
+ day_sch = sch[day_start * 24, 24]
+ current_val = sch[minute / 60]
+ return day_sch.min + (current_val - day_sch.min) * active_occupant_percentage
+ end
- cw_duration = [cw_duration_min, mins_in_year - step * 15].min
- cw_power_sch.fill(cw_avg_power, step * 15, cw_duration)
- cd_start_time = (step * 15 + cw_duration).to_i # clothes dryer starts immediately after washer ends\
- cd_duration = [cd_duration_min, mins_in_year - cd_start_time].min # cd_duration would be negative if cd_start_time > mins_in_year, and no filling would occur
- cd_power_sch = cd_power_sch.fill(cd_avg_power, cd_start_time, cd_duration)
- step_jump = cw_duration_15min + cd_duration_15min
+ # Get schedule value for current minute based on weekday/weekend schedule and occupancy.
+ #
+ # @param weekday_sch [Array] Array of hourly schedule values for weekdays
+ # @param weekend_sch [Array] Array of hourly schedule values for weekends
+ # @param monthly_multiplier [Array] Array of monthly multipliers to apply to schedule values
+ # @param month [Integer] Current month (1-12)
+ # @param is_weekday [Boolean] Whether current day is a weekday
+ # @param minute [Integer] Current minute in simulation
+ # @param active_occupant_percentage [Float] Percentage of occupants that are active (not sleeping/away)
+ # @return [Float] Schedule value scaled by occupancy and monthly multiplier
+ def get_value_from_daily_sch(weekday_sch, weekend_sch, monthly_multiplier, month, is_weekday, minute, active_occupant_percentage)
+ is_weekday ? sch = weekday_sch : sch = weekend_sch
+ full_occupancy_current_val = sch[((minute % 1440) / 60).to_i].to_f * monthly_multiplier[month - 1].to_f
+ return sch.min + (full_occupancy_current_val - sch.min) * active_occupant_percentage
+ end
+
+ # Randomly select an index based on weighted probabilities.
+ #
+ # @param prng [Random] Random number generator
+ # @param weights [Array] Array of probability weights that sum to 1
+ # @return [Integer] Randomly selected index based on probability weights
+ def weighted_random(prng, weights)
+ n = prng.rand
+ cum_weights = 0
+ weights.each_with_index do |w, index|
+ cum_weights += w
+ if n <= cum_weights
+ return index
end
- last_state = clothes_state
- step += step_jump
end
+ return weights.size - 1 # If the prob weight don't sum to n, return last index
+ end
- # Fill in cooking power schedule
- # States are: 'sleeping', 'shower', 'laundry', 'cooking', 'dishwashing', 'absent', 'nothingAtHome'
- cooking_power_sch = [0] * mins_in_year
- step = 0
- last_state = 0
- start_time = Time.new(@sim_year, 1, 1)
- cooking_monthly_multiplier = Schedule.validate_values(schedules_csv_data[SchedulesFile::Columns[:CookingRange].name]['CookingMonthlyMultiplier'], 12, 'cooking_monthly_multiplier')
- while step < mkc_steps_in_a_year
- cooking_state = sum_across_occupants(all_simulated_values, 3, step, max_clip: 1)
- step_jump = 1
- if (cooking_state > 0) && (last_state == 0) # last_state == 0 prevents consecutive cooking power without gap
- duration_15min, avg_power = sample_appliance_duration_power(prng, appliance_power_dist_map, 'cooking')
- month = (start_time + step * 15 * 60).month
- duration_min = (duration_15min * 15 * cooking_monthly_multiplier[month - 1]).to_i
- duration = [duration_min, mins_in_year - step * 15].min
- cooking_power_sch.fill(avg_power, step * 15, duration)
- step_jump = duration_15min
+ # Get the Building America lighting schedule based on location and time zone.
+ #
+ # @param time_zone_utc_offset [Integer] Offset from UTC in hours
+ # @param latitude [Float] Latitude in degrees
+ # @param longitude [Float] Longitude in degrees
+ # @return [Array] Array of hourly lighting schedule values
+ def get_building_america_lighting_schedule(time_zone_utc_offset, latitude, longitude)
+ # Sunrise and sunset hours
+ sunrise_hour = []
+ sunset_hour = []
+ std_long = -time_zone_utc_offset * 15
+ normalized_hourly_lighting = [[1..24], [1..24], [1..24], [1..24], [1..24], [1..24], [1..24], [1..24], [1..24], [1..24], [1..24], [1..24]]
+ for month in 0..11
+ if latitude < 51.49
+ m_num = month + 1
+ jul_day = m_num * 30 - 15
+ if not ((m_num < 4) || (m_num > 10))
+ offset = 1
+ else
+ offset = 0
+ end
+ declination = 23.45 * Math.sin(0.9863 * (284 + jul_day) * 0.01745329)
+ deg_rad = Math::PI / 180
+ rad_deg = 1 / deg_rad
+ b = (jul_day - 1) * 0.9863
+ equation_of_time = (0.01667 * (0.01719 + 0.42815 * Math.cos(deg_rad * b) - 7.35205 * Math.sin(deg_rad * b) - 3.34976 * Math.cos(deg_rad * (2 * b)) - 9.37199 * Math.sin(deg_rad * (2 * b))))
+ sunset_hour_angle = rad_deg * Math.acos(-1 * Math.tan(deg_rad * latitude) * Math.tan(deg_rad * declination))
+ sunrise_hour[month] = offset + (12.0 - 1 * sunset_hour_angle / 15.0) - equation_of_time - (std_long + longitude) / 15
+ sunset_hour[month] = offset + (12.0 + 1 * sunset_hour_angle / 15.0) - equation_of_time - (std_long + longitude) / 15
+ else
+ sunrise_hour = [8.125726064, 7.449258072, 6.388688653, 6.232405257, 5.27722936, 4.84705384, 5.127512162, 5.860163988, 6.684378904, 7.521267411, 7.390441945, 8.080667697]
+ sunset_hour = [16.22214058, 17.08642353, 17.98324493, 19.83547864, 20.65149672, 21.20662992, 21.12124777, 20.37458274, 19.25834757, 18.08155615, 16.14359164, 15.75571306]
end
- last_state = cooking_state
- step += step_jump
end
- offset_range = 30
-
- # showers, sinks, baths
-
- random_offset = (prng.rand * 2 * offset_range).to_i - offset_range
- shower_activity_sch = shower_activity_sch.rotate(random_offset)
- shower_activity_sch = apply_monthly_offsets(array: shower_activity_sch, weekday_monthly_shift_dict: weekday_monthly_shift_dict, weekend_monthly_shift_dict: weekend_monthly_shift_dict)
- shower_activity_sch = aggregate_array(shower_activity_sch, @minutes_per_step)
- shower_peak_flow = shower_activity_sch.max
- showers = shower_activity_sch.map { |flow| flow / shower_peak_flow }
-
- random_offset = (prng.rand * 2 * offset_range).to_i - offset_range
- sink_activity_sch = sink_activity_sch.rotate(-4 * 60 + random_offset) # 4 am shifting
- sink_activity_sch = apply_monthly_offsets(array: sink_activity_sch, weekday_monthly_shift_dict: weekday_monthly_shift_dict, weekend_monthly_shift_dict: weekend_monthly_shift_dict)
- sink_activity_sch = aggregate_array(sink_activity_sch, @minutes_per_step)
- sink_peak_flow = sink_activity_sch.max
- sinks = sink_activity_sch.map { |flow| flow / sink_peak_flow }
-
- random_offset = (prng.rand * 2 * offset_range).to_i - offset_range
- bath_activity_sch = bath_activity_sch.rotate(random_offset)
- bath_activity_sch = apply_monthly_offsets(array: bath_activity_sch, weekday_monthly_shift_dict: weekday_monthly_shift_dict, weekend_monthly_shift_dict: weekend_monthly_shift_dict)
- bath_activity_sch = aggregate_array(bath_activity_sch, @minutes_per_step)
- bath_peak_flow = bath_activity_sch.max
- baths = bath_activity_sch.map { |flow| flow / bath_peak_flow }
-
- # hot water dishwasher/clothes washer/fixtures, cooking range, clothes washer/dryer, dishwasher, occupants
-
- random_offset = (prng.rand * 2 * offset_range).to_i - offset_range
- dw_activity_sch = dw_activity_sch.rotate(random_offset)
- dw_activity_sch = apply_monthly_offsets(array: dw_activity_sch, weekday_monthly_shift_dict: weekday_monthly_shift_dict, weekend_monthly_shift_dict: weekend_monthly_shift_dict)
- dw_activity_sch = aggregate_array(dw_activity_sch, @minutes_per_step)
- dw_peak_flow = dw_activity_sch.max
- @schedules[SchedulesFile::Columns[:HotWaterDishwasher].name] = dw_activity_sch.map { |flow| flow / dw_peak_flow }
-
- random_offset = (prng.rand * 2 * offset_range).to_i - offset_range
- cw_activity_sch = cw_activity_sch.rotate(random_offset)
- cw_activity_sch = apply_monthly_offsets(array: cw_activity_sch, weekday_monthly_shift_dict: weekday_monthly_shift_dict, weekend_monthly_shift_dict: weekend_monthly_shift_dict)
- cw_activity_sch = aggregate_array(cw_activity_sch, @minutes_per_step)
- cw_peak_flow = cw_activity_sch.max
- @schedules[SchedulesFile::Columns[:HotWaterClothesWasher].name] = cw_activity_sch.map { |flow| flow / cw_peak_flow }
-
- random_offset = (prng.rand * 2 * offset_range).to_i - offset_range
- cooking_power_sch = cooking_power_sch.rotate(random_offset)
- cooking_power_sch = apply_monthly_offsets(array: cooking_power_sch, weekday_monthly_shift_dict: weekday_monthly_shift_dict, weekend_monthly_shift_dict: weekend_monthly_shift_dict)
- cooking_power_sch = aggregate_array(cooking_power_sch, @minutes_per_step)
- cooking_peak_power = cooking_power_sch.max
- @schedules[SchedulesFile::Columns[:CookingRange].name] = cooking_power_sch.map { |power| power / cooking_peak_power }
-
- random_offset = (prng.rand * 2 * offset_range).to_i - offset_range
- cw_power_sch = cw_power_sch.rotate(random_offset)
- cw_power_sch = apply_monthly_offsets(array: cw_power_sch, weekday_monthly_shift_dict: weekday_monthly_shift_dict, weekend_monthly_shift_dict: weekend_monthly_shift_dict)
- cw_power_sch = aggregate_array(cw_power_sch, @minutes_per_step)
- cw_peak_power = cw_power_sch.max
- @schedules[SchedulesFile::Columns[:ClothesWasher].name] = cw_power_sch.map { |power| power / cw_peak_power }
-
- random_offset = (prng.rand * 2 * offset_range).to_i - offset_range
- cd_power_sch = cd_power_sch.rotate(random_offset)
- cd_power_sch = apply_monthly_offsets(array: cd_power_sch, weekday_monthly_shift_dict: weekday_monthly_shift_dict, weekend_monthly_shift_dict: weekend_monthly_shift_dict)
- cd_power_sch = aggregate_array(cd_power_sch, @minutes_per_step)
- cd_peak_power = cd_power_sch.max
- @schedules[SchedulesFile::Columns[:ClothesDryer].name] = cd_power_sch.map { |power| power / cd_peak_power }
-
- random_offset = (prng.rand * 2 * offset_range).to_i - offset_range
- dw_power_sch = dw_power_sch.rotate(random_offset)
- dw_power_sch = apply_monthly_offsets(array: dw_power_sch, weekday_monthly_shift_dict: weekday_monthly_shift_dict, weekend_monthly_shift_dict: weekend_monthly_shift_dict)
- dw_power_sch = aggregate_array(dw_power_sch, @minutes_per_step)
- dw_peak_power = dw_power_sch.max
- @schedules[SchedulesFile::Columns[:Dishwasher].name] = dw_power_sch.map { |power| power / dw_peak_power }
-
- @schedules[SchedulesFile::Columns[:Occupants].name] = away_schedule.map { |i| 1.0 - i }
+ june_kws = [0.060, 0.040, 0.035, 0.025, 0.020, 0.020, 0.020, 0.020, 0.020, 0.020, 0.020, 0.020, 0.020, 0.025, 0.030, 0.030, 0.025, 0.020, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.020, 0.020, 0.020, 0.025, 0.025, 0.030, 0.030, 0.035, 0.045, 0.060, 0.085, 0.125, 0.145, 0.130, 0.105, 0.080]
+ lighting_seasonal_multiplier = @schedules_csv_data[SchedulesFile::Columns[:LightingInterior].name]['LightingInteriorMonthlyMultipliers'].split(',').map { |v| v.to_f }
+ amplConst1 = 0.929707907917098
+ sunsetLag1 = 2.45016230615269
+ stdDevCons1 = 1.58679810983444
+ amplConst2 = 1.1372291802273
+ sunsetLag2 = 20.1501965859073
+ stdDevCons2 = 2.36567663279954
- if @debug
- @schedules[SchedulesFile::Columns[:Sleeping].name] = sleep_schedule
+ monthly_kwh_per_day = []
+ days_m = Calendar.num_days_in_months(1999) # Intentionally excluding leap year designation
+ wtd_avg_monthly_kwh_per_day = 0
+ for monthNum in 1..12
+ month = monthNum - 1
+ monthHalfHourKWHs = [0]
+ for hourNum in 0..9
+ monthHalfHourKWHs[hourNum] = june_kws[hourNum]
+ end
+ for hourNum in 9..17
+ hour = (hourNum + 1.0) * 0.5
+ monthHalfHourKWHs[hourNum] = (monthHalfHourKWHs[8] - (0.15 / (2 * Math::PI)) * Math.sin((2 * Math::PI) * (hour - 4.5) / 3.5) + (0.15 / 3.5) * (hour - 4.5)) * lighting_seasonal_multiplier[month]
+ end
+ for hourNum in 17..29
+ hour = (hourNum + 1.0) * 0.5
+ monthHalfHourKWHs[hourNum] = (monthHalfHourKWHs[16] - (-0.02 / (2 * Math::PI)) * Math.sin((2 * Math::PI) * (hour - 8.5) / 5.5) + (-0.02 / 5.5) * (hour - 8.5)) * lighting_seasonal_multiplier[month]
+ end
+ for hourNum in 29..45
+ hour = (hourNum + 1.0) * 0.5
+ monthHalfHourKWHs[hourNum] = (monthHalfHourKWHs[28] + amplConst1 * Math.exp((-1.0 * (hour - (sunset_hour[month] + sunsetLag1))**2) / (2.0 * ((25.5 / ((6.5 - monthNum).abs + 20.0)) * stdDevCons1)**2)) / ((25.5 / ((6.5 - monthNum).abs + 20.0)) * stdDevCons1 * (2.0 * Math::PI)**0.5))
+ end
+ for hourNum in 45..46
+ hour = (hourNum + 1.0) * 0.5
+ temp1 = (monthHalfHourKWHs[44] + amplConst1 * Math.exp((-1.0 * (hour - (sunset_hour[month] + sunsetLag1))**2) / (2.0 * ((25.5 / ((6.5 - monthNum).abs + 20.0)) * stdDevCons1)**2)) / ((25.5 / ((6.5 - monthNum).abs + 20.0)) * stdDevCons1 * (2.0 * Math::PI)**0.5))
+ temp2 = (0.04 + amplConst2 * Math.exp((-1.0 * (hour - sunsetLag2)**2) / (2.0 * stdDevCons2**2)) / (stdDevCons2 * (2.0 * Math::PI)**0.5))
+ if sunsetLag2 < sunset_hour[month] + sunsetLag1
+ monthHalfHourKWHs[hourNum] = [temp1, temp2].min
+ else
+ monthHalfHourKWHs[hourNum] = [temp1, temp2].max
+ end
+ end
+ for hourNum in 46..47
+ hour = (hourNum + 1) * 0.5
+ monthHalfHourKWHs[hourNum] = (0.04 + amplConst2 * Math.exp((-1.0 * (hour - sunsetLag2)**2) / (2.0 * stdDevCons2**2)) / (stdDevCons2 * (2.0 * Math::PI)**0.5))
+ end
+
+ sum_kWh = 0.0
+ for timenum in 0..47
+ sum_kWh += monthHalfHourKWHs[timenum]
+ end
+ for hour in 0..23
+ ltg_hour = (monthHalfHourKWHs[hour * 2] + monthHalfHourKWHs[hour * 2 + 1]).to_f
+ normalized_hourly_lighting[month][hour] = ltg_hour / sum_kWh
+ monthly_kwh_per_day[month] = sum_kWh / 2.0
+ end
+ wtd_avg_monthly_kwh_per_day += monthly_kwh_per_day[month] * days_m[month] / 365.0
end
- @schedules[SchedulesFile::Columns[:HotWaterFixtures].name] = [showers, sinks, baths].transpose.map { |flow| flow.sum }
- fixtures_peak_flow = @schedules[SchedulesFile::Columns[:HotWaterFixtures].name].max
- @schedules[SchedulesFile::Columns[:HotWaterFixtures].name] = @schedules[SchedulesFile::Columns[:HotWaterFixtures].name].map { |flow| flow / fixtures_peak_flow }
+ # Calculate normalized monthly lighting fractions
+ seasonal_multiplier = []
+ sumproduct_seasonal_multiplier = 0
+ normalized_monthly_lighting = seasonal_multiplier
+ for month in 0..11
+ seasonal_multiplier[month] = (monthly_kwh_per_day[month] / wtd_avg_monthly_kwh_per_day)
+ sumproduct_seasonal_multiplier += seasonal_multiplier[month] * days_m[month]
+ end
- return true
- end
+ for month in 0..11
+ normalized_monthly_lighting[month] = seasonal_multiplier[month] * days_m[month] / sumproduct_seasonal_multiplier
+ end
- # TODO
- #
- # @param array [TODO] TODO
- # @param group_size [TODO] TODO
- # @return [TODO] TODO
- def aggregate_array(array, group_size)
- new_array_size = array.size / group_size
- new_array = [0] * new_array_size
- new_array_size.times do |j|
- new_array[j] = array[(j * group_size)..(j + 1) * group_size - 1].sum(0)
+ # Calculate schedule values
+ lighting_sch = [[], [], [], [], [], [], [], [], [], [], [], []]
+ for month in 0..11
+ for hour in 0..23
+ lighting_sch[month][hour] = normalized_monthly_lighting[month] * normalized_hourly_lighting[month][hour] / days_m[month]
+ end
end
- return new_array
+
+ return lighting_sch
end
- # TODO
+ # Generates EV battery charging and discharging schedules based on away schedule and annual driving hours.
#
- # @param array [TODO] TODO
- # @param weekday_monthly_shift_dict [TODO] TODO
- # @param weekend_monthly_shift_dict [TODO] TODO
- # @return [TODO] TODO
- def apply_monthly_offsets(array:, weekday_monthly_shift_dict:, weekend_monthly_shift_dict:)
- month_strs = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'July', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
- new_array = []
- @total_days_in_year.times do |day|
- today = @sim_start_day + day
- day_of_week = today.wday
- month = month_strs[today.month - 1]
- if [0, 6].include?(day_of_week)
- # Weekend
- lead = weekend_monthly_shift_dict[month]
+ # @param away_schedule [Array] Array of 0s and 1s indicating when occupants are away (1) or home (0)
+ # @param hours_driven_per_year [Float] Number of hours the EV is driven per year
+ # @return [Array>] Two arrays - [charging_schedule, discharging_schedule], each containing 0s and 1s
+ def get_ev_battery_schedule(away_schedule, hours_driven_per_year)
+ total_driving_minutes_per_year = (hours_driven_per_year * 60).ceil
+ expanded_away_schedule = away_schedule.flat_map { |status| [status] * 15 }
+ charging_schedule = []
+ discharging_schedule = []
+ driving_minutes_used = 0
+ chunk_counts = expanded_away_schedule.chunk(&:itself).map { |value, elements| [value, elements.size] }
+ total_away_minutes = chunk_counts.map { |value, size| value * size }.sum
+ extra_drive_minutes = 0 # accumulator for keeping track of extra driving minutes used due to ceil to upper integer
+ chunk_counts.each do |is_away, activity_minutes|
+ if is_away == 1
+ current_chunk_proportion = (1.0 * activity_minutes) / total_away_minutes
+
+ expected_driving_time = (total_driving_minutes_per_year * current_chunk_proportion - extra_drive_minutes).ceil
+ max_driving_time = [expected_driving_time, total_driving_minutes_per_year - driving_minutes_used].min
+
+ max_possible_driving_time = (activity_minutes * 0.8).ceil
+ actual_driving_time = [max_driving_time, max_possible_driving_time].min
+ extra_drive_minutes += actual_driving_time - total_driving_minutes_per_year * current_chunk_proportion
+
+ idle_time = activity_minutes - actual_driving_time
+ first_half_driving = (actual_driving_time / 2.0).ceil
+ second_half_driving = actual_driving_time - first_half_driving
+
+ discharging_schedule.concat([1] * first_half_driving) # Start driving
+ discharging_schedule.concat([0] * idle_time) # Idle in the middle
+ discharging_schedule.concat([1] * second_half_driving) # End driving
+ charging_schedule.concat([0] * activity_minutes)
+
+ driving_minutes_used += actual_driving_time
else
- # weekday
- lead = weekday_monthly_shift_dict[month]
- end
- if lead.nil?
- raise "Could not find the entry for month #{month}, day #{day_of_week} and state #{@state}"
+ charging_schedule.concat([1] * activity_minutes)
+ discharging_schedule.concat([0] * activity_minutes)
end
-
- new_array.concat(array[day * 1440, 1440].rotate(lead))
end
- return new_array
+ if driving_minutes_used < total_driving_minutes_per_year
+ msg = "Insufficient away minutes (#{total_away_minutes}) for required driving minutes (#{hours_driven_per_year * 60})"
+ msg += "Only #{driving_minutes_used} minutes was used."
+ @runner.registerWarning(msg)
+ end
+
+ return charging_schedule, discharging_schedule
end
- # TODO
+ # Fill EV battery charging and discharging schedules based on Markov chain simulation results
#
- # @param resources_path [TODO] TODO
- # @param daytype [TODO] TODO
- # @return [TODO] TODO
- def read_monthly_shift_minutes(resources_path:, daytype:)
- shift_file = resources_path + "/#{daytype}/state_and_monthly_schedule_shift.csv"
- shifts = CSV.read(shift_file)
- state_index = shifts[0].find_index('State')
- lead_index = shifts[0].find_index('Lead')
- month_index = shifts[0].find_index('Month')
- state_shifts = shifts.select { |row| row[state_index] == @state }
- monthly_shifts_dict = Hash[state_shifts.map { |row| [row[month_index], row[lead_index].to_i] }]
- return monthly_shifts_dict
+ # @param markov_chain_simulation_result [Array] Array of matrices containing Markov chain simulation results for each occupant
+ # @return [nil] Updates @schedules with EV battery charging and discharging schedules
+ def fill_ev_schedules(markov_chain_simulation_result, ev_occupant_presence)
+ if @hpxml_bldg.vehicles.to_a.empty?
+ return
+ end
+
+ vehicle = @hpxml_bldg.vehicles[0]
+ hours_per_year = (vehicle.hours_per_week / 7) * UnitConversions.convert(1, 'yr', 'day')
+ away_index = 5 # Index of away activity in the markov-chain simulator
+ away_schedule = markov_chain_simulation_result[@ev_occupant_number].column(away_index)
+ charging_schedule, discharging_schedule = get_ev_battery_schedule(away_schedule, hours_per_year)
+ agg_charging_schedule = aggregate_array(charging_schedule, @minutes_per_step).map { |val| val.to_f / @minutes_per_step }
+ agg_discharging_schedule = aggregate_array(discharging_schedule, @minutes_per_step).map { |val| val.to_f / @minutes_per_step }
+
+ # The combined schedule is not a sum of the charging and discharging schedules because when charging and discharging
+ # both occur in a timestep, we don't want them to cancel out and draw no power from the building. So, whenever there
+ # is discharging, we use the full discharge in that timestep (without subtracting the charging).
+ combined_schedule = agg_charging_schedule.zip(agg_discharging_schedule).map { |charging, discharging| discharging > 0 ? -discharging : charging }
+ @schedules[SchedulesFile::Columns[:EVOccupant].name] = ev_occupant_presence if @debug
+ @schedules[SchedulesFile::Columns[:ElectricVehicle].name] = combined_schedule
end
- # TODO
+ # Get the weekday/weekend schedule fractions for TV plug loads and monthly multipliers for interior lighting, dishwasher, clothes washer/dryer, cooking range, and other/TV plug loads.
#
- # @param resources_path [TODO] TODO
- # @return [TODO] TODO
- def read_appliance_power_dist(resources_path:)
- activity_names = ['clothes_washer', 'dishwasher', 'clothes_dryer', 'cooking']
- power_dist_map = {}
- activity_names.each do |activity|
- duration_file = resources_path + "/#{activity}_duration_dist.csv"
- consumption_file = resources_path + "/#{activity}_consumption_dist.csv"
- duration_vals = CSV.read(duration_file)
- consumption_vals = CSV.read(consumption_file)
- duration_vals = duration_vals.map { |a| a.map { |i| i.to_i } }
- consumption_vals = consumption_vals.map { |a| a[0].to_f }
- power_dist_map[activity] = [duration_vals, consumption_vals]
+ # @return [Hash] { schedule_name => { element => values, ... }, ... }
+ def get_schedules_csv_data()
+ schedules_csv = File.join(File.dirname(__FILE__), 'schedules.csv')
+ if not File.exist?(schedules_csv)
+ fail 'Could not find schedules.csv'
+ end
+
+ require 'csv'
+ schedules_csv_data = {}
+ CSV.foreach(schedules_csv, headers: true) do |row|
+ schedule_name = row['Schedule Name']
+ element = row['Element']
+ values = row['Values']
+
+ schedules_csv_data[schedule_name] = {} if !schedules_csv_data.keys.include?(schedule_name)
+ schedules_csv_data[schedule_name][element] = values
end
- return power_dist_map
+
+ return schedules_csv_data
end
- # TODO
+ # Initialize daily schedule data for plug loads, TV usage, and ceiling fans.
#
- # @param prng [Random] Random number generator object
- # @param power_dist_map [TODO] TODO
- # @param appliance_name [TODO] TODO
- # @return [TODO] TODO
- def sample_appliance_duration_power(prng, power_dist_map, appliance_name)
- # returns number number of 15-min interval the appliance runs, and the average 15-min power
- duration_vals, consumption_vals = power_dist_map[appliance_name]
- if @consumption_row.nil?
- # initialize and pick the consumption and duration row only the first time
- # checking only consumption_row is sufficient because duration_row always go side by side with consumption row
- @consumption_row = {}
- @duration_row = {}
- end
- if !@consumption_row.has_key?(appliance_name)
- @consumption_row[appliance_name] = (prng.rand * consumption_vals.size).to_i
- @duration_row[appliance_name] = (prng.rand * duration_vals.size).to_i
- end
- power = consumption_vals[@consumption_row[appliance_name]]
- sample = prng.rand(0..(duration_vals[@duration_row[appliance_name]].length - 1))
- duration = duration_vals[@duration_row[appliance_name]][sample]
- return [duration, power]
+ # @param default_schedules_csv_data [Hash] Default schedule data from CSV
+ # @param schedules_csv_data [Hash] Custom schedule data from CSV
+ # @param weather [WeatherFile] Weather object containing temperature data
+ # @return [Hash] Map of schedule types to their weekday, weekend, and monthly values
+ def get_plugload_daily_schedules(default_schedules_csv_data, schedules_csv_data, weather)
+ {
+ plug_loads_other: {
+ # Table C.3(1) of ANSI/RESNET/ICC 301-2022 Addendum C
+ weekday: Schedule.validate_values(default_schedules_csv_data[SchedulesFile::Columns[:PlugLoadsOther].name]['WeekdayScheduleFractions'], 24, 'weekday'),
+ weekend: Schedule.validate_values(default_schedules_csv_data[SchedulesFile::Columns[:PlugLoadsOther].name]['WeekendScheduleFractions'], 24, 'weekend'),
+ # Figure 24 of the 2010 BAHSP
+ monthly: Schedule.validate_values(schedules_csv_data[SchedulesFile::Columns[:PlugLoadsOther].name]['PlugLoadsOtherMonthlyMultipliers'], 12, 'monthly')
+ },
+ plug_loads_tv: {
+ # American Time Use Survey
+ weekday: Schedule.validate_values(schedules_csv_data[SchedulesFile::Columns[:PlugLoadsTV].name]['PlugLoadsTVWeekdayFractions'], 24, 'weekday'),
+ weekend: Schedule.validate_values(schedules_csv_data[SchedulesFile::Columns[:PlugLoadsTV].name]['PlugLoadsTVWeekendFractions'], 24, 'weekend'),
+ monthly: Schedule.validate_values(schedules_csv_data[SchedulesFile::Columns[:PlugLoadsTV].name]['PlugLoadsTVMonthlyMultipliers'], 12, 'monthly')
+ },
+ ceiling_fan: {
+ # Table C.3(5) of ANSI/RESNET/ICC 301-2022 Addendum C
+ weekday: Schedule.validate_values(default_schedules_csv_data[SchedulesFile::Columns[:CeilingFan].name]['WeekdayScheduleFractions'], 24, 'weekday'),
+ weekend: Schedule.validate_values(default_schedules_csv_data[SchedulesFile::Columns[:CeilingFan].name]['WeekendScheduleFractions'], 24, 'weekend'),
+ # Based on monthly average outdoor temperatures per ANSI/RESNET/ICC 301
+ monthly: Schedule.validate_values(Defaults.get_ceiling_fan_months(weather).join(', '), 12, 'monthly')
+ }
+ }
end
- # TODO
+ # Initialize the interior lighting schedule based on location parameters.
#
- # @param resources_path [TODO] TODO
- # @return [TODO] TODO
- def read_activity_cluster_size_probs(resources_path:)
- activity_names = ['hot_water_clothes_washer', 'hot_water_dishwasher', 'shower']
- cluster_size_prob_map = {}
- activity_names.each do |activity|
- cluster_size_file = resources_path + "/#{activity}_cluster_size_probability.csv"
- cluster_size_probabilities = CSV.read(cluster_size_file)
- cluster_size_probabilities = cluster_size_probabilities.map { |entry| entry[0].to_f }
- cluster_size_prob_map[activity] = cluster_size_probabilities
+ # @param args [Hash] Hash containing required parameters:
+ # @option args [Integer] :time_zone_utc_offset Offset from UTC in hours
+ # @option args [Float] :latitude Latitude in degrees
+ # @option args [Float] :longitude Longitude in degrees
+ # @return [Array] Array of hourly lighting schedule values normalized to 1.0
+ def initialize_interior_lighting_schedule(args)
+ sch = get_building_america_lighting_schedule(args[:time_zone_utc_offset], args[:latitude], args[:longitude])
+ interior_lighting_schedule = []
+ num_days_in_months = Calendar.num_days_in_months(@sim_year)
+
+ for month in 0..11
+ interior_lighting_schedule << sch[month] * num_days_in_months[month]
end
- return cluster_size_prob_map
+
+ interior_lighting_schedule.flatten!
+ return normalize(interior_lighting_schedule)
end
- # TODO
+ # Generate occupancy schedules for sleeping, away, idle, EV presence and total occupancy.
#
- # @param resources_path [TODO] TODO
- # @return [TODO] TODO
- def read_event_duration_probs(resources_path:)
- activity_names = ['hot_water_clothes_washer', 'hot_water_dishwasher', 'shower']
- event_duration_probabilites_map = {}
- activity_names.each do |activity|
- duration_file = resources_path + "/#{activity}_event_duration_probability.csv"
- duration_probabilities = CSV.read(duration_file)
- durations = duration_probabilities.map { |entry| entry[0].to_f / 60 } # convert to minute
- probabilities = duration_probabilities.map { |entry| entry[1].to_f }
- event_duration_probabilites_map[activity] = [durations, probabilities]
+ # @param mkc_activity_schedules [Array] Array of matrices containing Markov chain activity states for each occupant
+ # @return [Hash] Hash containing arrays for sleep_schedule, away_schedule, idle_schedule, ev_occupant_presence, and present_occupants
+ def generate_occupancy_schedules(mkc_activity_schedules)
+ # States are: 0='sleeping', 1='shower', 2='laundry', 3='cooking', 4='dishwashing', 5='absent', 6='nothingAtHome'
+ occupancy_arrays = {
+ sleep_schedule: [],
+ away_schedule: [],
+ idle_schedule: [],
+ ev_occupant_presence: [],
+ # Binary representation of the presence of occupant. Each bit represents presence of one occupant
+ present_occupants: []
+ }
+ @total_days_in_year.times do |day|
+ @steps_in_day.times do |step|
+ minute = day * 1440 + step * @minutes_per_step
+ index_15 = (minute / 15).to_i
+ occupancy_arrays[:sleep_schedule] << sum_across_occupants(mkc_activity_schedules, 0, index_15).to_f / @num_occupants
+ occupancy_arrays[:away_schedule] << sum_across_occupants(mkc_activity_schedules, 5, index_15).to_f / @num_occupants
+ occupancy_arrays[:idle_schedule] << sum_across_occupants(mkc_activity_schedules, 6, index_15).to_f / @num_occupants
+ occupancy_arrays[:ev_occupant_presence] << (1 - mkc_activity_schedules[@ev_occupant_number][index_15, 5])
+ occupancy_arrays[:present_occupants] << get_present_occupants(mkc_activity_schedules, index_15)
+ end
end
- return event_duration_probabilites_map
+ return occupancy_arrays
end
- # TODO
+ # Fill plug loads and ceiling fan schedules based on occupant activities.
#
- # @param resources_path [TODO] TODO
- # @return [TODO] TODO
- def read_activity_duration_prob(resources_path:)
- cluster_types = ['0', '1', '2', '3']
- day_types = ['weekday', 'weekend']
- time_of_days = ['morning', 'midday', 'evening']
- activity_names = ['shower', 'cooking', 'dishwashing', 'laundry']
- activity_duration_prob_map = {}
- cluster_types.each do |cluster_type|
- day_types.each do |day_type|
- time_of_days.each do |time_of_day|
- activity_names.each do |activity_name|
- duration_file = resources_path + "/#{day_type}/duration_probability/cluster_#{cluster_type}_#{activity_name}_#{time_of_day}_duration_probability.csv"
- duration_probabilities = CSV.read(duration_file)
- durations = duration_probabilities.map { |entry| entry[0].to_i }
- probabilities = duration_probabilities.map { |entry| entry[1].to_f }
- activity_duration_prob_map["#{cluster_type}_#{activity_name}_#{day_type}_#{time_of_day}"] = [durations, probabilities]
- end
- end
- end
+ # @param mkc_activity_schedules [Array] Array of matrices containing Markov chain activity states for each occupant
+ # @param weather [WeatherFile] Weather object containing EPW information
+ # @return [void] Updates @schedules with plug loads and ceiling fan schedules
+ def fill_plug_loads_schedule(mkc_activity_schedules, weather)
+ # Initialize base schedules
+ daily_schedules = get_plugload_daily_schedules(@default_schedules_csv_data, @schedules_csv_data, weather)
+
+ # Generate schedules for each plug load type if it exists
+ if @hpxml_bldg.plug_loads.find { |p| p.plug_load_type == 'other' }
+ plug_loads_other = generate_plug_load_schedule(mkc_activity_schedules, daily_schedules, :plug_loads_other)
+ @schedules[SchedulesFile::Columns[:PlugLoadsOther].name] = normalize(plug_loads_other)
+ end
+
+ if @hpxml_bldg.plug_loads.find { |p| p.plug_load_type == 'TV other' }
+ plug_loads_tv = generate_plug_load_schedule(mkc_activity_schedules, daily_schedules, :plug_loads_tv)
+ @schedules[SchedulesFile::Columns[:PlugLoadsTV].name] = normalize(plug_loads_tv)
+ end
+ if !@hpxml_bldg.ceiling_fans.to_a.empty?
+ ceiling_fan = generate_plug_load_schedule(mkc_activity_schedules, daily_schedules, :ceiling_fan)
+ @schedules[SchedulesFile::Columns[:CeilingFan].name] = normalize(ceiling_fan)
end
- return activity_duration_prob_map
end
# TODO
#
- # @param prng [Random] Random number generator object
- # @param cluster_size_prob_map [TODO] TODO
- # @param activity_type_name [TODO] TODO
- # @return [TODO] TODO
- def sample_activity_cluster_size(prng, cluster_size_prob_map, activity_type_name)
- cluster_size_probabilities = cluster_size_prob_map[activity_type_name]
- return weighted_random(prng, cluster_size_probabilities) + 1
+ # @param mkc_activity_schedules [TODO] TODO
+ # @param daily_schedules [TODO] TODO
+ # @param schedule_type [TODO] TODO
+ # @return [TODO]
+ def generate_plug_load_schedule(mkc_activity_schedules, daily_schedules, schedule_type)
+ schedule = Array.new(@total_days_in_year * @steps_in_day, 0.0)
+ @total_days_in_year.times do |day|
+ today = @sim_start_day + day
+ month = today.month
+ is_weekday = ![0, 6].include?(today.wday)
+ @steps_in_day.times do |step|
+ minute = day * 1440 + step * @minutes_per_step
+ index_15 = (minute / 15).to_i
+ # Calculate occupancy percentage
+ active_occupancy_percentage = calculate_active_occupancy(mkc_activity_schedules, index_15)
+ schedule_index = day * @steps_in_day + step
+ # Update schedule based on daily schedules and occupancy
+ schedule[schedule_index] = get_value_from_daily_sch(
+ daily_schedules[schedule_type][:weekday],
+ daily_schedules[schedule_type][:weekend],
+ daily_schedules[schedule_type][:monthly],
+ month, is_weekday, minute, active_occupancy_percentage
+ )
+ end
+ end
+ return schedule
end
- # TODO
+ # Calculate the percentage of occupants that are actively present and awake.
#
- # @param prng [Random] Random number generator object
- # @param duration_probabilites_map [TODO] TODO
- # @param event_type [TODO] TODO
- # @return [TODO] TODO
- def sample_event_duration(prng, duration_probabilites_map, event_type)
- durations = duration_probabilites_map[event_type][0]
- probabilities = duration_probabilites_map[event_type][1]
- return durations[weighted_random(prng, probabilities)]
+ # @param mkc_activity_schedules [Array] Array of occupant activity schedules
+ # @param index_15 [Integer] 15-minute timestep index
+ # @return [Float] Percentage of occupants that are actively present and awake
+ def calculate_active_occupancy(mkc_activity_schedules, index_15)
+ sleep_percentage = sum_across_occupants(mkc_activity_schedules, 0, index_15).to_f / @num_occupants
+ away_percentage = sum_across_occupants(mkc_activity_schedules, 5, index_15).to_f / @num_occupants
+ 1 - (away_percentage + sleep_percentage)
end
- # TODO
+ # Fill the lighting schedule based on occupant activities.
#
- # @param prng [Random] Random number generator object
- # @param activity_duration_prob_map [TODO] TODO
- # @param occ_type_id [TODO] TODO
- # @param activity [TODO] TODO
- # @param day_type [TODO] TODO
- # @param hour [TODO] TODO
- # @return [TODO] TODO
- def sample_activity_duration(prng, activity_duration_prob_map, occ_type_id, activity, day_type, hour)
- # States are: 'sleeping', 'shower', 'laundry', 'cooking', 'dishwashing', 'absent', 'nothingAtHome'
- if hour < 8
- time_of_day = 'morning'
- elsif hour < 16
- time_of_day = 'midday'
- else
- time_of_day = 'evening'
+ # @param mkc_activity_schedules [Array] Array of occupant activity schedules
+ # @param args [Hash] Map of :argument_name => value
+ # @return [nil]
+ def fill_lighting_schedule(mkc_activity_schedules, args)
+ # Initialize base lighting schedule
+ interior_lighting_schedule = initialize_interior_lighting_schedule(args)
+
+ # Generate minute-level schedule
+ lighting_interior = Array.new(@total_days_in_year * @steps_in_day, 0.0)
+
+ @total_days_in_year.times do |day|
+ @steps_in_day.times do |step|
+ minute = day * 1440 + step * @minutes_per_step
+ index_15 = (minute / 15).to_i
+
+ # Calculate occupancy percentage
+ active_occupancy_percentage = calculate_active_occupancy(mkc_activity_schedules, index_15)
+
+ schedule_index = day * @steps_in_day + step
+ lighting_interior[schedule_index] = scale_lighting_by_occupancy(
+ interior_lighting_schedule, minute, active_occupancy_percentage
+ )
+ end
end
- if activity == 1
- activity_name = 'shower'
- elsif activity == 2
- activity_name = 'laundry'
- elsif activity == 3
- activity_name = 'cooking'
- elsif activity == 4
- activity_name = 'dishwashing'
- else
- return 1 # all other activity will span only one mkc step
+ normalized_lighting = normalize(lighting_interior)
+ @schedules[SchedulesFile::Columns[:LightingInterior].name] = normalized_lighting
+ if @hpxml_bldg.has_location(HPXML::LocationGarage)
+ @schedules[SchedulesFile::Columns[:LightingGarage].name] = normalized_lighting
end
- durations = activity_duration_prob_map["#{occ_type_id}_#{activity_name}_#{day_type}_#{time_of_day}"][0]
- probabilities = activity_duration_prob_map["#{occ_type_id}_#{activity_name}_#{day_type}_#{time_of_day}"][1]
- return durations[weighted_random(prng, probabilities)]
end
- # TODO
+ # Generate the sink schedule based on occupant activities.
#
- # @param schedules_path [TODO] TODO
- # @return [TODO] TODO
- def export(schedules_path:)
- (SchedulesFile::Columns.values.map { |c| c.name } - @column_names).each do |col_to_remove|
- @schedules.delete(col_to_remove)
- end
- schedule_keys = @schedules.keys
- schedule_rows = @schedules.values.transpose.map { |row| row.map { |x| '%.3g' % x } }
- if @append_output && File.exist?(schedules_path)
- table = CSV.read(schedules_path)
- if table.size != schedule_rows.size + 1
- @runner.registerError("Invalid number of rows (#{table.size}) in file.csv. Expected #{schedule_rows.size + 1} rows (including the header row).")
- return false
+ # @param mkc_activity_schedules [Array] Array of occupant activity schedules
+ # @return [Array] Minute-level sink water draw schedule
+ def generate_sink_schedule(mkc_activity_schedules)
+ # Generate the Sink Schedule
+ # 1. Find indexes (minutes) when at least one occupant can have sink event (they aren't sleeping or absent)
+ # 2. Determine number of cluster per day
+ # 3. Sample flow-rate for the sink
+ # 4. For each cluster
+ # a. sample for number_of_events
+ # b. Re-normalize onset probability by removing invalid indexes (invalid = where we already have sink events)
+ # b. Probabilistically determine the start of the first event based on onset probability.
+ # c. For each event in number_of_events
+ # i. Sample the duration
+ # ii. Add the time occupied by event to invalid_index
+ # ii. if more events, offset by fixed wait time and goto c
+ # d. if more cluster, go to 4.
+
+ sink_activity_probable_mins = get_sink_probable_minutes(mkc_activity_schedules)
+ sink_activity_sch = [0] * @mins_in_year
+
+ # Load probability distributions and constants
+ sink_duration_probs = Schedule.validate_values(Constants::SinkDurationProbability, 9, 'sink_duration_probability')
+ events_per_cluster_probs = Schedule.validate_values(Constants::SinkEventsPerClusterProbs, 15, 'sink_events_per_cluster_probs')
+ hourly_onset_prob = Schedule.validate_values(Constants::SinkHourlyOnsetProb, 24, 'sink_hourly_onset_prob')
+
+ # Calculate clusters and flow rate
+ cluster_per_day = calculate_sink_clusters_per_day()
+ sink_flow_rate = gaussian_rand(@prngs[:hygiene], Constants::SinkFlowRateMean, Constants::SinkFlowRateStd)
+ # Generate sink events for each day
+ @total_days_in_year.times do |day|
+ cluster_per_day.times do
+ # Get probability distribution for today's events
+ todays_probable_steps = sink_activity_probable_mins[day * @mkc_ts_per_day..((day + 1) * @mkc_ts_per_day - 1)]
+ todays_probablities = todays_probable_steps.map.with_index { |p, i| p * hourly_onset_prob[i / @mkc_ts_per_hour] }
+
+ # Normalize probabilities and select start time
+ prob_sum = todays_probablities.sum(0)
+ normalized_probabilities = todays_probablities.map { |p| p * 1 / prob_sum }
+ cluster_start_index = weighted_random(@prngs[:hygiene], normalized_probabilities)
+
+ # Mark time slot as used
+ if sink_activity_probable_mins[cluster_start_index] != 0
+ sink_activity_probable_mins[cluster_start_index] = 0
+ end
+
+ # Generate events within this cluster
+ num_events = weighted_random(@prngs[:hygiene], events_per_cluster_probs) + 1
+ start_min = cluster_start_index * 15
+ end_min = (cluster_start_index + 1) * 15
+
+ num_events.times do
+ duration = weighted_random(@prngs[:hygiene], sink_duration_probs) + 1
+ duration = end_min - start_min if start_min + duration > end_min
+
+ sink_activity_sch.fill(sink_flow_rate, (day * 1440) + start_min, duration)
+ start_min += duration + Constants::SinkMinutesBetweenEventGap
+
+ break if start_min >= end_min
+ end
end
- schedule_keys = table[0] + schedule_keys
- schedule_rows = schedule_rows.map.with_index { |row, i| table[i + 1] + row }
end
+ return sink_activity_sch
+ end
- # Note: We don't use the CSV library here because it's slow for large files
- File.open(schedules_path, 'w') do |csv|
- csv << "#{schedule_keys.join(',')}\n"
- schedule_rows.each do |row|
- csv << "#{row.join(',')}\n"
+ # Initialize array marking minutes when sink activity is possible.
+ #
+ # @param mkc_activity_schedules [Array>] Array of occupant activity schedules from Markov chain simulation
+ # @return [Array] Array indicating minutes when sink activity is possible (1) or not (0)
+ def get_sink_probable_minutes(mkc_activity_schedules)
+ # Initialize array marking minutes when sink activity is possible
+ # (when at least one occupant is not sleeping and not absent)
+ sink_activity_probable_mins = [0] * @mkc_steps_in_a_year
+
+ # States are: 0='sleeping', 1='shower', 2='laundry', 3='cooking', 4='dishwashing', 5='absent', 6='nothingAtHome'
+ @mkc_steps_in_a_year.times do |step|
+ mkc_activity_schedules.size.times do |i| # across occupants
+ if not ((mkc_activity_schedules[i][step, 0] == 1) || (mkc_activity_schedules[i][step, 5] == 1))
+ sink_activity_probable_mins[step] = 1
+ break # One active occupant is sufficient
+ end
end
end
- return true
+ return sink_activity_probable_mins
end
- # TODO
+ # Calculate the number of sink clusters per day based on number of occupants.
#
- # @param prng [Random] Random number generator object
- # @param mean [TODO] TODO
- # @param std [TODO] TODO
- # @param min [TODO] TODO
- # @param max [TODO] TODO
- # @return [TODO] TODO
- def gaussian_rand(prng, mean, std, min = 0.1, max = nil)
- t = 2 * Math::PI * prng.rand
- r = Math.sqrt(-2 * Math.log(1 - prng.rand))
- scale = std * r
- x = mean + scale * Math.cos(t)
- if (not min.nil?) && (x < min) then x = min end
- if (not max.nil?) && (x > max) then x = max end
- # y = mean + scale * Math.sin(t)
- return x
+ # @return [Integer] Number of sink clusters per day
+ def calculate_sink_clusters_per_day()
+ # Lookup avg_sink_clusters_per_hh from constants and adjust for number of occupants
+ avg_sink_clusters_per_hh = Constants::SinkAvgSinkClustersPerHH
+ # Eq based on cluster scaling in Building America DHW Event Schedule Generator
+ # (fewer sink draw clusters for larger households)
+ total_clusters = avg_sink_clusters_per_hh * (0.29 * @num_occupants + 0.26)
+ return (total_clusters / @total_days_in_year).to_i
end
- # TODO
+ # Generate minute level schedule for shower and bath.
#
- # @param all_simulated_values [TODO] TODO
- # @param activity_index [TODO] TODO
- # @param time_index [TODO] TODO
- # @param max_clip [TODO] TODO
- # @return [TODO] TODO
- def sum_across_occupants(all_simulated_values, activity_index, time_index, max_clip: nil)
- sum = 0
- all_simulated_values.size.times do |i|
- sum += all_simulated_values[i][time_index, activity_index]
- end
- if (not max_clip.nil?) && (sum > max_clip)
- sum = max_clip
+ # @param mkc_activity_schedules [Array>] Array of occupant activity schedules from Markov chain simulation
+ # @return [Array, Array] Arrays containing shower and bath schedules
+ def generate_bath_shower_schedules(mkc_activity_schedules)
+ # Generate minute level schedule for shower and bath
+ # 1. Identify the shower time slots from the mkc schedule. This corresponds to personal hygiene time
+ # For each slot:
+ # 2. Determine if the personal hygiene is to be bath/shower using bath_to_shower_ratio probability
+ # 3. Sample for the shower and bath flow rate. (These will remain same throughout the year for a given building)
+ # However, the duration of each shower/bath event can be different, so, in 15-minute aggregation, the shower/bath
+ # Water consumption might appear different between different events
+ # 4. If it is shower
+ # a. Determine the number of events in the shower cluster (there can be multiple showers)
+ # b. For each event, sample the shower duration
+ # c. Fill in the time period of personal hygiene using that many events of corresponding duration
+ # separated by shower_minutes_between_event_gap.
+ # TODO If there is room in the mkc personal hygiene slot, shift uniform randomly
+ # 5. If it is bath
+ # a. Sample the bath duration
+ # b. Fill in the mkc personal hygiene slot with the bath duration and flow rate.
+ # TODO If there is room in the mkc personal hygiene slot, shift uniform randomly
+ # 6. Repeat process 2-6 for each occupant
+ bath_flow_rate = gaussian_rand(@prngs[:hygiene], Constants::BathFlowRateMean, Constants::BathFlowRateStd)
+ shower_flow_rate = gaussian_rand(@prngs[:hygiene], Constants::ShowerFlowRateMean, Constants::ShowerFlowRateStd)
+ bath_sch = [0] * @mins_in_year
+ shower_sch = [0] * @mins_in_year
+ # Generate schedules
+ step = 0
+ while step < @mkc_steps_in_a_year
+ shower_state = sum_across_occupants(mkc_activity_schedules, 1, step)
+ start_min = step * 15
+ step_jump = 1
+ shower_state.to_i.times do
+ r = @prngs[:hygiene].rand
+ if r <= Constants::BathToShowerRatio
+ # Fill bath event
+ duration = gaussian_rand(@prngs[:hygiene], Constants::BathDurationMean, Constants::BathDurationStd)
+ int_duration = duration.ceil
+ # since we are rounding duration to integer minute, we compensate by scaling flow rate
+ flow_rate = bath_flow_rate * duration / int_duration
+ m = 0
+ int_duration.times do
+ break if (start_min + m) >= @mins_in_year
+
+ bath_sch[start_min + m] += flow_rate
+ m += 1
+ end
+ else
+ # Fill shower events
+ num_events = sample_activity_cluster_size(@prngs[:hygiene], @cluster_size_prob_map, 'shower')
+ m = 0
+ num_events.times do
+ duration = sample_event_duration(@prngs[:hygiene], @event_duration_prob_map, 'shower')
+ int_duration = duration.ceil
+ flow_rate = shower_flow_rate * duration / int_duration
+ int_duration.times do
+ break if (start_min + m) >= @mins_in_year
+
+ shower_sch[start_min + m] += flow_rate
+ m += 1
+ end
+ Constants::ShowerMinutesBetweenEventGap.times do
+ break if (start_min + m) >= @mins_in_year
+
+ m += 1
+ end
+ break if start_min + m >= @mins_in_year
+ end
+ end
+ step_jump = [step_jump, 1 + (m / 15)].max
+ end
+ step += step_jump
end
- return sum
+ return shower_sch, bath_sch
end
- # TODO
+ # Generate the dishwasher schedule based on occupant activities.
#
- # @param arr [TODO] TODO
- # @return [TODO] TODO
- def normalize(arr)
- m = arr.max
- arr = arr.map { |a| a / m }
- return arr
- end
+ # @param mkc_activity_schedules [Array] Array of occupant activity schedules
+ # @return [Array] Minute-level dishwasher water draw schedule
+ def generate_dishwasher_schedule(mkc_activity_schedules)
+ # Generate minute level schedule for dishwasher
+ # 1. Identify the dishwasher time slots from the mkc schedule.
+ # 2. Sample for the flow_rate
+ # 3. Determine the number of events in the dishwasher cluster
+ # (it's typically composed of multiple water draw events)
+ # 4. For each event, sample the event duration
+ # 5. Fill in the dishwasher time slot using those water draw events
- # TODO
- #
- # @param sch [TODO] TODO
- # @param minute [TODO] TODO
- # @param active_occupant_percentage [TODO] TODO
- # @return [TODO] TODO
- def scale_lighting_by_occupancy(sch, minute, active_occupant_percentage)
- day_start = minute / 1440
- day_sch = sch[day_start * 24, 24]
- current_val = sch[minute / 60]
- return day_sch.min + (current_val - day_sch.min) * active_occupant_percentage
- end
+ dw_flow_rate_mean = Constants::HotWaterDishwasherFlowRateMean
+ dw_flow_rate_std = Constants::HotWaterDishwasherFlowRateStd
+ dw_minutes_between_event_gap = Constants::HotWaterDishwasherMinutesBetweenEventGap
+ dw_hot_water_sch = [0] * @mins_in_year
+ m = 0
+ dw_flow_rate = gaussian_rand(@prngs[:dishwasher], dw_flow_rate_mean, dw_flow_rate_std)
- # TODO
- #
- # @param weekday_sch [TODO] TODO
- # @param weekend_sch [TODO] TODO
- # @param monthly_multiplier [TODO] TODO
- # @param month [TODO] TODO
- # @param is_weekday [TODO] TODO
- # @param minute [TODO] TODO
- # @param active_occupant_percentage [TODO] TODO
- # @return [TODO] TODO
- def get_value_from_daily_sch(weekday_sch, weekend_sch, monthly_multiplier, month, is_weekday, minute, active_occupant_percentage)
- is_weekday ? sch = weekday_sch : sch = weekend_sch
- full_occupancy_current_val = sch[((minute % 1440) / 60).to_i].to_f * monthly_multiplier[month - 1].to_f
- return sch.min + (full_occupancy_current_val - sch.min) * active_occupant_percentage
- end
+ # States are: 'sleeping','shower','laundry','cooking', 'dishwashing', 'absent', 'nothingAtHome'
+ # Fill in dw_water draw schedule
+ step = 0
+ while step < @mkc_steps_in_a_year
+ dish_state = sum_across_occupants(mkc_activity_schedules, 4, step, max_clip: 1)
+ step_jump = 1
+ if dish_state > 0
+ cluster_size = sample_activity_cluster_size(@prngs[:dishwasher], @cluster_size_prob_map, 'hot_water_dishwasher')
+ start_minute = step * 15
+ m = 0
+ cluster_size.times do
+ duration = sample_event_duration(@prngs[:dishwasher], @event_duration_prob_map, 'hot_water_dishwasher')
+ int_duration = duration.ceil
+ flow_rate = dw_flow_rate * duration / int_duration
+ int_duration.times do
+ dw_hot_water_sch[start_minute + m] = flow_rate
+ m += 1
+ if start_minute + m >= @mins_in_year then break end
+ end
+ if start_minute + m >= @mins_in_year then break end
- # TODO
- #
- # @param prng [Random] Random number generator object
- # @param weights [TODO] TODO
- # @return [TODO] TODO
- def weighted_random(prng, weights)
- n = prng.rand
- cum_weights = 0
- weights.each_with_index do |w, index|
- cum_weights += w
- if n <= cum_weights
- return index
+ dw_minutes_between_event_gap.times do
+ m += 1
+ if start_minute + m >= @mins_in_year then break end
+ end
+ if start_minute + m >= @mins_in_year then break end
+ end
+ step_jump = [step_jump, 1 + (m / 15)].max
end
+ step += step_jump
end
- return weights.size - 1 # If the prob weight don't sum to n, return last index
+
+ return dw_hot_water_sch
end
- # TODO
+ # Generate the clothes washer schedule based on occupant activities.
#
- # @param time_zone_utc_offset [TODO] TODO
- # @param latitude [TODO] TODO
- # @param longitude [TODO] TODO
- # @return [TODO] TODO
- def get_building_america_lighting_schedule(time_zone_utc_offset, latitude, longitude, schedules_csv_data)
- # Sunrise and sunset hours
- sunrise_hour = []
- sunset_hour = []
- std_long = -time_zone_utc_offset * 15
- normalized_hourly_lighting = [[1..24], [1..24], [1..24], [1..24], [1..24], [1..24], [1..24], [1..24], [1..24], [1..24], [1..24], [1..24]]
- for month in 0..11
- if latitude < 51.49
- m_num = month + 1
- jul_day = m_num * 30 - 15
- if not ((m_num < 4) || (m_num > 10))
- offset = 1
- else
- offset = 0
- end
- declination = 23.45 * Math.sin(0.9863 * (284 + jul_day) * 0.01745329)
- deg_rad = Math::PI / 180
- rad_deg = 1 / deg_rad
- b = (jul_day - 1) * 0.9863
- equation_of_time = (0.01667 * (0.01719 + 0.42815 * Math.cos(deg_rad * b) - 7.35205 * Math.sin(deg_rad * b) - 3.34976 * Math.cos(deg_rad * (2 * b)) - 9.37199 * Math.sin(deg_rad * (2 * b))))
- sunset_hour_angle = rad_deg * Math.acos(-1 * Math.tan(deg_rad * latitude) * Math.tan(deg_rad * declination))
- sunrise_hour[month] = offset + (12.0 - 1 * sunset_hour_angle / 15.0) - equation_of_time - (std_long + longitude) / 15
- sunset_hour[month] = offset + (12.0 + 1 * sunset_hour_angle / 15.0) - equation_of_time - (std_long + longitude) / 15
- else
- sunrise_hour = [8.125726064, 7.449258072, 6.388688653, 6.232405257, 5.27722936, 4.84705384, 5.127512162, 5.860163988, 6.684378904, 7.521267411, 7.390441945, 8.080667697]
- sunset_hour = [16.22214058, 17.08642353, 17.98324493, 19.83547864, 20.65149672, 21.20662992, 21.12124777, 20.37458274, 19.25834757, 18.08155615, 16.14359164, 15.75571306]
- end
- end
+ # @param mkc_activity_schedules [Array] Array of occupant activity schedules
+ # @return [Array] Minute-level clothes washer water draw schedule
+ def generate_clothes_washer_schedule(mkc_activity_schedules)
+ # Generate minute level schedule for clothes washer water draw
+ cw_flow_rate_mean = Constants::HotWaterClothesWasherFlowRateMean
+ cw_flow_rate_std = Constants::HotWaterClothesWasherFlowRateStd
+ cw_minutes_between_event_gap = Constants::HotWaterClothesWasherMinutesBetweenEventGap
+ cw_hot_water_sch = [0] * @mins_in_year # this is the clothes_washer water draw schedule
+ cw_load_size_probability = Schedule.validate_values(Constants::HotWaterClothesWasherLoadSizeProbability, 4, 'hot_water_clothes_washer_load_size_probability')
- june_kws = [0.060, 0.040, 0.035, 0.025, 0.020, 0.020, 0.020, 0.020, 0.020, 0.020, 0.020, 0.020, 0.020, 0.025, 0.030, 0.030, 0.025, 0.020, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.015, 0.020, 0.020, 0.020, 0.025, 0.025, 0.030, 0.030, 0.035, 0.045, 0.060, 0.085, 0.125, 0.145, 0.130, 0.105, 0.080]
- lighting_seasonal_multiplier = schedules_csv_data[SchedulesFile::Columns[:LightingInterior].name]['LightingInteriorMonthlyMultipliers'].split(',').map { |v| v.to_f }
- amplConst1 = 0.929707907917098
- sunsetLag1 = 2.45016230615269
- stdDevCons1 = 1.58679810983444
- amplConst2 = 1.1372291802273
- sunsetLag2 = 20.1501965859073
- stdDevCons2 = 2.36567663279954
+ cw_flow_rate = gaussian_rand(@prngs[:clothes_washer], cw_flow_rate_mean, cw_flow_rate_std)
- monthly_kwh_per_day = []
- days_m = Calendar.num_days_in_months(1999) # Intentionally excluding leap year designation
- wtd_avg_monthly_kwh_per_day = 0
- for monthNum in 1..12
- month = monthNum - 1
- monthHalfHourKWHs = [0]
- for hourNum in 0..9
- monthHalfHourKWHs[hourNum] = june_kws[hourNum]
- end
- for hourNum in 9..17
- hour = (hourNum + 1.0) * 0.5
- monthHalfHourKWHs[hourNum] = (monthHalfHourKWHs[8] - (0.15 / (2 * Math::PI)) * Math.sin((2 * Math::PI) * (hour - 4.5) / 3.5) + (0.15 / 3.5) * (hour - 4.5)) * lighting_seasonal_multiplier[month]
- end
- for hourNum in 17..29
- hour = (hourNum + 1.0) * 0.5
- monthHalfHourKWHs[hourNum] = (monthHalfHourKWHs[16] - (-0.02 / (2 * Math::PI)) * Math.sin((2 * Math::PI) * (hour - 8.5) / 5.5) + (-0.02 / 5.5) * (hour - 8.5)) * lighting_seasonal_multiplier[month]
- end
- for hourNum in 29..45
- hour = (hourNum + 1.0) * 0.5
- monthHalfHourKWHs[hourNum] = (monthHalfHourKWHs[28] + amplConst1 * Math.exp((-1.0 * (hour - (sunset_hour[month] + sunsetLag1))**2) / (2.0 * ((25.5 / ((6.5 - monthNum).abs + 20.0)) * stdDevCons1)**2)) / ((25.5 / ((6.5 - monthNum).abs + 20.0)) * stdDevCons1 * (2.0 * Math::PI)**0.5))
- end
- for hourNum in 45..46
- hour = (hourNum + 1.0) * 0.5
- temp1 = (monthHalfHourKWHs[44] + amplConst1 * Math.exp((-1.0 * (hour - (sunset_hour[month] + sunsetLag1))**2) / (2.0 * ((25.5 / ((6.5 - monthNum).abs + 20.0)) * stdDevCons1)**2)) / ((25.5 / ((6.5 - monthNum).abs + 20.0)) * stdDevCons1 * (2.0 * Math::PI)**0.5))
- temp2 = (0.04 + amplConst2 * Math.exp((-1.0 * (hour - sunsetLag2)**2) / (2.0 * stdDevCons2**2)) / (stdDevCons2 * (2.0 * Math::PI)**0.5))
- if sunsetLag2 < sunset_hour[month] + sunsetLag1
- monthHalfHourKWHs[hourNum] = [temp1, temp2].min
- else
- monthHalfHourKWHs[hourNum] = [temp1, temp2].max
+ # States are: 'sleeping','shower','laundry','cooking', 'dishwashing', 'absent', 'nothingAtHome'
+ step = 0
+ m = 0
+ # Fill in clothes washer water draw schedule based on markov-chain state 2 (laundry)
+ while step < @mkc_steps_in_a_year
+ clothes_state = sum_across_occupants(mkc_activity_schedules, 2, step, max_clip: 1)
+ step_jump = 1
+ if clothes_state > 0
+ num_loads = weighted_random(@prngs[:clothes_washer], cw_load_size_probability) + 1
+ start_minute = step * 15
+ m = 0
+ num_loads.times do
+ cluster_size = sample_activity_cluster_size(@prngs[:clothes_washer], @cluster_size_prob_map, 'hot_water_clothes_washer')
+ cluster_size.times do
+ duration = sample_event_duration(@prngs[:clothes_washer], @event_duration_prob_map, 'hot_water_clothes_washer')
+ int_duration = duration.ceil
+ flow_rate = cw_flow_rate * duration.to_f / int_duration
+ int_duration.times do
+ cw_hot_water_sch[start_minute + m] = flow_rate
+ m += 1
+ if start_minute + m >= @mins_in_year then break end
+ end
+ if start_minute + m >= @mins_in_year then break end
+
+ cw_minutes_between_event_gap.times do
+ # skip the gap between events
+ m += 1
+ if start_minute + m >= @mins_in_year then break end
+ end
+ if start_minute + m >= @mins_in_year then break end
+ end
end
- end
- for hourNum in 46..47
- hour = (hourNum + 1) * 0.5
- monthHalfHourKWHs[hourNum] = (0.04 + amplConst2 * Math.exp((-1.0 * (hour - sunsetLag2)**2) / (2.0 * stdDevCons2**2)) / (stdDevCons2 * (2.0 * Math::PI)**0.5))
- end
+ if start_minute + m >= @mins_in_year then break end
- sum_kWh = 0.0
- for timenum in 0..47
- sum_kWh += monthHalfHourKWHs[timenum]
- end
- for hour in 0..23
- ltg_hour = (monthHalfHourKWHs[hour * 2] + monthHalfHourKWHs[hour * 2 + 1]).to_f
- normalized_hourly_lighting[month][hour] = ltg_hour / sum_kWh
- monthly_kwh_per_day[month] = sum_kWh / 2.0
+ step_jump = [step_jump, 1 + (m / 15)].max
end
- wtd_avg_monthly_kwh_per_day += monthly_kwh_per_day[month] * days_m[month] / 365.0
+ step += step_jump
end
+ return cw_hot_water_sch
+ end
- # Calculate normalized monthly lighting fractions
- seasonal_multiplier = []
- sumproduct_seasonal_multiplier = 0
- normalized_monthly_lighting = seasonal_multiplier
- for month in 0..11
- seasonal_multiplier[month] = (monthly_kwh_per_day[month] / wtd_avg_monthly_kwh_per_day)
- sumproduct_seasonal_multiplier += seasonal_multiplier[month] * days_m[month]
- end
+ # @param mkc_activity_schedules [Array>] Markov chain activity schedules for each occupant
+ # @return [Array] Dishwasher power draw schedule for each minute of the year
+ def generate_dishwasher_power_schedule(mkc_activity_schedules)
+ # Fill in dishwasher power draw schedule based on markov-chain
+ # This follows similar pattern as filling in water draw events, except we use different set of probability
+ # distribution csv files for power level and duration of each event. And there is only one event per mkc slot.
+ dw_power_sch = [0] * @mins_in_year
+ step = 0
+ last_state = 0
+ start_time = Time.new(@sim_year, 1, 1)
+ hot_water_dishwasher_monthly_multiplier = Schedule.validate_values(@schedules_csv_data[SchedulesFile::Columns[:Dishwasher].name]['HotWaterDishwasherMonthlyMultiplier'], 12, 'hot_water_dishwasher_monthly_multiplier')
- for month in 0..11
- normalized_monthly_lighting[month] = seasonal_multiplier[month] * days_m[month] / sumproduct_seasonal_multiplier
- end
+ while step < @mkc_steps_in_a_year
+ dish_state = sum_across_occupants(mkc_activity_schedules, 4, step, max_clip: 1)
+ step_jump = 1
+ if (dish_state > 0) && (last_state == 0) # last_state == 0 prevents consecutive dishwasher power without gap
+ duration_15min, avg_power = sample_appliance_duration_power(@prngs[:dishwasher], @appliance_power_dist_map, 'dishwasher')
- # Calculate schedule values
- lighting_sch = [[], [], [], [], [], [], [], [], [], [], [], []]
- for month in 0..11
- for hour in 0..23
- lighting_sch[month][hour] = normalized_monthly_lighting[month] * normalized_hourly_lighting[month][hour] / days_m[month]
+ month = (start_time + step * 15 * 60).month
+ duration_min = (duration_15min * 15 * hot_water_dishwasher_monthly_multiplier[month - 1]).to_i
+
+ duration = [duration_min, @mins_in_year - step * 15].min
+ dw_power_sch.fill(avg_power, step * 15, duration)
+ step_jump = duration_15min
end
+ last_state = dish_state
+ step += step_jump
end
- return lighting_sch
+ return dw_power_sch
end
- # Get the weekday/weekend schedule fractions for TV plug loads and monthly multipliers for interior lighting, dishwasher, clothes washer/dryer, cooking range, and other/TV plug loads.
+ # Generate power schedules for clothes washer and dryer based on occupant activities.
#
- # @return [Hash] { schedule_name => { element => values, ... }, ... }
- def get_schedules_csv_data()
- schedules_csv = File.join(File.dirname(__FILE__), 'schedules.csv')
- if not File.exist?(schedules_csv)
- fail 'Could not find schedules.csv'
+ # @param mkc_activity_schedules [Array>] Markov chain activity schedules for each occupant
+ # @return [Array, Array] Arrays containing clothes washer and dryer power draw schedules
+ def generate_clothes_washer_dryer_power_schedules(mkc_activity_schedules)
+ # Fill in cw and clothes dryer power schedule
+ # States are: 'sleeping', 'shower', 'laundry', 'cooking', 'dishwashing', 'absent', 'nothingAtHome'
+ cw_power_sch = [0] * @mins_in_year
+ cd_power_sch = [0] * @mins_in_year
+ step = 0
+ last_state = 0
+ start_time = Time.new(@sim_year, 1, 1)
+ clothes_dryer_monthly_multiplier = Schedule.validate_values(@schedules_csv_data[SchedulesFile::Columns[:ClothesDryer].name]['ClothesDryerMonthlyMultiplier'], 12, 'clothes_dryer_monthly_multiplier')
+ hot_water_clothes_washer_monthly_multiplier = Schedule.validate_values(@schedules_csv_data[SchedulesFile::Columns[:ClothesWasher].name]['HotWaterClothesWasherMonthlyMultiplier'], 12, 'hot_water_clothes_washer_monthly_multiplier')
+
+ while step < @mkc_steps_in_a_year
+ clothes_state = sum_across_occupants(mkc_activity_schedules, 2, step, max_clip: 1)
+ step_jump = 1
+ if (clothes_state > 0) && (last_state == 0) # last_state == 0 prevents consecutive washer power without gap
+ cw_duration_15min, cw_avg_power = sample_appliance_duration_power(@prngs[:clothes_washer], @appliance_power_dist_map, 'clothes_washer')
+ cd_duration_15min, cd_avg_power = sample_appliance_duration_power(@prngs[:clothes_dryer], @appliance_power_dist_map, 'clothes_dryer')
+
+ month = (start_time + step * 15 * 60).month
+ cd_duration_min = (cd_duration_15min * 15 * clothes_dryer_monthly_multiplier[month - 1]).to_i
+ cw_duration_min = (cw_duration_15min * 15 * hot_water_clothes_washer_monthly_multiplier[month - 1]).to_i
+
+ cw_duration = [cw_duration_min, @mins_in_year - step * 15].min
+ cw_power_sch.fill(cw_avg_power, step * 15, cw_duration)
+ cd_start_time = (step * 15 + cw_duration).to_i # clothes dryer starts immediately after washer ends\
+ cd_duration = [cd_duration_min, @mins_in_year - cd_start_time].min # cd_duration would be negative if cd_start_time > @mins_in_year, and no filling would occur
+ cd_power_sch = cd_power_sch.fill(cd_avg_power, cd_start_time, cd_duration)
+ step_jump = cw_duration_15min + cd_duration_15min
+ end
+ last_state = clothes_state
+ step += step_jump
end
- require 'csv'
- schedules_csv_data = {}
- CSV.foreach(schedules_csv, headers: true) do |row|
- schedule_name = row['Schedule Name']
- element = row['Element']
- values = row['Values']
+ return cw_power_sch, cd_power_sch
+ end
- schedules_csv_data[schedule_name] = {} if !schedules_csv_data.keys.include?(schedule_name)
- schedules_csv_data[schedule_name][element] = values
+ # Generate power schedule for cooking range based on occupant activities.
+ #
+ # @param mkc_activity_schedules [Array>] Markov chain activity schedules for each occupant
+ # @return [Array] Array containing cooking range power draw schedule
+ def generate_cooking_power_schedule(mkc_activity_schedules)
+ # Fill in cooking power schedule
+ # States are: 'sleeping', 'shower', 'laundry', 'cooking', 'dishwashing', 'absent', 'nothingAtHome'
+ cooking_power_sch = [0] * @mins_in_year
+ step = 0
+ last_state = 0
+ start_time = Time.new(@sim_year, 1, 1)
+ cooking_monthly_multiplier = Schedule.validate_values(@schedules_csv_data[SchedulesFile::Columns[:CookingRange].name]['CookingMonthlyMultiplier'], 12, 'cooking_monthly_multiplier')
+
+ while step < @mkc_steps_in_a_year
+ cooking_state = sum_across_occupants(mkc_activity_schedules, 3, step, max_clip: 1)
+ step_jump = 1
+ if (cooking_state > 0) && (last_state == 0) # last_state == 0 prevents consecutive cooking power without gap
+ duration_15min, avg_power = sample_appliance_duration_power(@prngs[:cooking], @appliance_power_dist_map, 'cooking')
+ month = (start_time + step * 15 * 60).month
+ duration_min = (duration_15min * 15 * cooking_monthly_multiplier[month - 1]).to_i
+ duration = [duration_min, @mins_in_year - step * 15].min
+ cooking_power_sch.fill(avg_power, step * 15, duration)
+ step_jump = duration_15min
+ end
+ last_state = cooking_state
+ step += step_jump
end
- return schedules_csv_data
+ return cooking_power_sch
+ end
+
+ # Apply random time shift and normalize schedule values.
+ #
+ # @param schedule [Array] Array of minute-level schedule values
+ # @param random_offset [Integer] Random offset in minutes to apply to the schedule
+ # @return [Array] Normalized schedule with random time shift applied
+ def random_shift_and_normalize(schedule, random_offset)
+ schedule = schedule.rotate(random_offset)
+
+ # Apply monthly offsets and aggregate
+ schedule = apply_monthly_offsets(array: schedule,
+ weekday_monthly_shift_dict: @weekday_monthly_shift_dict,
+ weekend_monthly_shift_dict: @weekend_monthly_shift_dict)
+ schedule = aggregate_array(schedule, @minutes_per_step)
+
+ return normalize(schedule)
end
end
diff --git a/BuildResidentialScheduleFile/tests/test_build_residential_schedule_file.rb b/BuildResidentialScheduleFile/tests/test_build_residential_schedule_file.rb
index 0ebd92e4e0..a7a46ddbb2 100644
--- a/BuildResidentialScheduleFile/tests/test_build_residential_schedule_file.rb
+++ b/BuildResidentialScheduleFile/tests/test_build_residential_schedule_file.rb
@@ -19,7 +19,6 @@ def setup
@args_hash = {}
@args_hash['hpxml_path'] = File.absolute_path(@tmp_hpxml_path)
@args_hash['hpxml_output_path'] = @args_hash['hpxml_path']
-
@year = 2007
@tol = 0.005
end
@@ -52,19 +51,20 @@ def test_stochastic
year: @year,
output_path: @tmp_schedule_file_path)
- assert_in_epsilon(6689, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:Occupants].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(2086, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:LightingInterior].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(2086, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:LightingGarage].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(534, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:CookingRange].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(213, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:Dishwasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(134, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ClothesWasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(151, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ClothesDryer].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(3016, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:CeilingFan].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(5388, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:PlugLoadsOther].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(1517, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:PlugLoadsTV].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(273, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterDishwasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(346, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterClothesWasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(887, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterFixtures].name, schedules: sf.tmp_schedules), @tol)
+ expected_values = {
+ Occupants: 6689,
+ LightingInterior: 2086,
+ CookingRange: 300.9,
+ Dishwasher: 161.5,
+ ClothesWasher: 67.7,
+ ClothesDryer: 114.0,
+ PlugLoadsOther: 5388,
+ PlugLoadsTV: 1517,
+ HotWaterDishwasher: 287.3,
+ HotWaterClothesWasher: 322.6,
+ HotWaterFixtures: 981.2,
+ }
+ assert_full_load_hrs_match(sf, expected_values, @tol)
assert(!sf.schedules.keys.include?(SchedulesFile::Columns[:Sleeping].name))
end
@@ -136,19 +136,20 @@ def test_stochastic_location_detailed
year: @year,
output_path: @tmp_schedule_file_path)
- assert_in_epsilon(6689, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:Occupants].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(1992, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:LightingInterior].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(1992, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:LightingGarage].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(534, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:CookingRange].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(213, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:Dishwasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(134, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ClothesWasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(151, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ClothesDryer].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(3016, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:CeilingFan].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(5388, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:PlugLoadsOther].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(1517, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:PlugLoadsTV].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(273, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterDishwasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(346, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterClothesWasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(887, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterFixtures].name, schedules: sf.tmp_schedules), @tol)
+ expected_values = {
+ Occupants: 6689,
+ LightingInterior: 1992,
+ CookingRange: 300.9,
+ Dishwasher: 161.5,
+ ClothesWasher: 67.7,
+ ClothesDryer: 114.0,
+ PlugLoadsOther: 5388,
+ PlugLoadsTV: 1517,
+ HotWaterDishwasher: 287.3,
+ HotWaterClothesWasher: 322.6,
+ HotWaterFixtures: 981.2,
+ }
+ assert_full_load_hrs_match(sf, expected_values, @tol)
assert(!sf.schedules.keys.include?(SchedulesFile::Columns[:Sleeping].name))
end
@@ -175,20 +176,22 @@ def test_stochastic_debug
year: @year,
output_path: @tmp_schedule_file_path)
- assert_in_epsilon(6689, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:Occupants].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(2086, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:LightingInterior].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(2086, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:LightingGarage].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(534, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:CookingRange].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(213, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:Dishwasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(134, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ClothesWasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(151, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ClothesDryer].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(3016, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:CeilingFan].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(5388, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:PlugLoadsOther].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(1517, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:PlugLoadsTV].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(273, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterDishwasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(346, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterClothesWasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(887, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterFixtures].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(3067, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:Sleeping].name, schedules: sf.tmp_schedules), @tol)
+ expected_values = {
+ Occupants: 6689,
+ LightingInterior: 2086,
+ CookingRange: 300.9,
+ Dishwasher: 161.5,
+ ClothesWasher: 67.7,
+ ClothesDryer: 114.0,
+ PlugLoadsOther: 5388,
+ PlugLoadsTV: 1517,
+ HotWaterDishwasher: 287.3,
+ HotWaterClothesWasher: 322.6,
+ HotWaterFixtures: 981.2,
+ Sleeping: 3067,
+ PresentOccupants: 46402,
+ }
+ assert_full_load_hrs_match(sf, expected_values, @tol)
end
def test_random_seed
@@ -213,21 +216,24 @@ def test_random_seed
sf = SchedulesFile.new(schedules_paths: hpxml.buildings[0].header.schedules_filepaths,
year: @year,
output_path: @tmp_schedule_file_path)
+ expected_values = {
+ Occupants: 6689,
+ LightingInterior: 2070,
+ CookingRange: 300,
+ Dishwasher: 161,
+ ClothesWasher: 64,
+ ClothesDryer: 113.9,
+ PlugLoadsOther: 5388,
+ PlugLoadsTV: 1517,
+ HotWaterDishwasher: 304,
+ HotWaterClothesWasher: 322,
+ HotWaterFixtures: 936,
+ }
+ assert_full_load_hrs_match(sf, expected_values, @tol)
- assert_in_epsilon(6689, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:Occupants].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(2070, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:LightingInterior].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(2070, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:LightingGarage].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(534, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:CookingRange].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(233, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:Dishwasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(134, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ClothesWasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(151, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ClothesDryer].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(3233, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:CeilingFan].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(5388, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:PlugLoadsOther].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(1517, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:PlugLoadsTV].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(288, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterDishwasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(320, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterClothesWasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(889, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterFixtures].name, schedules: sf.tmp_schedules), @tol)
assert(!sf.schedules.keys.include?(SchedulesFile::Columns[:Sleeping].name))
+ assert(!sf.schedules.keys.include?(SchedulesFile::Columns[:EVOccupant].name))
+ assert(!sf.schedules.keys.include?(SchedulesFile::Columns[:PresentOccupants].name))
@args_hash['schedules_random_seed'] = 2
hpxml, result = _test_measure()
@@ -246,21 +252,20 @@ def test_random_seed
sf = SchedulesFile.new(schedules_paths: hpxml.buildings[0].header.schedules_filepaths,
year: @year,
output_path: @tmp_schedule_file_path)
-
- assert_in_epsilon(6072, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:Occupants].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(1753, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:LightingInterior].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(1753, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:LightingGarage].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(356, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:CookingRange].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(174, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:Dishwasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(101, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ClothesWasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(166, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ClothesDryer].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(3276, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:CeilingFan].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(5292, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:PlugLoadsOther].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(1205, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:PlugLoadsTV].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(233, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterDishwasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(244, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterClothesWasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(1077, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterFixtures].name, schedules: sf.tmp_schedules), @tol)
- assert(!sf.schedules.keys.include?(SchedulesFile::Columns[:Sleeping].name))
+ expected_values = {
+ Occupants: 6072,
+ LightingInterior: 1753,
+ CookingRange: 336,
+ Dishwasher: 297,
+ ClothesWasher: 116,
+ ClothesDryer: 188,
+ PlugLoadsOther: 5292,
+ PlugLoadsTV: 1205,
+ HotWaterDishwasher: 243,
+ HotWaterClothesWasher: 263,
+ HotWaterFixtures: 1049,
+ }
+ assert_full_load_hrs_match(sf, expected_values, @tol)
end
def test_10_min_timestep
@@ -285,19 +290,20 @@ def test_10_min_timestep
year: @year,
output_path: @tmp_schedule_file_path)
- assert_in_epsilon(6707, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:Occupants].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(2077, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:LightingInterior].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(2077, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:LightingGarage].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(534, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:CookingRange].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(213, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:Dishwasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(105, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ClothesWasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(151, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ClothesDryer].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(3009, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:CeilingFan].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(5393, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:PlugLoadsOther].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(1505, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:PlugLoadsTV].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(146, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterDishwasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(154, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterClothesWasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(397, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterFixtures].name, schedules: sf.tmp_schedules), @tol)
+ expected_values = {
+ Occupants: 6707,
+ LightingInterior: 2077,
+ CookingRange: 300.9,
+ Dishwasher: 161.4,
+ ClothesWasher: 64.3,
+ ClothesDryer: 114.0,
+ PlugLoadsOther: 5393,
+ PlugLoadsTV: 1505,
+ HotWaterDishwasher: 155.9,
+ HotWaterClothesWasher: 138.4,
+ HotWaterFixtures: 280.2,
+ }
+ assert_full_load_hrs_match(sf, expected_values, @tol)
assert(!sf.schedules.keys.include?(SchedulesFile::Columns[:Sleeping].name))
end
@@ -332,6 +338,22 @@ def test_zero_occupants
assert_empty(hpxml.buildings[0].header.schedules_filepaths)
end
+ def test_ev_battery
+ num_occupants = 1.0
+
+ hpxml = _create_hpxml('base-vehicle-ev-charger.xml')
+ hpxml.buildings[0].building_occupancy.number_of_residents = num_occupants
+ XMLHelper.write_file(hpxml.to_doc, @tmp_hpxml_path)
+
+ @args_hash['output_csv_path'] = File.absolute_path(File.join(@tmp_output_path, 'occupancy-stochastic.csv'))
+ hpxml, _result = _test_measure()
+ sf = SchedulesFile.new(schedules_paths: hpxml.buildings[0].header.schedules_filepaths,
+ year: @year,
+ output_path: @tmp_schedule_file_path)
+ assert_in_epsilon(5890, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ElectricVehicleCharging].name, schedules: sf.tmp_schedules), @tol)
+ assert_in_epsilon(729.9, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ElectricVehicleDischarging].name, schedules: sf.tmp_schedules), @tol)
+ end
+
def test_multiple_buildings
hpxml = _create_hpxml('base-bldgtype-mf-whole-building.xml')
hpxml.buildings.each do |hpxml_bldg|
@@ -362,54 +384,51 @@ def test_multiple_buildings
if hpxml_bldg.building_id == 'MyBuilding'
assert_equal(1, hpxml_bldg.header.schedules_filepaths.size)
assert(hpxml_bldg.header.schedules_filepaths[0].include? 'occupancy-stochastic.csv')
- assert_in_epsilon(6689, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:Occupants].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(2086, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:LightingInterior].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(2086, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:LightingGarage].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(534, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:CookingRange].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(213, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:Dishwasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(134, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ClothesWasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(151, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ClothesDryer].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(3016, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:CeilingFan].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(5388, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:PlugLoadsOther].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(1517, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:PlugLoadsTV].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(273, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterDishwasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(346, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterClothesWasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(887, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterFixtures].name, schedules: sf.tmp_schedules), @tol)
- assert(!sf.schedules.keys.include?(SchedulesFile::Columns[:Sleeping].name))
+ expected_values = {
+ Occupants: 6689,
+ LightingInterior: 2086,
+ CookingRange: 300.9,
+ Dishwasher: 161.5,
+ ClothesWasher: 67.7,
+ PlugLoadsOther: 5388,
+ PlugLoadsTV: 1517,
+ HotWaterDishwasher: 287.3,
+ HotWaterClothesWasher: 322.6,
+ HotWaterFixtures: 981.2,
+ }
+ assert_full_load_hrs_match(sf, expected_values, @tol)
elsif hpxml_bldg.building_id == 'MyBuilding_2'
assert_equal(1, hpxml_bldg.header.schedules_filepaths.size)
assert(hpxml_bldg.header.schedules_filepaths[0].include? 'occupancy-stochastic_2.csv')
- assert_in_epsilon(6072, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:Occupants].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(1765, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:LightingInterior].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(1765, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:LightingGarage].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(356, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:CookingRange].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(165, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:Dishwasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(101, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ClothesWasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(166, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ClothesDryer].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(3103, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:CeilingFan].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(5292, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:PlugLoadsOther].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(1205, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:PlugLoadsTV].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(221, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterDishwasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(266, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterClothesWasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(894, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterFixtures].name, schedules: sf.tmp_schedules), @tol)
- assert(!sf.schedules.keys.include?(SchedulesFile::Columns[:Sleeping].name))
+ expected_values = {
+ Occupants: 6072,
+ LightingInterior: 1765,
+ CookingRange: 336.4,
+ Dishwasher: 297.4,
+ ClothesWasher: 116.3,
+ PlugLoadsOther: 5292,
+ PlugLoadsTV: 1205,
+ HotWaterDishwasher: 229.8,
+ HotWaterClothesWasher: 246.5,
+ HotWaterFixtures: 956.4,
+ }
+ assert_full_load_hrs_match(sf, expected_values, @tol)
elsif hpxml_bldg.building_id == 'MyBuilding_3'
assert_equal(1, hpxml_bldg.header.schedules_filepaths.size)
assert(hpxml_bldg.header.schedules_filepaths[0].include? 'occupancy-stochastic_3.csv')
- assert_in_epsilon(6045, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:Occupants].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(1745, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:LightingInterior].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(1745, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:LightingGarage].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(421, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:CookingRange].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(239, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:Dishwasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(81, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ClothesWasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(127, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ClothesDryer].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(3079, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:CeilingFan].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(5314, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:PlugLoadsOther].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(1162, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:PlugLoadsTV].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(224, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterDishwasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(209, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterClothesWasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(970, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterFixtures].name, schedules: sf.tmp_schedules), @tol)
- assert(!sf.schedules.keys.include?(SchedulesFile::Columns[:Sleeping].name))
+ expected_values = {
+ Occupants: 6045,
+ LightingInterior: 1745,
+ CookingRange: 358.5,
+ Dishwasher: 207.2,
+ ClothesWasher: 126.4,
+ PlugLoadsOther: 5314,
+ PlugLoadsTV: 1162,
+ HotWaterDishwasher: 232.1,
+ HotWaterClothesWasher: 206.8,
+ HotWaterFixtures: 857.1,
+ }
+ assert_full_load_hrs_match(sf, expected_values, @tol)
end
end
end
@@ -446,19 +465,19 @@ def test_multiple_buildings_id
assert_equal(1, hpxml_bldg.header.schedules_filepaths.size)
assert(hpxml_bldg.header.schedules_filepaths[0].include? 'occupancy-stochastic_2.csv')
- assert_in_epsilon(6072, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:Occupants].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(1765, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:LightingInterior].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(1765, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:LightingGarage].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(356, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:CookingRange].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(165, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:Dishwasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(101, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ClothesWasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(166, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:ClothesDryer].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(3103, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:CeilingFan].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(5292, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:PlugLoadsOther].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(1205, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:PlugLoadsTV].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(221, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterDishwasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(266, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterClothesWasher].name, schedules: sf.tmp_schedules), @tol)
- assert_in_epsilon(894, sf.annual_equivalent_full_load_hrs(col_name: SchedulesFile::Columns[:HotWaterFixtures].name, schedules: sf.tmp_schedules), @tol)
+ expected_values = {
+ Occupants: 6072,
+ LightingInterior: 1765,
+ CookingRange: 336.4,
+ Dishwasher: 297.4,
+ ClothesWasher: 116.3,
+ PlugLoadsOther: 5292,
+ PlugLoadsTV: 1205,
+ HotWaterDishwasher: 229.8,
+ HotWaterClothesWasher: 246.5,
+ HotWaterFixtures: 956.4,
+ }
+ assert_full_load_hrs_match(sf, expected_values, @tol)
assert(!sf.schedules.keys.include?(SchedulesFile::Columns[:Sleeping].name))
else
assert_empty(hpxml_bldg.header.schedules_filepaths)
@@ -477,12 +496,10 @@ def test_append_output
@args_hash['output_csv_path'] = @tmp_schedule_file_path
@args_hash['append_output'] = false
_test_measure()
-
assert(File.exist?(@tmp_schedule_file_path))
outdata = File.readlines(@tmp_schedule_file_path)
expected_cols = ScheduleGenerator.export_columns
- assert_equal(expected_cols, outdata[0].strip.split(',')) # Header
- assert_equal(expected_cols.size, outdata[1].split(',').size) # Data
+ assert((outdata[0].strip.split(',').to_set - expected_cols.to_set).empty?)
# Test w/ append_output=true
hpxml = _create_hpxml('base.xml')
@@ -494,9 +511,8 @@ def test_append_output
assert(File.exist?(@tmp_schedule_file_path))
outdata = File.readlines(@tmp_schedule_file_path)
- expected_cols = orig_cols + ScheduleGenerator.export_columns
- assert_equal(expected_cols, outdata[0].strip.split(',')) # Header
- assert_equal(expected_cols.size, outdata[1].split(',').size) # Data
+ expected_cols = ScheduleGenerator.export_columns
+ assert_equal(orig_cols.to_set, (outdata[0].strip.split(',').to_set - expected_cols.to_set)) # Header
# Test w/ append_output=true and inconsistent data
existing_csv_path = File.join(File.dirname(__FILE__), '..', '..', 'HPXMLtoOpenStudio', 'resources', 'schedule_files', 'setpoints-10-mins.csv')
@@ -554,4 +570,71 @@ def _test_measure(expect_fail: false)
def _create_hpxml(hpxml_name)
return HPXML.new(hpxml_path: File.join(@sample_files_path, hpxml_name))
end
+
+ def assert_full_load_hrs_match(sf, expected_values, tol)
+ mismatches = []
+ suggested_values = {}
+ missing_cols = []
+ schedule_col_names = []
+ cols_to_ignore = Set.new(['Vacancy', 'Power Outage', 'No Space Heating', 'No Space Cooling'])
+ expected_values.each do |col_name, expected_value|
+ unless SchedulesFile::Columns.key?(col_name.to_sym)
+ puts "Error: Column '#{col_name}' not found in SchedulesFile::Columns"
+ assert(false)
+ end
+ schedule_col_name = SchedulesFile::Columns[col_name.to_sym].name
+ schedule_col_names << schedule_col_name
+ if !sf.tmp_schedules.key?(schedule_col_name)
+ missing_cols << col_name
+ next
+ end
+ actual_value = sf.annual_equivalent_full_load_hrs(col_name: schedule_col_name, schedules: sf.tmp_schedules)
+
+ delta = tol * [actual_value.abs, expected_value.abs].min
+ diff = (actual_value - expected_value).abs
+ if diff > delta
+ mismatches << { col_name: col_name, expected_value: expected_value, actual_value: actual_value,
+ message: "Expected |#{expected_value} - #{actual_value}| (#{diff}) to be <= #{delta}" }
+ suggested_values[col_name] = "#{format('%.1f', actual_value)}"
+ else
+ suggested_values[col_name] = "#{expected_value}"
+ end
+ end
+ extra_cols = sf.tmp_schedules.keys.to_set - schedule_col_names.to_set - cols_to_ignore.to_set
+
+ unless (mismatches.empty? && missing_cols.empty? && extra_cols.empty?)
+ if !mismatches.empty?
+ puts "\nMismatches found:"
+ mismatches.each do |mismatch|
+ puts "#{mismatch[:col_name]}: #{mismatch[:message]}"
+ end
+ end
+
+ if !missing_cols.empty?
+ puts "\nMissing columns:"
+ missing_cols.each do |col_name|
+ puts " :#{col_name}"
+ end
+ end
+
+ if !extra_cols.empty?
+ puts "\nUnexpected columns found in the schedule file"
+ extra_cols.each do |col_name|
+ puts " :#{col_name}"
+ end
+ end
+
+ puts "\nTo fix this, you can update the expected values to match the actual values and columns:"
+ puts ' expected_values = {'
+ expected_values.keys.each do |col_name|
+ if missing_cols.include?(col_name)
+ next
+ end
+
+ puts " :#{col_name} => #{suggested_values[col_name]},"
+ end
+ puts ' }'
+ assert(false)
+ end
+ end
end
diff --git a/Changelog.md b/Changelog.md
index ef5b09b3b2..50c9584ec4 100644
--- a/Changelog.md
+++ b/Changelog.md
@@ -1,11 +1,24 @@
## OpenStudio-HPXML v1.10.0
__New Features__
+- Electric vehicle enhancements:
+ - Allows detailed modeling of electric vehicles (batteries and charging/discharging) using `Vehicles` as an alternative to the simple EV charging `PlugLoad`.
+ - Adds EV driving unmet hours output.
+- Allows requesting timeseries EnergyPlus output meters (e.g., `--hourly "MainsWater:Facility"`), similar to requesting EnergyPlus output variables.
+- BuildResidentialScheduleFile measure:
+ - Adds stochastic schedule generation for electric vehicle charging (using `Vehicles`).
+ - Removes generation of stochastic schedules for building components not present in the HPXML file.
+- Output updates:
+ - **Breaking change**: Adds generator electricity produced to *total* fuel/energy use; previously it was only included in *net* values.
+ - Adds new outputs for *net* peak electricity (summer/winter/annual); same as *total* peak electricity outputs but subtracts power produced by PV.
__Bugfixes__
- Fixes zero occupants specified for one unit in a whole MF building from being treated like zero occupants for every unit.
- Fixes using detailed schedules with higher resolution (e.g., 10-min data) than the simulation timestep (e.g., 60-min).
- Fixes possible heating/cooling spikes when using maximum power ratio detailed schedule for variable-speed HVAC systems.
+- Fixes unavailable periods for two consecutive, but partial, days.
+- Fixes error when specifying a glass block window without interior shading coefficients.
+- Fixes battery charging/discharging not being included in peak electricity outputs.
## OpenStudio-HPXML v1.9.1
diff --git a/HPXMLtoOpenStudio/measure.rb b/HPXMLtoOpenStudio/measure.rb
index 93bbd7cd54..0bfdb978c8 100644
--- a/HPXMLtoOpenStudio/measure.rb
+++ b/HPXMLtoOpenStudio/measure.rb
@@ -150,6 +150,7 @@ def run(model, runner, user_arguments)
Outputs.apply_ems_programs(model, hpxml_osm_map, hpxml.header, args[:add_component_loads])
Outputs.apply_output_file_controls(model, args[:debug])
Outputs.apply_additional_properties(model, hpxml, hpxml_osm_map, args[:hpxml_path], args[:building_id], args[:hpxml_defaults_path])
+ Outputs.create_custom_meters(model)
# Outputs.apply_ems_debug_output(model) # Uncomment to debug EMS
# Write output files
@@ -371,6 +372,7 @@ def create_unit_model(hpxml, hpxml_bldg, runner, model, epw_path, weather, sched
PV.apply(model, hpxml_bldg)
Generator.apply(model, hpxml_bldg)
Battery.apply(runner, model, spaces, hpxml_bldg, schedules_file)
+ Vehicle.apply(runner, model, spaces, hpxml_bldg, hpxml.header, schedules_file)
end
# Miscellaneous logic that needs to occur upfront.
@@ -396,11 +398,15 @@ def init(model, hpxml_bldg, hpxml_header)
hpxml_bldg.delete_adiabatic_subsurfaces() # EnergyPlus doesn't allow this
# Hidden feature: Version of the ANSI/RESNET/ICC 301 Standard to use for equations/assumptions
- if hpxml_header.eri_calculation_version.nil?
- hpxml_header.eri_calculation_version = 'latest'
+ if hpxml_header.eri_calculation_versions.size > 1
+ fail 'Only a single ERI version is supported.'
end
- if hpxml_header.eri_calculation_version == 'latest'
- hpxml_header.eri_calculation_version = Constants::ERIVersions[-1]
+
+ if hpxml_header.eri_calculation_versions.empty?
+ hpxml_header.eri_calculation_versions = ['latest']
+ end
+ if hpxml_header.eri_calculation_versions == ['latest']
+ hpxml_header.eri_calculation_versions = [Constants::ERIVersions[-1]]
end
# Hidden feature: Whether to override certain assumptions to better match the ASHRAE 140 specification
diff --git a/HPXMLtoOpenStudio/measure.xml b/HPXMLtoOpenStudio/measure.xml
index ca25d5c3df..44fb042603 100644
--- a/HPXMLtoOpenStudio/measure.xml
+++ b/HPXMLtoOpenStudio/measure.xml
@@ -3,8 +3,8 @@
3.1
hpxm_lto_openstudio
b1543b30-9465-45ff-ba04-1d1f85e763bc
- 3ea49029-4568-4711-a340-03037e25c017
- 2025-01-30T04:54:11Z
+ 1b99b3c9-d02a-4d70-ad5f-5a7d5b254398
+ 2025-02-27T17:59:16Z
D8922A73
HPXMLtoOpenStudio
HPXML to OpenStudio Translator
@@ -183,19 +183,19 @@
measure.rb
rb
script
- 28965567
+ 34B61ECA
airflow.rb
rb
resource
- 29D991BE
+ 23B7B4AC
battery.rb
rb
resource
- 3062E4E6
+ 19BFE868
calendar.rb
@@ -207,7 +207,7 @@
constants.rb
rb
resource
- 22E067E1
+ 1382D07B
constructions.rb
@@ -261,7 +261,7 @@
data/default_schedules.csv
csv
resource
- BF708670
+ CDD2DA76
data/g_functions/C_configurations_5m_v1.0.json
@@ -315,7 +315,7 @@
data/unavailable_periods.csv
csv
resource
- EC394126
+ 3FBE7B42
data/zipcode_weather_stations.csv
@@ -327,7 +327,7 @@
defaults.rb
rb
resource
- EE5FDB35
+ ED7C0B11
energyplus.rb
@@ -339,7 +339,7 @@
generator.rb
rb
resource
- 8159FC55
+ 6C50CF5E
geometry.rb
@@ -351,19 +351,19 @@
hotwater_appliances.rb
rb
resource
- 0B205523
+ FA4DA1B3
hpxml.rb
rb
resource
- 270F2EEB
+ 6923DA1E
hpxml_schema/HPXML.xsd
xsd
resource
- CB97DDA1
+ E36727BB
hpxml_schema/README.md
@@ -375,7 +375,7 @@
hpxml_schematron/EPvalidator.xml
xml
resource
- 105F837D
+ 6D661DE4
hpxml_schematron/iso-schematron.xsd
@@ -405,7 +405,7 @@
lighting.rb
rb
resource
- 7B7F6D4C
+ 74899E6B
location.rb
@@ -441,7 +441,7 @@
misc_loads.rb
rb
resource
- F66475DC
+ 78E80650
model.rb
@@ -453,7 +453,7 @@
output.rb
rb
resource
- 573B31F4
+ 2824DDC1
psychrometrics.rb
@@ -465,7 +465,7 @@
pv.rb
rb
resource
- F8E8DDDD
+ C2C1C9BA
schedule_files/README.md
@@ -489,55 +489,67 @@
schedule_files/occupancy-non-stochastic.csv
csv
resource
- A54803E1
+ FA81E518
schedule_files/occupancy-stochastic-10-mins.csv
csv
resource
- F88479B3
+ D9B181A4
schedule_files/occupancy-stochastic-30-mins.csv
csv
resource
- F88479B3
+ D9B181A4
- schedule_files/occupancy-stochastic.csv
+ schedule_files/occupancy-stochastic-ev-charger.csv
+ csv
+ resource
+ 188BC7F1
+
+
+ schedule_files/occupancy-stochastic-mf-unit.csv
csv
resource
- B0187567
+ 308CB2EE
- schedule_files/occupancy-stochastic_2.csv
+ schedule_files/occupancy-stochastic-mf-unit_2.csv
csv
resource
- 86E85543
+ DB7B62B3
- schedule_files/occupancy-stochastic_3.csv
+ schedule_files/occupancy-stochastic-mf-unit_3.csv
csv
resource
- 902A544E
+ 7452D495
- schedule_files/occupancy-stochastic_4.csv
+ schedule_files/occupancy-stochastic-mf-unit_4.csv
csv
resource
- 3A0C7E92
+ AEB1502E
- schedule_files/occupancy-stochastic_5.csv
+ schedule_files/occupancy-stochastic-mf-unit_5.csv
csv
resource
- F0FB0913
+ D10757F1
- schedule_files/occupancy-stochastic_6.csv
+ schedule_files/occupancy-stochastic-mf-unit_6.csv
csv
resource
- B071AE65
+ 9B96E690
+
+
+ schedule_files/occupancy-stochastic.csv
+ csv
+ resource
+ 703EC57D
schedule_files/setpoints-10-mins.csv
@@ -575,6 +587,18 @@
resource
706A63BC
+
+ schedule_files/vehicle-ev-undercharged.csv
+ csv
+ resource
+ 692A61D6
+
+
+ schedule_files/vehicle-ev.csv
+ csv
+ resource
+ 264EFE70
+
schedule_files/water-heater-operating-modes.csv
csv
@@ -597,7 +621,7 @@
schedules.rb
rb
resource
- 467EB413
+ 7E83A486
simcontrols.rb
@@ -623,6 +647,12 @@
resource
C87C3553
+
+ vehicle.rb
+ rb
+ resource
+ D6349216
+
version.rb
rb
@@ -633,7 +663,7 @@
waterheater.rb
rb
resource
- ECEBF85F
+ A8560A5A
weather.rb
@@ -653,6 +683,12 @@
resource
93120E27
+
+ results_design_load_details.json
+ json
+ test
+ 4578819C
+
test_airflow.rb
rb
@@ -663,13 +699,13 @@
test_battery.rb
rb
test
- E8640271
+ C45ECC20
test_defaults.rb
rb
test
- 7E9FC2FA
+ 3BF1E52A
test_enclosure.rb
@@ -693,7 +729,7 @@
test_hvac.rb
rb
test
- 01F47953
+ 6BFD956C
test_hvac_sizing.rb
@@ -717,7 +753,7 @@
test_miscloads.rb
rb
test
- 4E0D3190
+ AF74F5D9
test_pv.rb
@@ -729,7 +765,7 @@
test_schedules.rb
rb
test
- BDA04315
+ 67722FDB
test_simcontrols.rb
@@ -741,7 +777,13 @@
test_validation.rb
rb
test
- 55A49170
+ 3D2FFDAD
+
+
+ test_vehicle.rb
+ rb
+ test
+ F29DE25D
test_water_heater.rb
diff --git a/HPXMLtoOpenStudio/resources/airflow.rb b/HPXMLtoOpenStudio/resources/airflow.rb
index 4646118e59..379260d5f0 100644
--- a/HPXMLtoOpenStudio/resources/airflow.rb
+++ b/HPXMLtoOpenStudio/resources/airflow.rb
@@ -550,8 +550,8 @@ def self.apply_natural_ventilation_and_whole_house_fan(runner, model, spaces, hp
vent_program.addLine("Set Tnvsp = (#{htg_sp_sensor.name} + #{clg_sp_sensor.name}) / 2")
else
# No HVAC system; use the average of defaulted heating/cooling setpoints.
- htg_weekday_setpoints, htg_weekend_setpoints = Defaults.get_heating_setpoint(HPXML::HVACControlTypeManual, hpxml_header.eri_calculation_version)
- clg_weekday_setpoints, clg_weekend_setpoints = Defaults.get_cooling_setpoint(HPXML::HVACControlTypeManual, hpxml_header.eri_calculation_version)
+ htg_weekday_setpoints, htg_weekend_setpoints = Defaults.get_heating_setpoint(HPXML::HVACControlTypeManual, hpxml_header.eri_calculation_versions[0])
+ clg_weekday_setpoints, clg_weekend_setpoints = Defaults.get_cooling_setpoint(HPXML::HVACControlTypeManual, hpxml_header.eri_calculation_versions[0])
if htg_weekday_setpoints.split(', ').uniq.size == 1 && htg_weekend_setpoints.split(', ').uniq.size == 1 && htg_weekday_setpoints.split(', ').uniq == htg_weekend_setpoints.split(', ').uniq
default_htg_sp = UnitConversions.convert(htg_weekend_setpoints.split(', ').uniq[0].to_f, 'F', 'C')
else
@@ -2391,14 +2391,14 @@ def self.apply_infiltration_adjustment_to_conditioned(runner, model, spaces, hpx
infil_program.addLine('Set Qfan_with_ducts = (@Max Qexhaust Qsupply)')
# Total combined air exchange
- if Constants::ERIVersions.index(hpxml_header.eri_calculation_version) >= Constants::ERIVersions.index('2022')
+ if Constants::ERIVersions.index(hpxml_header.eri_calculation_versions[0]) >= Constants::ERIVersions.index('2022')
infil_program.addLine('Set Qimb = (@Abs (Qsupply - Qexhaust))')
infil_program.addLine('If Qinf + Qimb > 0')
infil_program.addLine(' Set Qtot = Qfan_with_ducts + (Qinf^2) / (Qinf + Qimb)')
infil_program.addLine('Else')
infil_program.addLine(' Set Qtot = Qfan_with_ducts')
infil_program.addLine('EndIf')
- elsif Constants::ERIVersions.index(hpxml_header.eri_calculation_version) >= Constants::ERIVersions.index('2019')
+ elsif Constants::ERIVersions.index(hpxml_header.eri_calculation_versions[0]) >= Constants::ERIVersions.index('2019')
# Follow ASHRAE 62.2-2016, Normative Appendix C equations for time-varying total airflow
infil_program.addLine('If Qfan_with_ducts > 0')
# Balanced system if the total supply airflow and total exhaust airflow are within 10% of their average.
diff --git a/HPXMLtoOpenStudio/resources/battery.rb b/HPXMLtoOpenStudio/resources/battery.rb
index 9e52b228a7..9c0fa00714 100644
--- a/HPXMLtoOpenStudio/resources/battery.rb
+++ b/HPXMLtoOpenStudio/resources/battery.rb
@@ -11,48 +11,49 @@ module Battery
# @param schedules_file [SchedulesFile] SchedulesFile wrapper class instance of detailed schedule files
# @return [nil]
def self.apply(runner, model, spaces, hpxml_bldg, schedules_file)
+ charging_schedule, discharging_schedule = nil, nil
+ if not schedules_file.nil?
+ charging_schedule = schedules_file.create_schedule_file(model, col_name: SchedulesFile::Columns[:BatteryCharging].name)
+ discharging_schedule = schedules_file.create_schedule_file(model, col_name: SchedulesFile::Columns[:BatteryDischarging].name)
+ end
hpxml_bldg.batteries.each do |battery|
- apply_battery(runner, model, spaces, hpxml_bldg, battery, schedules_file)
+ apply_battery(runner, model, spaces, hpxml_bldg, battery, charging_schedule, discharging_schedule)
end
end
# Add the HPXML Battery to the OpenStudio model.
#
- # Apply a home battery to the model using OpenStudio ElectricLoadCenterStorageLiIonNMCBattery, ElectricLoadCenterDistribution, ElectricLoadCenterStorageConverter, OtherEquipment, and EMS objects.
- # Battery without PV specified, and no charging/discharging schedule provided; battery is assumed to operate as backup and will not be modeled.
- # The system may be shared, in which case nominal/usable capacity (kWh) and usable fraction are apportioned to the dwelling unit by total number of bedrooms served.
- # A battery may share an ElectricLoadCenterDistribution object with PV; electric buss type and storage operation scheme are therefore changed.
+ # Apply a home battery or EV battery to the model using OpenStudio ElectricLoadCenterStorageLiIonNMCBattery, ElectricLoadCenterDistribution, ElectricLoadCenterStorageConverter, OtherEquipment, and EMS objects.
+ # Home battery without PV specified, and no charging/discharging schedule provided; battery is assumed to operate as backup and will not be modeled.
+ # Home battery systems may be shared, in which case nominal/usable capacity (kWh) and usable fraction are apportioned to the dwelling unit by total number of bedrooms served.
+ # A home battery may share an ElectricLoadCenterDistribution object with PV; electric buss type and storage operation scheme are therefore changed.
# Round trip efficiency is (temporarily) applied as an EMS program b/c E+ input is not hooked up.
#
# @param runner [OpenStudio::Measure::OSRunner] Object typically used to display warnings
# @param model [OpenStudio::Model::Model] OpenStudio Model object
# @param spaces [Hash] Map of HPXML locations => OpenStudio Space objects
# @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
- # @param battery [HPXML::Battery] Object that defines a single home battery
- # @param schedules_file [SchedulesFile] SchedulesFile wrapper class instance of detailed schedule files
- # @return [nil] for unscheduled battery w/out PV; in this case battery is not modeled
- def self.apply_battery(runner, model, spaces, hpxml_bldg, battery, schedules_file)
+ # @param battery [HPXML::Battery, HPXML::Vehicle] Object that defines a single home battery or EV battery
+ # @param charging_schedule [OpenStudio::Model::ScheduleXXX] The battery charging schedule
+ # @param discharging_schedule [OpenStudio::Model::ScheduleXXX] The battery discharging schedule
+ # @return [nil]
+ def self.apply_battery(runner, model, spaces, hpxml_bldg, battery, charging_schedule, discharging_schedule)
nbeds = hpxml_bldg.building_construction.number_of_bedrooms
unit_multiplier = hpxml_bldg.building_construction.number_of_units
pv_systems = hpxml_bldg.pv_systems
+ is_ev = battery.is_a?(HPXML::Vehicle)
- charging_schedule = nil
- discharging_schedule = nil
- if not schedules_file.nil?
- charging_schedule = schedules_file.create_schedule_file(model, col_name: SchedulesFile::Columns[:BatteryCharging].name)
- discharging_schedule = schedules_file.create_schedule_file(model, col_name: SchedulesFile::Columns[:BatteryDischarging].name)
- end
-
- if pv_systems.empty? && charging_schedule.nil? && discharging_schedule.nil?
+ if !is_ev && pv_systems.empty? && charging_schedule.nil? && discharging_schedule.nil?
runner.registerWarning('Battery without PV specified, and no charging/discharging schedule provided; battery is assumed to operate as backup and will not be modeled.')
return
end
obj_name = battery.id
+ location = (is_ev ? battery.additional_properties.location : battery.location)
+ rated_power_output = (is_ev ? battery.additional_properties.rated_power_output : battery.rated_power_output) # W
- space = Geometry.get_space_from_location(battery.location, spaces)
+ space = Geometry.get_space_from_location(location, spaces)
- rated_power_output = battery.rated_power_output # W
if not battery.nominal_capacity_kwh.nil?
if battery.usable_capacity_kwh.nil?
fail "UsableCapacity and NominalCapacity for Battery '#{battery.id}' must be in the same units."
@@ -73,7 +74,7 @@ def self.apply_battery(runner, model, spaces, hpxml_bldg, battery, schedules_fil
return if rated_power_output <= 0 || nominal_capacity_kwh <= 0 || battery.nominal_voltage <= 0
- if battery.is_shared_system
+ if !is_ev && battery.is_shared_system
# Apportion to single dwelling unit by # bedrooms
fail if battery.number_of_bedrooms_served.to_f <= nbeds.to_f # EPvalidator.xml should prevent this
@@ -82,12 +83,15 @@ def self.apply_battery(runner, model, spaces, hpxml_bldg, battery, schedules_fil
rated_power_output = rated_power_output * nbeds.to_f / battery.number_of_bedrooms_served.to_f
end
+ charging_power = (is_ev ? battery.ev_charger.charging_power : rated_power_output)
+
nominal_capacity_kwh *= unit_multiplier
usable_capacity_kwh *= unit_multiplier
rated_power_output *= unit_multiplier
+ charging_power *= unit_multiplier
- is_outside = (battery.location == HPXML::LocationOutside)
- if not is_outside
+ is_outside = (location == HPXML::LocationOutside)
+ if !is_outside && !is_ev
frac_sens = 1.0
else # Internal gains outside unit
frac_sens = 0.0
@@ -122,9 +126,7 @@ def self.apply_battery(runner, model, spaces, hpxml_bldg, battery, schedules_fil
elcs.setLifetimeModel(HPXML::BatteryLifetimeModelNone)
elcs.setNumberofCellsinSeries(number_of_cells_in_series)
elcs.setNumberofStringsinParallel(number_of_strings_in_parallel)
- elcs.setInitialFractionalStateofCharge(0.0)
elcs.setBatteryMass(battery_mass)
- elcs.setDCtoDCChargingEfficiency(battery.round_trip_efficiency) # Note: This is currently unused in E+, so we use an EMS program below instead
elcs.setBatterySurfaceArea(battery_surface_area)
elcs.setDefaultNominalCellVoltage(default_nominal_cell_voltage)
elcs.setFullyChargedCellCapacity(default_cell_capacity)
@@ -137,25 +139,41 @@ def self.apply_battery(runner, model, spaces, hpxml_bldg, battery, schedules_fil
end
elcs.setFullyChargedCellVoltage(default_nominal_cell_voltage)
elcs.setCellVoltageatEndofExponentialZone(default_nominal_cell_voltage)
+ if is_ev
+ elcs.additionalProperties.setFeature('ObjectType', Constants::ObjectTypeVehicle)
+ else
+ elcs.additionalProperties.setFeature('ObjectType', Constants::ObjectTypeBattery)
+ end
- elcds = model.getElectricLoadCenterDistributions
- elcds = elcds.select { |elcd| elcd.inverter.is_initialized } # i.e., not generators
- if elcds.empty?
+ if is_ev
+ elcs.setDCtoDCChargingEfficiency(1.0) # Charging efficiency is captured in the ev_discharge_program
+ # EVs always get their own ELCD, not PV
elcd = OpenStudio::Model::ElectricLoadCenterDistribution.new(model)
- elcd.setName('Battery elec load center dist')
+ elcd.setName("#{obj_name} elec load center dist")
elcd.setElectricalBussType('AlternatingCurrentWithStorage')
+ elcs.setInitialFractionalStateofCharge(maximum_storage_state_of_charge_fraction)
else
- elcd = elcds[0] # i.e., pv
-
- elcd.setElectricalBussType('DirectCurrentWithInverterACStorage')
- elcd.setStorageOperationScheme('TrackFacilityElectricDemandStoreExcessOnSite')
+ elcs.setDCtoDCChargingEfficiency(battery.round_trip_efficiency) # Note: This is currently unused in E+, so we use an EMS program below instead
+ elcs.setInitialFractionalStateofCharge(0.0)
+ elcds = model.getElectricLoadCenterDistributions
+ elcds = elcds.select { |elcd| elcd.inverter.is_initialized } # i.e., not generators
+ # Use PV ELCD if present
+ elcd = elcds.find { |elcd| elcd.name.to_s.include?('PVSystem') }
+ if elcd
+ elcd.setElectricalBussType('DirectCurrentWithInverterACStorage')
+ elcd.setStorageOperationScheme('TrackFacilityElectricDemandStoreExcessOnSite')
+ else
+ elcd = OpenStudio::Model::ElectricLoadCenterDistribution.new(model)
+ elcd.setName("#{obj_name} elec load center dist")
+ elcd.setElectricalBussType('AlternatingCurrentWithStorage')
+ end
end
elcd.setMinimumStorageStateofChargeFraction(minimum_storage_state_of_charge_fraction)
elcd.setMaximumStorageStateofChargeFraction(maximum_storage_state_of_charge_fraction)
elcd.setElectricalStorage(elcs)
elcd.setDesignStorageControlDischargePower(rated_power_output)
- elcd.setDesignStorageControlChargePower(rated_power_output)
+ elcd.setDesignStorageControlChargePower(charging_power)
if (not charging_schedule.nil?) && (not discharging_schedule.nil?)
elcd.setStorageOperationScheme('TrackChargeDischargeSchedules')
@@ -174,6 +192,13 @@ def self.apply_battery(runner, model, spaces, hpxml_bldg, battery, schedules_fil
frac_lost = 1.0
end
+ elcd.additionalProperties.setFeature('HPXML_ID', battery.id)
+ elcs.additionalProperties.setFeature('HPXML_ID', battery.id)
+ elcs.additionalProperties.setFeature('UsableCapacity_kWh', Float(usable_capacity_kwh))
+
+ # Power discharge curve in the ev_discharge_program handles all EV losses
+ return if is_ev
+
# Apply round trip efficiency as EMS program b/c E+ input is not hooked up.
# Replace this when the first item in https://github.com/NREL/EnergyPlus/issues/9176 is fixed.
charge_sensor = Model.add_ems_sensor(
@@ -225,10 +250,6 @@ def self.apply_battery(runner, model, spaces, hpxml_bldg, battery, schedules_fil
calling_point: 'EndOfSystemTimestepBeforeHVACReporting',
ems_programs: [battery_losses_program]
)
-
- elcd.additionalProperties.setFeature('HPXML_ID', battery.id)
- elcs.additionalProperties.setFeature('HPXML_ID', battery.id)
- elcs.additionalProperties.setFeature('UsableCapacity_kWh', Float(usable_capacity_kwh))
end
# Get nominal capacity (amp-hours) from nominal capacity (kWh) and voltage (V).
diff --git a/HPXMLtoOpenStudio/resources/constants.rb b/HPXMLtoOpenStudio/resources/constants.rb
index eb1528a7cf..e2dc9d5be1 100644
--- a/HPXMLtoOpenStudio/resources/constants.rb
+++ b/HPXMLtoOpenStudio/resources/constants.rb
@@ -10,6 +10,8 @@ module Constants
# Object types
ObjectTypeAirSourceHeatPump = 'air source heat pump'
ObjectTypeBackupSuppHeat = 'back up supp heat'
+ ObjectTypeBEVDischargeProgram = 'bev discharge program'
+ ObjectTypeBattery = 'battery'
ObjectTypeBatteryLossesAdjustment = 'battery losses adjustment'
ObjectTypeBoiler = 'boiler'
ObjectTypeCeilingFan = 'ceiling fan'
@@ -34,6 +36,7 @@ module Constants
ObjectTypeGeneralWaterUse = 'general water use'
ObjectTypeGeneralWaterUseLatent = 'general water use latent'
ObjectTypeGeneralWaterUseSensible = 'general water use sensible'
+ ObjectTypeGenerator = 'generator'
ObjectTypeGroundSourceHeatPump = 'ground source heat pump'
ObjectTypeGSHPSharedPump = 'gshp shared loop pump'
ObjectTypeHotWaterRecircPump = 'dhw recirc pump'
@@ -68,6 +71,7 @@ module Constants
ObjectTypeNaturalVentilation = 'natural vent'
ObjectTypeNeighbors = 'neighbors'
ObjectTypeOccupants = 'occupants'
+ ObjectTypePhotovoltaics = 'photovoltaics'
ObjectTypePTAC = 'packaged terminal air conditioner'
ObjectTypePTHP = 'packaged terminal heat pump'
ObjectTypeRefrigerator = 'fridge'
@@ -78,6 +82,7 @@ module Constants
ObjectTypeTotalLoadsProgram = 'total loads program'
ObjectTypeUnitHeater = 'unit heater'
ObjectTypeUnmetHoursProgram = 'unmet hours program'
+ ObjectTypeVehicle = 'vehicle'
ObjectTypeWaterHeater = 'water heater'
ObjectTypeWaterHeaterSetpoint = 'water heater setpoint'
ObjectTypeWaterHeaterAdjustment = 'water heater energy adjustment'
@@ -248,6 +253,7 @@ module CLT
module UHT
Heating = 'Heating'
Cooling = 'Cooling'
+ Driving = 'EV Driving'
end
# Resilience Types (Constants for output reporting)
diff --git a/HPXMLtoOpenStudio/resources/data/default_schedules.csv b/HPXMLtoOpenStudio/resources/data/default_schedules.csv
index e08c04f96b..f4bb919e69 100644
--- a/HPXMLtoOpenStudio/resources/data/default_schedules.csv
+++ b/HPXMLtoOpenStudio/resources/data/default_schedules.csv
@@ -46,12 +46,12 @@ ceiling_fan,WeekendScheduleFractions,"0.057, 0.057, 0.057, 0.057, 0.057, 0.057,
plug_loads_other,WeekdayScheduleFractions,"0.036, 0.036, 0.036, 0.036, 0.036, 0.036, 0.038, 0.041, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.044, 0.047, 0.050, 0.051, 0.050, 0.048, 0.044, 0.040, 0.037",Table C.3(1) of ANSI/RESNET/ICC 301-2022 Addendum C
plug_loads_other,WeekendScheduleFractions,"0.036, 0.036, 0.036, 0.036, 0.036, 0.036, 0.038, 0.041, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.044, 0.047, 0.050, 0.051, 0.050, 0.048, 0.044, 0.040, 0.037",Table C.3(1) of ANSI/RESNET/ICC 301-2022 Addendum C
plug_loads_other,MonthlyScheduleMultipliers,"1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0",
+plug_loads_vehicle,WeekdayScheduleFractions,"0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 1.0, 1.0, 0.0, 0.0, 0.0, 0.0",
+plug_loads_vehicle,WeekendScheduleFractions,"0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 1.0, 0.5, 0.0, 0.0, 0.0, 0.0, 0.0",
+plug_loads_vehicle,MonthlyScheduleMultipliers,"1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0",
plug_loads_tv,WeekdayScheduleFractions,"0.014, 0.007, 0.004, 0.003, 0.004, 0.006, 0.010, 0.015, 0.020, 0.025, 0.028, 0.031, 0.033, 0.038, 0.042, 0.046, 0.054, 0.062, 0.080, 0.110, 0.132, 0.125, 0.077, 0.034",Table C.3(1) of ANSI/RESNET/ICC 301-2022 Addendum C
plug_loads_tv,WeekendScheduleFractions,"0.014, 0.007, 0.004, 0.003, 0.004, 0.006, 0.010, 0.015, 0.020, 0.025, 0.028, 0.031, 0.033, 0.038, 0.042, 0.046, 0.054, 0.062, 0.080, 0.110, 0.132, 0.125, 0.077, 0.034",Table C.3(1) of ANSI/RESNET/ICC 301-2022 Addendum C
plug_loads_tv,MonthlyScheduleMultipliers,"1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0",
-plug_loads_vehicle,WeekdayScheduleFractions,"0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042",
-plug_loads_vehicle,WeekendScheduleFractions,"0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042, 0.042",
-plug_loads_vehicle,MonthlyScheduleMultipliers,"1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0",
plug_loads_well_pump,WeekdayScheduleFractions,"0.044, 0.023, 0.019, 0.015, 0.016, 0.018, 0.026, 0.033, 0.033, 0.032, 0.033, 0.033, 0.032, 0.032, 0.032, 0.033, 0.045, 0.057, 0.066, 0.076, 0.081, 0.086, 0.075, 0.065",Figure 23 of the `2010 BAHSP `_
plug_loads_well_pump,WeekendScheduleFractions,"0.044, 0.023, 0.019, 0.015, 0.016, 0.018, 0.026, 0.033, 0.033, 0.032, 0.033, 0.033, 0.032, 0.032, 0.032, 0.033, 0.045, 0.057, 0.066, 0.076, 0.081, 0.086, 0.075, 0.065",Figure 23 of the `2010 BAHSP `_
plug_loads_well_pump,MonthlyScheduleMultipliers,"1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0",
@@ -86,3 +86,6 @@ hot_water_recirculation_pump_demand_control,RecirculationPumpWeekendScheduleFrac
hot_water_recirculation_pump_temperature_control,RecirculationPumpWeekdayScheduleFractions,"0.067, 0.072, 0.074, 0.073, 0.069, 0.048, 0.011, 0.003, 0.009, 0.020, 0.030, 0.037, 0.043, 0.047, 0.050, 0.051, 0.044, 0.034, 0.026, 0.026, 0.030, 0.036, 0.045, 0.055",Table C.3(5) of ANSI/RESNET/ICC 301-2022 Addendum C
hot_water_recirculation_pump_temperature_control,RecirculationPumpWeekendScheduleFractions,"0.067, 0.072, 0.074, 0.073, 0.069, 0.048, 0.011, 0.003, 0.009, 0.020, 0.030, 0.037, 0.043, 0.047, 0.050, 0.051, 0.044, 0.034, 0.026, 0.026, 0.030, 0.036, 0.045, 0.055",Table C.3(5) of ANSI/RESNET/ICC 301-2022 Addendum C
hot_water_recirculation_pump,RecirculationPumpMonthlyScheduleMultipliers,"1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0",
+electric_vehicle,WeekdayScheduleFractions,"0.0714, 0.0714, 0.0714, 0.0714, 0.0714, 0.0714, 0.0714, -0.3535, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, -0.3221, -0.3244, 0.0714, 0.0714, 0.0714, 0.0714, 0.0714, 0.0714, 0.0714",
+electric_vehicle,WeekendScheduleFractions,"0.0588, 0.0588, 0.0588, 0.0588, 0.0588, 0.0588, 0.0588, 0.0588, 0.0588, -0.3334, 0, 0, 0, 0, -0.3293, -0.3372, 0.0588, 0.0588, 0.0588, 0.0588, 0.0588, 0.0588, 0.0588, 0.0588",
+electric_vehicle,MonthlyScheduleMultipliers,"1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0, 1.0",
diff --git a/HPXMLtoOpenStudio/resources/data/unavailable_periods.csv b/HPXMLtoOpenStudio/resources/data/unavailable_periods.csv
index 4d20ab98cc..c2cf2e6354 100644
--- a/HPXMLtoOpenStudio/resources/data/unavailable_periods.csv
+++ b/HPXMLtoOpenStudio/resources/data/unavailable_periods.csv
@@ -36,3 +36,5 @@ bath_fan,1,1,0,0
whole_house_fan,0,1,0,0
battery_charging,0,1,0,0
battery_discharging,0,1,0,0
+electric_vehicle_charging,0,1,0,0
+electric_vehicle_discharging,0,1,0,0
diff --git a/HPXMLtoOpenStudio/resources/defaults.rb b/HPXMLtoOpenStudio/resources/defaults.rb
index 33b48a5dca..dd3f218d31 100644
--- a/HPXMLtoOpenStudio/resources/defaults.rb
+++ b/HPXMLtoOpenStudio/resources/defaults.rb
@@ -27,9 +27,10 @@ module Defaults
# @param convert_shared_systems [Boolean] Whether to convert shared systems to equivalent in-unit systems per ANSI/RESNET/ICC 301
# @return [Array] Maps of HPXML::Zones => DesignLoadValues object, HPXML::Spaces => DesignLoadValues object
def self.apply(runner, hpxml, hpxml_bldg, weather, schedules_file: nil, convert_shared_systems: true)
- eri_version = hpxml.header.eri_calculation_version
- if eri_version.nil?
+ if hpxml.header.eri_calculation_versions.nil? || hpxml.header.eri_calculation_versions.empty?
eri_version = 'latest'
+ else
+ eri_version = hpxml.header.eri_calculation_versions[0]
end
if eri_version == 'latest'
eri_version = Constants::ERIVersions[-1]
@@ -92,6 +93,7 @@ def self.apply(runner, hpxml, hpxml_bldg, weather, schedules_file: nil, convert_
apply_pv_systems(hpxml_bldg)
apply_generators(hpxml_bldg)
apply_batteries(hpxml_bldg)
+ apply_vehicles(hpxml_bldg, schedules_file)
# Do HVAC sizing after all other defaults have been applied
all_zone_loads, all_space_loads = apply_hvac_sizing(runner, hpxml_bldg, weather)
@@ -1511,34 +1513,36 @@ def self.apply_windows(hpxml_bldg, eri_version)
hpxml_bldg.windows.each do |window|
if window.ufactor.nil? || window.shgc.nil?
- # Frame/Glass provided instead, fill in more defaults as needed
- if window.glass_type.nil?
- window.glass_type = HPXML::WindowGlassTypeClear
- window.glass_type_isdefaulted = true
- end
- if window.thermal_break.nil? && [HPXML::WindowFrameTypeAluminum, HPXML::WindowFrameTypeMetal].include?(window.frame_type)
- if window.glass_layers == HPXML::WindowLayersSinglePane
- window.thermal_break = false
- window.thermal_break_isdefaulted = true
- elsif window.glass_layers == HPXML::WindowLayersDoublePane
- window.thermal_break = true
- window.thermal_break_isdefaulted = true
+ if window.glass_layers != HPXML::WindowLayersGlassBlock
+ # Frame/Glass provided instead, fill in more defaults as needed
+ if window.glass_type.nil?
+ window.glass_type = HPXML::WindowGlassTypeClear
+ window.glass_type_isdefaulted = true
end
- end
- if window.gas_fill.nil?
- if window.glass_layers == HPXML::WindowLayersDoublePane
- if [HPXML::WindowGlassTypeLowE,
- HPXML::WindowGlassTypeLowEHighSolarGain,
- HPXML::WindowGlassTypeLowELowSolarGain].include? window.glass_type
+ if window.thermal_break.nil? && [HPXML::WindowFrameTypeAluminum, HPXML::WindowFrameTypeMetal].include?(window.frame_type)
+ if window.glass_layers == HPXML::WindowLayersSinglePane
+ window.thermal_break = false
+ window.thermal_break_isdefaulted = true
+ elsif window.glass_layers == HPXML::WindowLayersDoublePane
+ window.thermal_break = true
+ window.thermal_break_isdefaulted = true
+ end
+ end
+ if window.gas_fill.nil?
+ if window.glass_layers == HPXML::WindowLayersDoublePane
+ if [HPXML::WindowGlassTypeLowE,
+ HPXML::WindowGlassTypeLowEHighSolarGain,
+ HPXML::WindowGlassTypeLowELowSolarGain].include? window.glass_type
+ window.gas_fill = HPXML::WindowGasArgon
+ window.gas_fill_isdefaulted = true
+ else
+ window.gas_fill = HPXML::WindowGasAir
+ window.gas_fill_isdefaulted = true
+ end
+ elsif window.glass_layers == HPXML::WindowLayersTriplePane
window.gas_fill = HPXML::WindowGasArgon
window.gas_fill_isdefaulted = true
- else
- window.gas_fill = HPXML::WindowGasAir
- window.gas_fill_isdefaulted = true
end
- elsif window.glass_layers == HPXML::WindowLayersTriplePane
- window.gas_fill = HPXML::WindowGasArgon
- window.gas_fill_isdefaulted = true
end
end
# Now lookup U/SHGC based on properties
@@ -1562,7 +1566,11 @@ def self.apply_windows(hpxml_bldg, eri_version)
end
if window.interior_shading_factor_winter.nil? || window.interior_shading_factor_summer.nil?
if window.interior_shading_type.nil?
- window.interior_shading_type = HPXML::InteriorShadingTypeLightCurtains # ANSI/RESNET/ICC 301-2022
+ if window.glass_layers == HPXML::WindowLayersGlassBlock
+ window.interior_shading_type = HPXML::InteriorShadingTypeNone
+ else
+ window.interior_shading_type = HPXML::InteriorShadingTypeLightCurtains # ANSI/RESNET/ICC 301-2022
+ end
window.interior_shading_type_isdefaulted = true
end
if window.interior_shading_coverage_summer.nil? && window.interior_shading_type != HPXML::InteriorShadingTypeNone
@@ -1712,34 +1720,36 @@ def self.apply_skylights(hpxml_bldg)
end
next unless skylight.ufactor.nil? || skylight.shgc.nil?
- # Frame/Glass provided instead, fill in more defaults as needed
- if skylight.glass_type.nil?
- skylight.glass_type = HPXML::WindowGlassTypeClear
- skylight.glass_type_isdefaulted = true
- end
- if skylight.thermal_break.nil? && [HPXML::WindowFrameTypeAluminum, HPXML::WindowFrameTypeMetal].include?(skylight.frame_type)
- if skylight.glass_layers == HPXML::WindowLayersSinglePane
- skylight.thermal_break = false
- skylight.thermal_break_isdefaulted = true
- elsif skylight.glass_layers == HPXML::WindowLayersDoublePane
- skylight.thermal_break = true
- skylight.thermal_break_isdefaulted = true
- end
- end
- if skylight.gas_fill.nil?
- if skylight.glass_layers == HPXML::WindowLayersDoublePane
- if [HPXML::WindowGlassTypeLowE,
- HPXML::WindowGlassTypeLowEHighSolarGain,
- HPXML::WindowGlassTypeLowELowSolarGain].include? skylight.glass_type
+ if skylight.glass_layers != HPXML::WindowLayersGlassBlock
+ # Frame/Glass provided instead, fill in more defaults as needed
+ if skylight.glass_type.nil?
+ skylight.glass_type = HPXML::WindowGlassTypeClear
+ skylight.glass_type_isdefaulted = true
+ end
+ if skylight.thermal_break.nil? && [HPXML::WindowFrameTypeAluminum, HPXML::WindowFrameTypeMetal].include?(skylight.frame_type)
+ if skylight.glass_layers == HPXML::WindowLayersSinglePane
+ skylight.thermal_break = false
+ skylight.thermal_break_isdefaulted = true
+ elsif skylight.glass_layers == HPXML::WindowLayersDoublePane
+ skylight.thermal_break = true
+ skylight.thermal_break_isdefaulted = true
+ end
+ end
+ if skylight.gas_fill.nil?
+ if skylight.glass_layers == HPXML::WindowLayersDoublePane
+ if [HPXML::WindowGlassTypeLowE,
+ HPXML::WindowGlassTypeLowEHighSolarGain,
+ HPXML::WindowGlassTypeLowELowSolarGain].include? skylight.glass_type
+ skylight.gas_fill = HPXML::WindowGasArgon
+ skylight.gas_fill_isdefaulted = true
+ else
+ skylight.gas_fill = HPXML::WindowGasAir
+ skylight.gas_fill_isdefaulted = true
+ end
+ elsif skylight.glass_layers == HPXML::WindowLayersTriplePane
skylight.gas_fill = HPXML::WindowGasArgon
skylight.gas_fill_isdefaulted = true
- else
- skylight.gas_fill = HPXML::WindowGasAir
- skylight.gas_fill_isdefaulted = true
end
- elsif skylight.glass_layers == HPXML::WindowLayersTriplePane
- skylight.gas_fill = HPXML::WindowGasArgon
- skylight.gas_fill_isdefaulted = true
end
end
# Now lookup U/SHGC based on properties
@@ -3172,7 +3182,92 @@ def self.apply_generators(hpxml_bldg)
end
end
+ # Assigns default values for omitted optional inputs in the HPXML::Vehicle objects
+ # If an EV charger is found, apply_ev_charger is run to set its default values
+ # Default values for the battery are first applied with the apply_battery method, then electric vehicle-specific fields are populated such as miles/year, hours/week, and fraction charged at home.
+ #
+ # @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
+ # @return [nil]
+ def self.apply_vehicles(hpxml_bldg, schedules_file)
+ default_values = get_electric_vehicle_values
+ hpxml_bldg.vehicles.each do |vehicle|
+ next unless vehicle.vehicle_type == HPXML::VehicleTypeBEV
+
+ apply_battery(vehicle, default_values)
+ if vehicle.battery_type.nil?
+ vehicle.battery_type = default_values[:battery_type]
+ vehicle.battery_type_isdefaulted = true
+ end
+ if vehicle.fuel_economy_combined.nil? || vehicle.fuel_economy_units.nil?
+ vehicle.fuel_economy_combined = default_values[:fuel_economy_combined]
+ vehicle.fuel_economy_combined_isdefaulted = true
+ vehicle.fuel_economy_units = default_values[:fuel_economy_units]
+ vehicle.fuel_economy_units_isdefaulted = true
+ end
+ miles_to_hrs_per_week = default_values[:miles_per_year] / default_values[:hours_per_week]
+ if vehicle.miles_per_year.nil? && vehicle.hours_per_week.nil?
+ vehicle.miles_per_year = default_values[:miles_per_year]
+ vehicle.miles_per_year_isdefaulted = true
+ vehicle.hours_per_week = default_values[:hours_per_week]
+ vehicle.hours_per_week_isdefaulted = true
+ elsif (not vehicle.hours_per_week.nil?) && vehicle.miles_per_year.nil?
+ vehicle.miles_per_year = vehicle.hours_per_week * miles_to_hrs_per_week
+ vehicle.miles_per_year_isdefaulted = true
+ elsif (not vehicle.miles_per_year.nil?) && vehicle.hours_per_week.nil?
+ vehicle.hours_per_week = vehicle.miles_per_year / miles_to_hrs_per_week
+ vehicle.hours_per_week_isdefaulted = true
+ end
+ if vehicle.fraction_charged_home.nil?
+ vehicle.fraction_charged_home = default_values[:fraction_charged_home]
+ vehicle.fraction_charged_home_isdefaulted = true
+ end
+ schedules_file_includes_ev = (schedules_file.nil? ? false : schedules_file.includes_col_name(SchedulesFile::Columns[:ElectricVehicleCharging].name) && schedules_file.includes_col_name(SchedulesFile::Columns[:ElectricVehicleDischarging].name))
+ if vehicle.ev_weekday_fractions.nil? && !schedules_file_includes_ev
+ vehicle.ev_weekday_fractions = @default_schedules_csv_data[SchedulesFile::Columns[:ElectricVehicle].name]['WeekdayScheduleFractions']
+ vehicle.ev_weekday_fractions_isdefaulted = true
+ end
+ if vehicle.ev_weekend_fractions.nil? && !schedules_file_includes_ev
+ vehicle.ev_weekend_fractions = @default_schedules_csv_data[SchedulesFile::Columns[:ElectricVehicle].name]['WeekendScheduleFractions']
+ vehicle.ev_weekend_fractions_isdefaulted = true
+ end
+ if vehicle.ev_monthly_multipliers.nil? && !schedules_file_includes_ev
+ vehicle.ev_monthly_multipliers = @default_schedules_csv_data[SchedulesFile::Columns[:ElectricVehicle].name]['MonthlyScheduleMultipliers']
+ vehicle.ev_monthly_multipliers_isdefaulted = true
+ end
+
+ next if vehicle.ev_charger.nil?
+
+ apply_ev_charger(hpxml_bldg, vehicle.ev_charger)
+ end
+ end
+
+ # Assigns default values for omitted optional inputs in the HPXML::ElectricVehicleCharger objects
+ #
+ # @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
+ # @param ev_charger [HPXML::ElectricVehicleCharger] Object that defines a single electric vehicle charger
+ # @return [nil]
+ def self.apply_ev_charger(hpxml_bldg, ev_charger)
+ default_values = get_ev_charger_values(hpxml_bldg.has_location(HPXML::LocationGarage))
+ if ev_charger.location.nil?
+ ev_charger.location = default_values[:location]
+ ev_charger.location_isdefaulted = true
+ end
+ if ev_charger.charging_level.nil? && ev_charger.charging_power.nil?
+ ev_charger.charging_level = default_values[:charging_level]
+ ev_charger.charging_level_isdefaulted = true
+ end
+ if ev_charger.charging_power.nil?
+ if ev_charger.charging_level == 1
+ ev_charger.charging_power = default_values[:level1_charging_power]
+ elsif ev_charger.charging_level >= 2
+ ev_charger.charging_power = default_values[:level2_charging_power]
+ end
+ ev_charger.charging_power_isdefaulted = true
+ end
+ end
+
# Assigns default values for omitted optional inputs in the HPXML::Battery objects
+ # This method assigns fields specific to home battery systems, and calls a general method (apply_battery) that defaults values for any battery system.
#
# @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
# @return [nil]
@@ -3187,54 +3282,64 @@ def self.apply_batteries(hpxml_bldg)
battery.is_shared_system = false
battery.is_shared_system_isdefaulted = true
end
- # if battery.lifetime_model.nil?
- # battery.lifetime_model = default_values[:lifetime_model]
- # battery.lifetime_model_isdefaulted = true
- # end
- if battery.nominal_voltage.nil?
- battery.nominal_voltage = default_values[:nominal_voltage] # V
- battery.nominal_voltage_isdefaulted = true
- end
if battery.round_trip_efficiency.nil?
battery.round_trip_efficiency = default_values[:round_trip_efficiency]
battery.round_trip_efficiency_isdefaulted = true
end
- if battery.nominal_capacity_kwh.nil? && battery.nominal_capacity_ah.nil?
- # Calculate nominal capacity from usable capacity or rated power output if available
- if not battery.usable_capacity_kwh.nil?
- battery.nominal_capacity_kwh = (battery.usable_capacity_kwh / default_values[:usable_fraction]).round(2)
- battery.nominal_capacity_kwh_isdefaulted = true
- elsif not battery.usable_capacity_ah.nil?
- battery.nominal_capacity_ah = (battery.usable_capacity_ah / default_values[:usable_fraction]).round(2)
- battery.nominal_capacity_ah_isdefaulted = true
- elsif not battery.rated_power_output.nil?
- battery.nominal_capacity_kwh = (UnitConversions.convert(battery.rated_power_output, 'W', 'kW') / 0.5).round(2)
- battery.nominal_capacity_kwh_isdefaulted = true
- else
- battery.nominal_capacity_kwh = default_values[:nominal_capacity_kwh] # kWh
- battery.nominal_capacity_kwh_isdefaulted = true
- end
- end
- if battery.usable_capacity_kwh.nil? && battery.usable_capacity_ah.nil?
- # Calculate usable capacity from nominal capacity
- if not battery.nominal_capacity_kwh.nil?
- battery.usable_capacity_kwh = (battery.nominal_capacity_kwh * default_values[:usable_fraction]).round(2)
- battery.usable_capacity_kwh_isdefaulted = true
- elsif not battery.nominal_capacity_ah.nil?
- battery.usable_capacity_ah = (battery.nominal_capacity_ah * default_values[:usable_fraction]).round(2)
- battery.usable_capacity_ah_isdefaulted = true
- end
- end
- next unless battery.rated_power_output.nil?
- # Calculate rated power from nominal capacity
+ apply_battery(battery, default_values)
+ end
+ end
+
+ # Assigns default values for omitted optional inputs in the HPXML::Battery or HPXML::Vehicle objects
+ #
+ # @param hpxml_bldg [HPXML::Building] HPXML Building object representing an individual dwelling unit
+ # @param default_values [Hash] map of home battery or vehicle battery properties to default values
+ # @return [nil]
+ def self.apply_battery(battery, default_values)
+ # if battery.lifetime_model.nil?
+ # battery.lifetime_model = default_values[:lifetime_model]
+ # battery.lifetime_model_isdefaulted = true
+ # end
+ if battery.nominal_voltage.nil?
+ battery.nominal_voltage = default_values[:nominal_voltage] # V
+ battery.nominal_voltage_isdefaulted = true
+ end
+ if battery.nominal_capacity_kwh.nil? && battery.nominal_capacity_ah.nil?
+ # Calculate nominal capacity from usable capacity or rated power output if available
+ if not battery.usable_capacity_kwh.nil?
+ battery.nominal_capacity_kwh = (battery.usable_capacity_kwh / default_values[:usable_fraction]).round(2)
+ battery.nominal_capacity_kwh_isdefaulted = true
+ elsif not battery.usable_capacity_ah.nil?
+ battery.nominal_capacity_ah = (battery.usable_capacity_ah / default_values[:usable_fraction]).round(2)
+ battery.nominal_capacity_ah_isdefaulted = true
+ elsif battery.respond_to?(:rated_power_output) && (not battery.rated_power_output.nil?)
+ battery.nominal_capacity_kwh = (UnitConversions.convert(battery.rated_power_output, 'W', 'kW') / 0.5).round(2)
+ battery.nominal_capacity_kwh_isdefaulted = true
+ else
+ battery.nominal_capacity_kwh = default_values[:nominal_capacity_kwh] # kWh
+ battery.nominal_capacity_kwh_isdefaulted = true
+ end
+ end
+ if battery.usable_capacity_kwh.nil? && battery.usable_capacity_ah.nil?
+ # Calculate usable capacity from nominal capacity
if not battery.nominal_capacity_kwh.nil?
- battery.rated_power_output = (UnitConversions.convert(battery.nominal_capacity_kwh, 'kWh', 'Wh') * 0.5).round(0)
+ battery.usable_capacity_kwh = (battery.nominal_capacity_kwh * default_values[:usable_fraction]).round(2)
+ battery.usable_capacity_kwh_isdefaulted = true
elsif not battery.nominal_capacity_ah.nil?
- battery.rated_power_output = (UnitConversions.convert(Battery.get_kWh_from_Ah(battery.nominal_capacity_ah, battery.nominal_voltage), 'kWh', 'Wh') * 0.5).round(0)
+ battery.usable_capacity_ah = (battery.nominal_capacity_ah * default_values[:usable_fraction]).round(2)
+ battery.usable_capacity_ah_isdefaulted = true
end
- battery.rated_power_output_isdefaulted = true
end
+ return unless battery.respond_to?(:rated_power_output) && battery.rated_power_output.nil?
+
+ # Calculate rated power from nominal capacity
+ if not battery.nominal_capacity_kwh.nil?
+ battery.rated_power_output = (UnitConversions.convert(battery.nominal_capacity_kwh, 'kWh', 'Wh') * 0.5).round(0)
+ elsif not battery.nominal_capacity_ah.nil?
+ battery.rated_power_output = (UnitConversions.convert(Battery.get_kWh_from_Ah(battery.nominal_capacity_ah, battery.nominal_voltage), 'kWh', 'Wh') * 0.5).round(0)
+ end
+ battery.rated_power_output_isdefaulted = true
end
# Assigns default values for omitted optional inputs in the HPXML::ClothesWasher, HPXML::ClothesDryer,
@@ -3886,7 +3991,7 @@ def self.apply_plug_loads(hpxml_bldg, schedules_file)
plug_load.weekday_fractions_isdefaulted = true
end
if plug_load.weekend_fractions.nil? && !schedules_file_includes_plug_loads_vehicle
- plug_load.weekend_fractions = @default_schedules_csv_data[SchedulesFile::Columns[:PlugLoadsVehicle].name]['WeekdayScheduleFractions']
+ plug_load.weekend_fractions = @default_schedules_csv_data[SchedulesFile::Columns[:PlugLoadsVehicle].name]['WeekendScheduleFractions']
plug_load.weekend_fractions_isdefaulted = true
end
if plug_load.monthly_multipliers.nil? && !schedules_file_includes_plug_loads_vehicle
@@ -3913,7 +4018,7 @@ def self.apply_plug_loads(hpxml_bldg, schedules_file)
plug_load.weekday_fractions_isdefaulted = true
end
if plug_load.weekend_fractions.nil? && !schedules_file_includes_plug_loads_well_pump
- plug_load.weekend_fractions = @default_schedules_csv_data[SchedulesFile::Columns[:PlugLoadsWellPump].name]['WeekdayScheduleFractions']
+ plug_load.weekend_fractions = @default_schedules_csv_data[SchedulesFile::Columns[:PlugLoadsWellPump].name]['WeekendScheduleFractions']
plug_load.weekend_fractions_isdefaulted = true
end
if plug_load.monthly_multipliers.nil? && !schedules_file_includes_plug_loads_well_pump
@@ -5634,6 +5739,41 @@ def self.get_battery_values(has_garage)
usable_fraction: 0.9 } # Fraction of usable capacity to nominal capacity
end
+ # Get default lifetime model, miles/year, hours/week, nominal capacity/voltage, round trip efficiency, fraction charged at home,
+ # and usable fraction for an electric vehicle and its battery.
+ #
+ # @return [Hash] map of EV properties to default values
+ def self.get_electric_vehicle_values()
+ return { battery_type: HPXML::BatteryTypeLithiumIon,
+ lifetime_model: HPXML::BatteryLifetimeModelNone,
+ miles_per_year: 10900,
+ hours_per_week: 8.88,
+ nominal_capacity_kwh: 63,
+ nominal_voltage: 50.0,
+ fuel_economy_combined: 0.22,
+ fuel_economy_units: HPXML::UnitsKwhPerMile,
+ fraction_charged_home: 0.8,
+ usable_fraction: 0.8 } # Fraction of usable capacity to nominal capacity
+ end
+
+ # Get default location, charging power, and charging level for an electric vehicle charger.
+ # The default location is the garage if one is present.
+ #
+ # @param has_garage [Boolean] whether the HPXML Building object has a garage
+ # @return [Hash] map of electric vehicle charger properties to default values
+ def self.get_ev_charger_values(has_garage = false)
+ if has_garage
+ location = HPXML::LocationGarage
+ else
+ location = HPXML::LocationOutside
+ end
+
+ return { location: location,
+ charging_level: 2,
+ level1_charging_power: 1600,
+ level2_charging_power: 5690 } # Median L2 charging rate in EVWatts
+ end
+
# Gets the default values for a dehumidifier
# Used by OS-ERI. FUTURE: Change OS-HPXML inputs to be optional and use these.
#
@@ -5819,9 +5959,12 @@ def self.get_permanent_spa_heater_annual_energy(cfa, nbeds, n_occ, unit_type, ty
def self.get_electric_vehicle_charging_annual_energy()
ev_charger_efficiency = 0.9
ev_battery_efficiency = 0.9
- vehicle_annual_miles_driven = 4500.0
- vehicle_kWh_per_mile = 0.3
- return vehicle_annual_miles_driven * vehicle_kWh_per_mile / (ev_charger_efficiency * ev_battery_efficiency)
+
+ # Use detailed vehicle model defaults
+ vehicle_defaults = get_electric_vehicle_values
+ kwh_per_year = vehicle_defaults[:miles_per_year] * vehicle_defaults[:fuel_economy_combined] * vehicle_defaults[:fraction_charged_home] / (ev_charger_efficiency * ev_battery_efficiency)
+
+ return kwh_per_year.round(1)
end
# Gets the default well pump annual energy use.
diff --git a/HPXMLtoOpenStudio/resources/generator.rb b/HPXMLtoOpenStudio/resources/generator.rb
index 77cf86bc9b..054fc4f0f6 100644
--- a/HPXMLtoOpenStudio/resources/generator.rb
+++ b/HPXMLtoOpenStudio/resources/generator.rb
@@ -73,6 +73,7 @@ def self.apply_generator(model, hpxml_bldg, generator)
gmt.setElectricalPowerFunctionofTemperatureandElevationCurve(curve_biquadratic_constant)
gmt.setElectricalEfficiencyFunctionofTemperatureCurve(curve_cubic_constant)
gmt.setElectricalEfficiencyFunctionofPartLoadRatioCurve(curve_cubic_constant)
+ gmt.additionalProperties.setFeature('ObjectType', Constants::ObjectTypeGenerator)
elcd = OpenStudio::Model::ElectricLoadCenterDistribution.new(model)
elcd.setName("#{obj_name} elec load center dist")
diff --git a/HPXMLtoOpenStudio/resources/hotwater_appliances.rb b/HPXMLtoOpenStudio/resources/hotwater_appliances.rb
index 36dbfcb758..c30afdb1f7 100644
--- a/HPXMLtoOpenStudio/resources/hotwater_appliances.rb
+++ b/HPXMLtoOpenStudio/resources/hotwater_appliances.rb
@@ -23,7 +23,7 @@ def self.apply(runner, model, weather, spaces, hpxml_bldg, hpxml_header, schedul
nbeds = hpxml_bldg.building_construction.number_of_bedrooms
n_occ = hpxml_bldg.building_occupancy.number_of_residents
unit_type = hpxml_bldg.building_construction.residential_facility_type
- eri_version = hpxml_header.eri_calculation_version
+ eri_version = hpxml_header.eri_calculation_versions[0]
unit_multiplier = hpxml_bldg.building_construction.number_of_units
# Get appliances, etc.
diff --git a/HPXMLtoOpenStudio/resources/hpxml.rb b/HPXMLtoOpenStudio/resources/hpxml.rb
index b062fa4ca1..308f818f87 100644
--- a/HPXMLtoOpenStudio/resources/hpxml.rb
+++ b/HPXMLtoOpenStudio/resources/hpxml.rb
@@ -118,6 +118,7 @@ class HPXML < Object
ElectricResistanceDistributionRadiantCeiling = 'radiant ceiling'
ElectricResistanceDistributionRadiantFloor = 'radiant floor'
ElectricResistanceDistributionBaseboard = 'baseboard'
+ ElectricVehicleChargingLocationHome = 'Home'
ExteriorShadingTypeAwnings = 'awnings'
ExteriorShadingTypeBuilding = 'building'
ExteriorShadingTypeDeciduousTree = 'deciduous tree'
@@ -432,13 +433,23 @@ class HPXML < Object
UnitsKwh = 'kWh'
UnitsKwhPerYear = 'kWh/year'
UnitsKwhPerDay = 'kWh/day'
+ UnitsKwhPerMile = 'kWh/mile'
UnitsKwPerTon = 'kW/ton'
+ UnitsMiles = 'miles'
+ UnitsMilePerKwh = 'mile/kWh'
+ UnitsMPG = 'mpg'
+ UnitsMPGe = 'mpge'
UnitsPercent = 'Percent'
UnitsPercentPerHour = '%/hr'
UnitsSEER = 'SEER'
UnitsSEER2 = 'SEER2'
UnitsSLA = 'SLA'
UnitsThermPerYear = 'therm/year'
+ VehicleTypeBEV = 'BatteryElectricVehicle'
+ VehicleTypePHEV = 'PlugInHybridElectricVehicle'
+ VehicleTypeHybrid = 'HybridElectricVehicle'
+ VehicleTypeICE = 'InternalCombustionEngine'
+ VehicleTypeFCEV = 'FuelCellElectricVehicle'
VerticalSurroundingsNoAboveOrBelow = 'no units above or below'
VerticalSurroundingsAboveAndBelow = 'unit above and below'
VerticalSurroundingsBelow = 'unit below'
@@ -866,11 +877,11 @@ def initialize(hpxml_element, *args, **kwargs)
:software_program_version, # [String] SoftwareInfo/SoftwareProgramVersion
:apply_ashrae140_assumptions, # [Boolean] SoftwareInfo/extension/ApplyASHRAE140Assumptions
:whole_sfa_or_mf_building_sim, # [Boolean] SoftwareInfo/extension/WholeSFAorMFBuildingSimulation
- :eri_calculation_version, # [String] SoftwareInfo/extension/ERICalculation/Version
- :co2index_calculation_version, # [String] SoftwareInfo/extension/CO2IndexCalculation/Version
- :energystar_calculation_version, # [String] SoftwareInfo/extension/EnergyStarCalculation/Version
- :iecc_eri_calculation_version, # [String] SoftwareInfo/extension/IECCERICalculation/Version
- :zerh_calculation_version, # [String] SoftwareInfo/extension/ZERHCalculation/Version
+ :eri_calculation_versions, # [Array] SoftwareInfo/extension/ERICalculation/Version
+ :co2index_calculation_versions, # [Array] SoftwareInfo/extension/CO2IndexCalculation/Version
+ :energystar_calculation_versions, # [Array] SoftwareInfo/extension/EnergyStarCalculation/Version
+ :iecc_eri_calculation_versions, # [Array] SoftwareInfo/extension/IECCERICalculation/Version
+ :zerh_calculation_versions, # [Array] SoftwareInfo/extension/ZERHCalculation/Version
:timestep, # [Integer] SoftwareInfo/extension/SimulationControl/Timestep (minutes)
:sim_begin_month, # [Integer] SoftwareInfo/extension/SimulationControl/BeginMonth
:sim_begin_day, # [Integer] SoftwareInfo/extension/SimulationControl/BeginDayOfMonth
@@ -929,16 +940,19 @@ def to_doc(hpxml_doc)
XMLHelper.add_element(software_info, 'SoftwareProgramVersion', @software_program_version, :string) unless @software_program_version.nil?
XMLHelper.add_extension(software_info, 'ApplyASHRAE140Assumptions', @apply_ashrae140_assumptions, :boolean) unless @apply_ashrae140_assumptions.nil?
XMLHelper.add_extension(software_info, 'WholeSFAorMFBuildingSimulation', @whole_sfa_or_mf_building_sim, :boolean) unless @whole_sfa_or_mf_building_sim.nil?
- { 'ERICalculation' => @eri_calculation_version,
- 'CO2IndexCalculation' => @co2index_calculation_version,
- 'EnergyStarCalculation' => @energystar_calculation_version,
- 'IECCERICalculation' => @iecc_eri_calculation_version,
- 'ZERHCalculation' => @zerh_calculation_version }.each do |element_name, calculation_version|
- next if calculation_version.nil?
-
- extension = XMLHelper.create_elements_as_needed(software_info, ['extension'])
- calculation = XMLHelper.add_element(extension, element_name)
- XMLHelper.add_element(calculation, 'Version', calculation_version, :string)
+ { 'ERICalculation' => @eri_calculation_versions,
+ 'CO2IndexCalculation' => @co2index_calculation_versions,
+ 'EnergyStarCalculation' => @energystar_calculation_versions,
+ 'IECCERICalculation' => @iecc_eri_calculation_versions,
+ 'ZERHCalculation' => @zerh_calculation_versions }.each do |element_name, calculation_versions|
+ calculation_versions = [] if calculation_versions.nil?
+ if not calculation_versions.empty?
+ extension = XMLHelper.create_elements_as_needed(software_info, ['extension'])
+ calculation = XMLHelper.add_element(extension, element_name)
+ end
+ calculation_versions.each do |calculation_version|
+ XMLHelper.add_element(calculation, 'Version', calculation_version, :string)
+ end
end
if (not @timestep.nil?) || (not @sim_begin_month.nil?) || (not @sim_begin_day.nil?) || (not @sim_end_month.nil?) || (not @sim_end_day.nil?) || (not @temperature_capacitance_multiplier.nil?) || (not @defrost_model_type.nil?) || (not @hvac_onoff_thermostat_deadband.nil?) || (not @heat_pump_backup_heating_capacity_increment.nil?)
extension = XMLHelper.create_elements_as_needed(software_info, ['extension'])
@@ -975,11 +989,11 @@ def from_doc(hpxml)
@transaction = XMLHelper.get_value(hpxml, 'XMLTransactionHeaderInformation/Transaction', :string)
@software_program_used = XMLHelper.get_value(hpxml, 'SoftwareInfo/SoftwareProgramUsed', :string)
@software_program_version = XMLHelper.get_value(hpxml, 'SoftwareInfo/SoftwareProgramVersion', :string)
- @eri_calculation_version = XMLHelper.get_value(hpxml, 'SoftwareInfo/extension/ERICalculation/Version', :string)
- @co2index_calculation_version = XMLHelper.get_value(hpxml, 'SoftwareInfo/extension/CO2IndexCalculation/Version', :string)
- @iecc_eri_calculation_version = XMLHelper.get_value(hpxml, 'SoftwareInfo/extension/IECCERICalculation/Version', :string)
- @energystar_calculation_version = XMLHelper.get_value(hpxml, 'SoftwareInfo/extension/EnergyStarCalculation/Version', :string)
- @zerh_calculation_version = XMLHelper.get_value(hpxml, 'SoftwareInfo/extension/ZERHCalculation/Version', :string)
+ @eri_calculation_versions = XMLHelper.get_values(hpxml, 'SoftwareInfo/extension/ERICalculation/Version', :string)
+ @co2index_calculation_versions = XMLHelper.get_values(hpxml, 'SoftwareInfo/extension/CO2IndexCalculation/Version', :string)
+ @iecc_eri_calculation_versions = XMLHelper.get_values(hpxml, 'SoftwareInfo/extension/IECCERICalculation/Version', :string)
+ @energystar_calculation_versions = XMLHelper.get_values(hpxml, 'SoftwareInfo/extension/EnergyStarCalculation/Version', :string)
+ @zerh_calculation_versions = XMLHelper.get_values(hpxml, 'SoftwareInfo/extension/ZERHCalculation/Version', :string)
@timestep = XMLHelper.get_value(hpxml, 'SoftwareInfo/extension/SimulationControl/Timestep', :integer)
@sim_begin_month = XMLHelper.get_value(hpxml, 'SoftwareInfo/extension/SimulationControl/BeginMonth', :integer)
@sim_begin_day = XMLHelper.get_value(hpxml, 'SoftwareInfo/extension/SimulationControl/BeginDayOfMonth', :integer)
@@ -1443,6 +1457,8 @@ class Building < BaseElement
:pv_systems, # [HPXML::PVSystems]
:inverters, # [HPXML::Inverters]
:batteries, # [HPXML::Batteries]
+ :vehicles, # [HPXML::Vehicles]
+ :ev_chargers, # [HPXML::EVChargers]
:generators, # [HPXML::Generators]
:clothes_washers, # [HPXML::ClothesWashers]
:clothes_dryers, # [HPXML::ClothesDryers]
@@ -1582,6 +1598,8 @@ def to_doc(hpxml_doc)
@pv_systems.to_doc(building)
@inverters.to_doc(building)
@batteries.to_doc(building)
+ @vehicles.to_doc(building)
+ @ev_chargers.to_doc(building)
@generators.to_doc(building)
@clothes_washers.to_doc(building)
@clothes_dryers.to_doc(building)
@@ -1668,6 +1686,8 @@ def from_doc(building)
@pv_systems = PVSystems.new(self, building)
@inverters = Inverters.new(self, building)
@batteries = Batteries.new(self, building)
+ @vehicles = Vehicles.new(self, building)
+ @ev_chargers = ElectricVehicleChargers.new(self, building)
@generators = Generators.new(self, building)
@clothes_washers = ClothesWashers.new(self, building)
@clothes_dryers = ClothesDryers.new(self, building)
@@ -9256,6 +9276,253 @@ def from_doc(inverter)
end
end
+ # Array of HPXML::ElectricVehicleCharger objects
+ class ElectricVehicleChargers < BaseArrayElement
+ # Adds a new object, with the specified keyword arguments, to the array.
+ #
+ # @return [nil]
+ def add(**kwargs)
+ self << ElectricVehicleCharger.new(@parent_object, **kwargs)
+ end
+
+ # Populates the HPXML object(s) from the XML document.
+ #
+ # @param building [Oga::XML::Element] The current Building XML element
+ # @return [nil]
+ def from_doc(building)
+ return if building.nil?
+
+ XMLHelper.get_elements(building, 'BuildingDetails/Systems/ElectricVehicleChargers/ElectricVehicleCharger').each do |charger|
+ self << ElectricVehicleCharger.new(@parent_object, charger)
+ end
+ end
+ end
+
+ # Object for /HPXML/Building/BuildingDetails/Systems/ElectricVehicleChargers/ElectricVehicleCharger.
+ class ElectricVehicleCharger < BaseElement
+ ATTRS = [:id, # [String] SystemIdentifier/@id
+ :location, # [String] Location (HPXML::LocationXXX)
+ :charging_level, # [Integer] ChargingLevel (1-3)
+ :charging_power] # [Double] ChargingPower (W)
+ attr_accessor(*ATTRS)
+
+ # Deletes the current object from the array.
+ #
+ # @return [nil]
+ def delete
+ @parent_object.ev_chargers.delete(self)
+ end
+
+ # Additional error-checking beyond what's checked in Schema/Schematron validators.
+ #
+ # @return [Array] List of error messages
+ def check_for_errors
+ errors = []
+ return errors
+ end
+
+ # Adds this object to the provided Oga XML element.
+ #
+ # @param building [Oga::XML::Element] The current Building XML element
+ # @return [nil]
+ def to_doc(building)
+ return if nil?
+
+ chargers = XMLHelper.create_elements_as_needed(building, ['BuildingDetails', 'Systems', 'ElectricVehicleChargers'])
+ charger = XMLHelper.add_element(chargers, 'ElectricVehicleCharger')
+ sys_id = XMLHelper.add_element(charger, 'SystemIdentifier')
+ XMLHelper.add_attribute(sys_id, 'id', @id)
+ XMLHelper.add_element(charger, 'Location', @location, :string, @location_isdefaulted) unless @location.nil?
+ XMLHelper.add_element(charger, 'ChargingLevel', @charging_level, :integer, @charging_level_isdefaulted) unless @charging_level.nil?
+ XMLHelper.add_element(charger, 'ChargingPower', @charging_power, :float, @charging_power_isdefaulted) unless @charging_power.nil?
+ end
+
+ # Populates the HPXML object(s) from the XML document.
+ #
+ # @param battery [Oga::XML::Element] The current Battery XML element
+ # @return [nil]
+ def from_doc(charger)
+ return if charger.nil?
+
+ @id = HPXML::get_id(charger)
+ @location = XMLHelper.get_value(charger, 'Location', :string)
+ @charging_level = XMLHelper.get_value(charger, 'ChargingLevel', :integer)
+ @charging_power = XMLHelper.get_value(charger, 'ChargingPower', :float)
+ end
+ end
+
+ # Array of HPXML::Vehicle objects.
+ class Vehicles < BaseArrayElement
+ # Adds a new object, with the specified keyword arguments, to the array.
+ #
+ # @return [nil]
+ def add(**kwargs)
+ self << Vehicle.new(@parent_object, **kwargs)
+ end
+
+ # Populates the HPXML object(s) from the XML document.
+ #
+ # @param building [Oga::XML::Element] The current Building XML element
+ # @return [nil]
+ def from_doc(building)
+ return if building.nil?
+
+ XMLHelper.get_elements(building, 'BuildingDetails/Systems/Vehicles/Vehicle').each do |vehicle|
+ self << Vehicle.new(@parent_object, vehicle)
+ end
+ end
+ end
+
+ # Object for /HPXML/Building/BuildingDetails/Systems/Vehicles/Vehicle.
+ class Vehicle < BaseElement
+ ATTRS = [:id, # [String] SystemIdentifier/@id
+ :vehicle_type, # [String] VehicleType (HPXML::VehicleTypeXXX)
+ :miles_per_year, # [Double] MilesDrivenPerYear (miles)
+ :hours_per_week, # [Double] HoursDrivenPerWeek (hours)
+ :fuel_economy_combined, # [Double] FuelEconomyCombined/Value
+ :fuel_economy_units, # [String] FuelEconomyCombined/Units
+ :fraction_charged_home, # [Double] VehicleType/BatteryElectricVehicle/FractionChargedLocation[Location="Home"]/Percentage (frac)
+ :ev_charger_idref, # [String] VehicleType/BatteryElectricVehicle/ConnectedCharger/@idref
+ :battery_type, # [String] VehicleType/BatteryElectricVehicle/Battery/BatteryType (HPXML::BatteryTypeXXX)
+ :nominal_capacity_kwh, # [Double] VehicleType/BatteryElectricVehicle/Battery/NominalCapacity[Units="kWh"]/Value (kWh)
+ :nominal_capacity_ah, # [Double] VehicleType/BatteryElectricVehicle/Battery/NominalCapacity[Units="Ah"]/Value (Ah)
+ :usable_capacity_kwh, # [Double] VehicleType/BatteryElectricVehicle/Battery/UsableCapacity[Units="kWh"]/Value (kWh)
+ :usable_capacity_ah, # [Double] VehicleType/BatteryElectricVehicle/Battery/UsableCapacity[Units="Ah"]/Value (Ah)
+ :nominal_voltage, # [Double] VehicleType/BatteryElectricVehicle/Battery/NominalVoltage (V)
+ :lifetime_model, # [String] VehicleType/BatteryElectricVehicle/Battery/extension/LifetimeModel (HPXML::BatteryLifetimeModelXXX)
+ :ev_weekday_fractions, # [String] VehicleType/BatteryElectricVehicle/extension/WeekdayScheduleFractions
+ :ev_weekend_fractions, # [String] VehicleType/BatteryElectricVehicle/extension/WeekendScheduleFractions
+ :ev_monthly_multipliers] # [String] VehicleType/BatteryElectricVehicle/extension/MonthlyScheduleMultipliers
+ attr_accessor(*ATTRS)
+
+ # Deletes the current object from the array.
+ #
+ # @return [nil]
+ def delete
+ @parent_object.vehicles.delete(self)
+ end
+
+ # Additional error-checking beyond what's checked in Schema/Schematron validators.
+ #
+ # @return [Array] List of error messages
+ def check_for_errors
+ errors = []
+ return errors
+ end
+
+ # Adds this object to the provided Oga XML element.
+ #
+ # @param building [Oga::XML::Element] The current Building XML element
+ # @return [nil]
+ def to_doc(building)
+ return if nil?
+
+ vehicles = XMLHelper.create_elements_as_needed(building, ['BuildingDetails', 'Systems', 'Vehicles'])
+ vehicle = XMLHelper.add_element(vehicles, 'Vehicle')
+ sys_id = XMLHelper.add_element(vehicle, 'SystemIdentifier')
+ XMLHelper.add_attribute(sys_id, 'id', @id)
+ vehicle_type_element = XMLHelper.add_element(vehicle, 'VehicleType')
+ vehicle_type = XMLHelper.add_element(vehicle_type_element, @vehicle_type)
+
+ if [HPXML::VehicleTypeBEV, HPXML::VehicleTypePHEV, HPXML::VehicleTypeHybrid].include? @vehicle_type
+ if (not @battery_type.nil?) || (not @nominal_capacity_kwh.nil?) || (not @nominal_capacity_ah.nil?) || (not @usable_capacity_kwh.nil?) || (not @usable_capacity_ah.nil?) || (not @nominal_voltage.nil?) || (not @lifetime_model.nil?)
+ battery = XMLHelper.add_element(vehicle_type, 'Battery')
+ XMLHelper.add_element(battery, 'BatteryType', @battery_type, :string, @battery_type_isdefaulted) unless @battery_type.nil?
+ if not @nominal_capacity_kwh.nil?
+ nominal_capacity = XMLHelper.add_element(battery, 'NominalCapacity')
+ XMLHelper.add_element(nominal_capacity, 'Units', UnitsKwh, :string)
+ XMLHelper.add_element(nominal_capacity, 'Value', @nominal_capacity_kwh, :float, @nominal_capacity_kwh_isdefaulted)
+ end
+ if not @nominal_capacity_ah.nil?
+ nominal_capacity = XMLHelper.add_element(battery, 'NominalCapacity')
+ XMLHelper.add_element(nominal_capacity, 'Units', UnitsAh, :string)
+ XMLHelper.add_element(nominal_capacity, 'Value', @nominal_capacity_ah, :float, @nominal_capacity_ah_isdefaulted)
+ end
+ if not @usable_capacity_kwh.nil?
+ usable_capacity = XMLHelper.add_element(battery, 'UsableCapacity')
+ XMLHelper.add_element(usable_capacity, 'Units', UnitsKwh, :string)
+ XMLHelper.add_element(usable_capacity, 'Value', @usable_capacity_kwh, :float, @usable_capacity_kwh_isdefaulted)
+ end
+ if not @usable_capacity_ah.nil?
+ usable_capacity = XMLHelper.add_element(battery, 'UsableCapacity')
+ XMLHelper.add_element(usable_capacity, 'Units', UnitsAh, :string)
+ XMLHelper.add_element(usable_capacity, 'Value', @usable_capacity_ah, :float, @usable_capacity_ah_isdefaulted)
+ end
+ XMLHelper.add_element(battery, 'NominalVoltage', @nominal_voltage, :float, @nominal_voltage_isdefaulted) unless @nominal_voltage.nil?
+ XMLHelper.add_extension(battery, 'LifetimeModel', @lifetime_model, :string, @lifetime_model_isdefaulted) unless @lifetime_model.nil?
+ end
+ end
+
+ case @vehicle_type
+ when HPXML::VehicleTypeBEV
+ if not @fraction_charged_home.nil?
+ fraction_charged_location = XMLHelper.add_element(vehicle_type, 'FractionChargedLocation')
+ XMLHelper.add_element(fraction_charged_location, 'Location', HPXML::ElectricVehicleChargingLocationHome, :string)
+ XMLHelper.add_element(fraction_charged_location, 'Percentage', @fraction_charged_home, :float, @fraction_charged_home_isdefaulted)
+ end
+ if not @ev_charger_idref.nil?
+ charger = XMLHelper.add_element(vehicle_type, 'ConnectedCharger')
+ XMLHelper.add_attribute(charger, 'idref', @ev_charger_idref)
+ end
+ XMLHelper.add_extension(vehicle_type, 'WeekdayScheduleFractions', @ev_weekday_fractions, :string, @ev_weekday_fractions_isdefaulted) unless @ev_weekday_fractions.nil?
+ XMLHelper.add_extension(vehicle_type, 'WeekendScheduleFractions', @ev_weekend_fractions, :string, @ev_weekend_fractions_isdefaulted) unless @ev_weekend_fractions.nil?
+ XMLHelper.add_extension(vehicle_type, 'MonthlyScheduleMultipliers', @ev_monthly_multipliers, :string, @ev_monthly_multipliers_isdefaulted) unless @ev_monthly_multipliers.nil?
+ end
+
+ XMLHelper.add_element(vehicle, 'MilesDrivenPerYear', @miles_per_year, :float, @miles_per_year_isdefaulted) unless @miles_per_year.nil?
+ XMLHelper.add_element(vehicle, 'HoursDrivenPerWeek', @hours_per_week, :float, @hours_per_week_isdefaulted) unless @hours_per_week.nil?
+ if (not @fuel_economy_units.nil?) && (not @fuel_economy_combined.nil?)
+ fuel_economy = XMLHelper.add_element(vehicle, 'FuelEconomyCombined')
+ XMLHelper.add_element(fuel_economy, 'Units', @fuel_economy_units, :string, @fuel_economy_units_isdefaulted)
+ XMLHelper.add_element(fuel_economy, 'Value', @fuel_economy_combined, :float, @fuel_economy_combined_isdefaulted)
+ end
+ end
+
+ # Populates the HPXML object(s) from the XML document.
+ #
+ # @param battery [Oga::XML::Element] The current Battery XML element
+ # @return [nil]
+ def from_doc(vehicle)
+ return if vehicle.nil?
+
+ @id = HPXML::get_id(vehicle)
+ @miles_per_year = XMLHelper.get_value(vehicle, 'MilesDrivenPeryear', :float)
+ @hours_per_week = XMLHelper.get_value(vehicle, 'HoursDrivenPerWeek', :float)
+ @fuel_economy_combined = XMLHelper.get_value(vehicle, 'FuelEconomyCombined/Value', :float)
+ @fuel_economy_units = XMLHelper.get_value(vehicle, 'FuelEconomyCombined/Units', :string)
+ @vehicle_type = XMLHelper.get_child_name(vehicle, 'VehicleType')
+ if @vehicle_type == HPXML::VehicleTypeBEV
+ battery_prefix = "VehicleType/#{@vehicle_type}/Battery"
+ @battery_type = XMLHelper.get_value(vehicle, "#{battery_prefix}/BatteryType", :string)
+ @nominal_capacity_kwh = XMLHelper.get_value(vehicle, "#{battery_prefix}/NominalCapacity[Units='#{UnitsKwh}']/Value", :float)
+ @nominal_capacity_ah = XMLHelper.get_value(vehicle, "#{battery_prefix}/NominalCapacity[Units='#{UnitsAh}']/Value", :float)
+ @usable_capacity_kwh = XMLHelper.get_value(vehicle, "#{battery_prefix}/UsableCapacity[Units='#{UnitsKwh}']/Value", :float)
+ @usable_capacity_ah = XMLHelper.get_value(vehicle, "#{battery_prefix}/UsableCapacity[Units='#{UnitsAh}']/Value", :float)
+ @nominal_voltage = XMLHelper.get_value(vehicle, "#{battery_prefix}/NominalVoltage", :float)
+ @fraction_charged_home = XMLHelper.get_value(vehicle, "VehicleType/#{@vehicle_type}/FractionChargedLocation[Location='#{HPXML::ElectricVehicleChargingLocationHome}']/Percentage", :float)
+ @ev_charger_idref = HPXML::get_idref(XMLHelper.get_element(vehicle, "VehicleType/#{@vehicle_type}/ConnectedCharger"))
+ @lifetime_model = XMLHelper.get_value(vehicle, "#{battery_prefix}/extension/LifetimeModel", :string)
+ @ev_weekday_fractions = XMLHelper.get_value(vehicle, "VehicleType/#{@vehicle_type}/extension/WeekdayScheduleFractions", :string)
+ @ev_weekend_fractions = XMLHelper.get_value(vehicle, "VehicleType/#{@vehicle_type}/extension/WeekendScheduleFractions", :string)
+ @ev_monthly_multipliers = XMLHelper.get_value(vehicle, "VehicleType/#{@vehicle_type}/extension/MonthlyScheduleMultipliers", :string)
+ end
+ end
+
+ # Returns the EV charger for the vehicle.
+ #
+ # @return [HPXML::ElectricVehicleCharger] The connected EV charger
+ def ev_charger
+ return if @ev_charger_idref.nil?
+
+ @parent_object.ev_chargers.each do |ev_charger|
+ next unless ev_charger.id == @ev_charger_idref
+
+ return ev_charger
+ end
+ fail "Connected charger '#{@ev_charger_idref}' not found for vehicle '#{@id}'."
+ end
+ end
+
# Array of HPXML::Battery objects.
class Batteries < BaseArrayElement
# Adds a new object, with the specified keyword arguments, to the array.
diff --git a/HPXMLtoOpenStudio/resources/hpxml_schema/HPXML.xsd b/HPXMLtoOpenStudio/resources/hpxml_schema/HPXML.xsd
index 642dd04fe2..8f9aa740f6 100644
--- a/HPXMLtoOpenStudio/resources/hpxml_schema/HPXML.xsd
+++ b/HPXMLtoOpenStudio/resources/hpxml_schema/HPXML.xsd
@@ -1751,6 +1751,7 @@
+
@@ -1845,6 +1846,7 @@
+
Indicates whether this water heater uses a desuperheater. The attached heat pump or air conditioner can be referenced in the
@@ -2262,6 +2264,172 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The class as defined by the U.S. Federal Highway Administration.
+
+
+
+
+ The gross vehicle weight rating (GVWR) as defined by the U.S. Federal Highway Administration.
+
+
+
+
+ [lbs] The weight of the vehicle.
+
+
+
+
+ Number of similar vehicles.
+
+
+
+
+
+
+
+
+
+
+
+ The percentage of charging energy provided at different locations.
+
+
+
+
+
+
+ Percentage as a fraction (50% = 0.5)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The percentage of charging energy provided at different locations.
+
+
+
+
+
+
+ Percentage as a fraction (50% = 0.5)
+
+
+
+
+
+
+
+
+
+ Fuel type of the combustion engine
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -2273,6 +2441,7 @@
+
@@ -6249,6 +6418,14 @@
+
+
+
+
+
+
+
+
@@ -6267,6 +6444,51 @@
+
+
+
+
+
+ The total energy available when the battery is discharged starting from 100% state of charge until it reaches the cut-off voltage.
+
+
+
+
+ The stored energy that can actually be used. In most cases usable capacity is less than the nominal capacity.
+
+
+
+
+
+ [W] The amount of power the battery typically generates under non-peak conditions.
+
+
+
+
+ [W] The peak power that the battery can generate for a short period of time.
+
+
+
+
+ [V] The nominal voltage is the battery voltage when the state of charge is 0.5 (midway between being fully charged, and fully discharged)
+ with a 0.2C discharge current.
+
+
+
+
+ Not all the power that is used to charge the battery is available during discharge. Round trip efficiency is the ratio of the energy put
+ in to the energy retrieved from storage.
+
+
+
+
+ [W] The maximum charging power that can be accepted by the vehicle battery.
+
+
+
+
+
+
@@ -6460,6 +6682,18 @@
+
+
+
+
+
+
+
+
+
+
+
+
@@ -10123,6 +10357,119 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The class as defined by the U.S. Federal Highway Administration
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The class as defined by the U.S. Federal Highway Administration
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -10956,6 +11303,22 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -11460,6 +11823,22 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/HPXMLtoOpenStudio/resources/hpxml_schematron/EPvalidator.xml b/HPXMLtoOpenStudio/resources/hpxml_schematron/EPvalidator.xml
index f7db0334d9..d1e73a253a 100644
--- a/HPXMLtoOpenStudio/resources/hpxml_schematron/EPvalidator.xml
+++ b/HPXMLtoOpenStudio/resources/hpxml_schematron/EPvalidator.xml
@@ -69,8 +69,9 @@
Expected at maximum one heating system for each Building
Expected sum(FractionHeatLoadServed) to be equal to 1
Expected sum(FractionCoolLoadServed) to be equal to 1
- TemperatureCapacitanceMultiplier should typically be greater than 1.
Expected ../../SoftwareInfo/extension/SimulationControl/Timestep to be 1.0
+
+ TemperatureCapacitanceMultiplier should typically be greater than 1.
@@ -266,6 +267,8 @@
Expected 0 or 1 element(s) for xpath: Systems/SolarThermal/SolarThermalSystem
Expected 0 or more element(s) for xpath: Systems/Photovoltaics/PVSystem
Expected 0 or 1 element(s) for xpath: Systems/Batteries/Battery
+ Expected 0 or more element(s) for xpath: Systems/Vehicles/Vehicle
+ Expected 0 or more element(s) for xpath: Systems/ElectricVehicleChargers/ElectricVehicleCharger
Expected 0 or more element(s) for xpath: Systems/extension/Generators/Generator
Expected 0 or 1 element(s) for xpath: Appliances/ClothesWasher
Expected 0 or 1 element(s) for xpath: Appliances/ClothesDryer
@@ -297,11 +300,16 @@
Expected sum(Zones/Zone[ZoneType="conditioned"]/Spaces/Space/FloorArea) to be equal to BuildingSummary/BuildingConstruction/ConditionedFloorArea
- While multiple conditioned zones are specified, the EnergyPlus model will only include a single conditioned thermal zone.
+ While multiple conditioned zones are specified, the EnergyPlus model will only include a single conditioned thermal zone.
No windows specified, the model will not include window heat transfer.
No space heating specified, the model will not include space heating energy use.
No space cooling specified, the model will not include space cooling energy use.
No water heating specified, the model will not include water heating energy use.
+ Vehicle type 'PlugInHybridElectricVehicle' is not currently handled, the vehicle will not be modeled.
+ Vehicle type 'HybridElectricVehicle' is not currently handled, the vehicle will not be modeled.
+ Vehicle type 'InternalCombustionEngine' is not currently handled, the vehicle will not be modeled.
+ Vehicle type 'FuelCellElectricVehicle' is not currently handled, the vehicle will not be modeled.
+ Vehicle type 'Other' is not currently handled, the vehicle will not be modeled.
No clothes washer specified, the model will not include clothes washer energy use.
No clothes dryer specified, the model will not include clothes dryer energy use.
No dishwasher specified, the model will not include dishwasher energy use.
@@ -2500,6 +2508,57 @@
+
+ [Vehicles]
+
+ Expected 0 or 1 element(s) for xpath: Vehicle/VehicleType/BatteryElectricVehicle
+
+
+
+
+ [Vehicle]
+
+ Expected 1 element(s) for xpath: VehicleType
+
+
+
+
+ [VehicleType=BEV]
+
+ Expected 0 or 1 element(s) for xpath: Battery/BatteryType[text()="Li-ion"]
+ Expected Battery/BatteryType to be "Li-ion"
+ Expected 0 or more element(s) for xpath: Battery/NominalCapacity[Units="kWh" or Units="Ah"]/Value
+ Expected 0 or more element(s) for xpath: Battery/UsableCapacity[Units="kWh" or Units="Ah"]/Value
+ Expected UsableCapacity to be less than NominalCapacity
+ Expected UsableCapacity to be less than NominalCapacity
+ Expected 0 or 1 element(s) for xpath: Battery/NominalVoltage
+ Expected 0 element(s) for xpath: Battery/extension/LifetimeModel
+ Expected Battery/extension/LifetimeModel to be 'None' or 'KandlerSmith'
+ Expected 0 or 1 element(s) for xpath: FractionChargedLocation[Location="Home"]/Percentage
+ Expected 0 or 1 element(s) for xpath: ConnectedCharger
+ Expected 0 or 1 element(s) for xpath: extension/WeekdayScheduleFractions
+ Expected 0 or 1 element(s) for xpath: extension/WeekendScheduleFractions
+ Expected 0 or 1 element(s) for xpath: extension/MonthlyScheduleMultipliers
+ Expected 0 or 1 element(s) for xpath: ../../MilesDrivenPerYear
+ Expected 0 or 1 element(s) for xpath: ../../HoursDrivenPerWeek
+ Expected 0 or 1 element(s) for xpath: ../../FuelEconomyCombined/Value
+ Expected ../../FuelEconomyCombined/Units to be "kWh/mile" or "mile/kWh" or "mpge"
+
+ Electric vehicle charging was specified as both a PlugLoad and a Vehicle, the latter will be ignored.
+ Electric vehicle specified with no charger provided; home EV charging will not be modeled.
+
+
+
+
+ [ElectricVehicleCharger]
+
+ Expected 0 or 1 element(s) for xpath: Location
+ Expected Location to be 'garage' or 'outside'
+ Expected 0 or 1 element(s) for xpath: ChargingLevel
+ Expected 0 or 1 element(s) for xpath: ChargingPower
+
+
+
[Generator]
diff --git a/HPXMLtoOpenStudio/resources/lighting.rb b/HPXMLtoOpenStudio/resources/lighting.rb
index 551f48acf4..b784d91eb2 100644
--- a/HPXMLtoOpenStudio/resources/lighting.rb
+++ b/HPXMLtoOpenStudio/resources/lighting.rb
@@ -16,7 +16,7 @@ def self.apply(runner, model, spaces, hpxml_bldg, hpxml_header, schedules_file)
lighting = hpxml_bldg.lighting
unit_multiplier = hpxml_bldg.building_construction.number_of_units
cfa = hpxml_bldg.building_construction.conditioned_floor_area
- eri_version = hpxml_header.eri_calculation_version
+ eri_version = hpxml_header.eri_calculation_versions[0]
n_occ = hpxml_bldg.building_occupancy.number_of_residents
ltg_locns = [HPXML::LocationInterior, HPXML::LocationExterior, HPXML::LocationGarage]
diff --git a/HPXMLtoOpenStudio/resources/misc_loads.rb b/HPXMLtoOpenStudio/resources/misc_loads.rb
index e30ce386cc..1497d98872 100644
--- a/HPXMLtoOpenStudio/resources/misc_loads.rb
+++ b/HPXMLtoOpenStudio/resources/misc_loads.rb
@@ -29,7 +29,7 @@ def self.apply_plug_loads(runner, model, spaces, hpxml_bldg, hpxml_header, sched
obj_name = Constants::ObjectTypeMiscWellPump
end
if obj_name.nil?
- runner.registerWarning("Unexpected plug load type '#{plug_load.plug_load_type}'. The plug load will not be modeled.")
+ # Warning issued by Schematron validator
next
end
@@ -132,7 +132,7 @@ def self.apply_fuel_loads(runner, model, spaces, hpxml_bldg, hpxml_header, sched
obj_name = Constants::ObjectTypeMiscFireplace
end
if obj_name.nil?
- runner.registerWarning("Unexpected fuel load type '#{fuel_load.fuel_load_type}'. The fuel load will not be modeled.")
+ # Warning issued by Schematron validator
next
end
diff --git a/HPXMLtoOpenStudio/resources/output.rb b/HPXMLtoOpenStudio/resources/output.rb
index e07ae5ccb8..7b7328379b 100644
--- a/HPXMLtoOpenStudio/resources/output.rb
+++ b/HPXMLtoOpenStudio/resources/output.rb
@@ -2,6 +2,10 @@
# Collection of methods related to output reporting or writing output files.
module Outputs
+ MeterCustomElectricityTotal = 'Electricity:Total'
+ MeterCustomElectricityNet = 'Electricity:Net'
+ MeterCustomElectricityPV = 'Electricity:PV'
+
# Add EMS programs for output reporting. In the case where a whole SFA/MF building is
# being simulated, these programs are added to the whole building (merged) model, not
# the individual dwelling unit models.
@@ -1189,4 +1193,79 @@ def self.write_results_out_to_file(results_out, output_format, output_file_path,
end
end
end
+
+ # Creates custom output meters that are used across reporting measures.
+ #
+ # @param model [OpenStudio::Model::Model] OpenStudio Model object
+ # @return [nil]
+ def self.create_custom_meters(model)
+ # Create custom meters:
+ # - Total Electricity (Electricity:Facility plus EV charging, batteries, generators)
+ # - Net Electricity (above plus PV)
+ # - PV Electricity
+
+ total_key_vars = []
+ net_key_vars = []
+ pv_key_vars = []
+ model.getElectricLoadCenterDistributions.each do |elcd|
+ # Batteries & EV charging output variables
+ if elcd.electricalStorage.is_initialized
+ elcs = elcd.electricalStorage.get
+ if elcs.additionalProperties.getFeatureAsString('ObjectType').to_s == Constants::ObjectTypeVehicle
+ net_key_vars << [elcs.name.to_s.upcase, 'Electric Storage Production Decrement Energy']
+ total_key_vars << net_key_vars[-1]
+ elsif elcs.additionalProperties.getFeatureAsString('ObjectType').to_s == Constants::ObjectTypeBattery
+ net_key_vars << [elcs.name.to_s.upcase, 'Electric Storage Production Decrement Energy']
+ total_key_vars << net_key_vars[-1]
+ net_key_vars << [elcs.name.to_s.upcase, 'Electric Storage Discharge Energy']
+ total_key_vars << net_key_vars[-1]
+ end
+ end
+
+ # PV output meters
+ elcd.generators.each do |generator|
+ next unless generator.additionalProperties.getFeatureAsString('ObjectType').to_s == Constants::ObjectTypePhotovoltaics
+
+ net_key_vars << ['', 'Photovoltaic:ElectricityProduced']
+ pv_key_vars << net_key_vars[-1]
+ net_key_vars << ['', 'PowerConversion:ElectricityProduced']
+ pv_key_vars << net_key_vars[-1]
+ end
+
+ # Generator output meter
+ elcd.generators.each do |generator|
+ next unless generator.additionalProperties.getFeatureAsString('ObjectType').to_s == Constants::ObjectTypeGenerator
+
+ net_key_vars << ['', 'Cogeneration:ElectricityProduced']
+ total_key_vars << net_key_vars[-1]
+ end
+ end
+
+ # Create Total/Net meters
+ { MeterCustomElectricityTotal => total_key_vars,
+ MeterCustomElectricityNet => net_key_vars }.each do |meter_name, key_vars|
+ if key_vars.empty?
+ # Avoid OpenStudio warnings if nothing to decrement
+ meter = OpenStudio::Model::MeterCustom.new(model)
+ key_vars << ['', 'Electricity:Facility']
+ else
+ meter = OpenStudio::Model::MeterCustomDecrement.new(model, 'Electricity:Facility')
+ end
+ meter.setName(meter_name)
+ meter.setFuelType(EPlus::FuelTypeElectricity)
+ key_vars.uniq.each do |key_var|
+ meter.addKeyVarGroup(key_var[0], key_var[1])
+ end
+ end
+
+ # Create PV meter
+ if not pv_key_vars.empty?
+ meter = OpenStudio::Model::MeterCustom.new(model)
+ meter.setName(MeterCustomElectricityPV)
+ meter.setFuelType(EPlus::FuelTypeElectricity)
+ pv_key_vars.uniq.each do |key_var|
+ meter.addKeyVarGroup(key_var[0], key_var[1])
+ end
+ end
+ end
end
diff --git a/HPXMLtoOpenStudio/resources/pv.rb b/HPXMLtoOpenStudio/resources/pv.rb
index 08822275c7..a96bb854f8 100644
--- a/HPXMLtoOpenStudio/resources/pv.rb
+++ b/HPXMLtoOpenStudio/resources/pv.rb
@@ -37,6 +37,7 @@ def self.apply_pv_system(model, hpxml_bldg, pv_system)
# Apply unit multiplier
max_power = pv_system.max_power_output * unit_multiplier
+ return if max_power <