Prototype whole SFA/MF building + shared system

docs/technical_development_guide/source/basic_tutorial/resstock_architecture.rst

@@ -43,17 +43,14 @@ The following depicts the order in which workflow measure steps are applied:
   ===== ============================= ================== ========= ============= ==========================
   1     BuildExistingModel            Model              No        Meta measure  ResStock
   2     ApplyUpgrade                  Model              Yes [#]_  Meta measure  ResStock
-  3     HPXMLtoOpenStudio             Model              No                      OS-HPXML [#]_
-  4     UpgradeCosts                  Model              No                      ResStock
-  5     *Other Model Measures*        Model              Yes                     Any [#]_
-  6     ReportSimulationOutput        Reporting          No                      OS-HPXML
-  7     ReportUtilityBills            Reporting          No                      OS-HPXML
-  8     *Other Reporting Measures*    Reporting          Yes                     Any [#]_
-  9     ServerDirectoryCleanup        Reporting          No                      ResStock
+  3     UpgradeCosts                  Model              No                      ResStock
+  4     *Other Model Measures*        Model              Yes                     Any [#]_
+  5     SimulationOutput              Reporting          No        Meta measure  ResStock
+  6     *Other Reporting Measures*    Reporting          Yes                     Any [#]_
+  7     ServerDirectoryCleanup        Reporting          No                      ResStock
   ===== ============================= ================== ========= ============= ==========================
 
  .. [#] Baseline models with no upgrades do not have the ApplyUpgrade measure applied.
- .. [#] OS-HPXML refers to the `OpenStudio-HPXML <https://github.com/NREL/OpenStudio-HPXML>`_ repository.
  .. [#] *Other Model Measures* do not need to originate from ResStock, but it is up to the user to ensure they work within the ResStock workflow.
  .. [#] *Other Reporting Measures* do not need to originate from ResStock, but it is up to the user to ensure they work within the ResStock workflow.
 
@@ -63,9 +60,23 @@ The BuildExistingModel and ApplyUpgrade meta measures call the following model m
   Index Measure                       Measure Type       Optional  Notes         Source
   ===== ============================= ================== ========= ============= ==========================
   1     ResStockArguments             Model              No                      ResStock
-  2     BuildResidentialHPXML         Model              No                      OS-HPXML
+  2     BuildResidentialHPXML         Model              No                      OS-HPXML [#]_
   3     BuildResidentialScheduleFile  Model              No                      OS-HPXML
   4     ResStockArgumentsPostHPXML    Model              No                      ResStock
+  5     HPXMLtoOpenStudio             Model              No [#]_                 OS-HPXML
+  6     AddSharedSystem               Model              No                      ResStock
+  ===== ============================= ================== ========= ============= ==========================
+
+ .. [#] OS-HPXML refers to the `OpenStudio-HPXML <https://github.com/NREL/OpenStudio-HPXML>`_ repository.
+ .. [#] The HPXMLtoOpenStudio measure is only called once in the workflow; it is called from BuildExistingModel for baseline models or from ApplyUpgrade for upgrade models.
+
+The SimulationOutput meta measure calls the following reporting measures:
+
+  ===== ============================= ================== ========= ============= ==========================
+  Index Measure                       Measure Type       Optional  Notes         Source
+  ===== ============================= ================== ========= ============= ==========================
+  1     ReportSimulationOutput        Reporting          No                      OS-HPXML
+  2     ReportUtilityBills            Reporting          No                      OS-HPXML
   ===== ============================= ================== ========= ============= ==========================
 
 .. _model-measures:

docs/technical_development_guide/source/workflow_inputs/characteristics.rst

@@ -29759,6 +29759,19 @@ From ``project_national`` the list of options, option stock saturation, and opti
      - 
      - 
      - 
+   * - ``hvac_cooling_shared_system``
+     - None
+     - None
+     - None
+     - None
+     - None
+     - None
+     - None
+     - None
+     - None
+     - None
+     - None
+     - 
 
 Properties
 **********
@@ -29782,6 +29795,9 @@ Properties
    * - ``hvac_cooling_system_cooling_compressor_type``
      - 
      - The compressor type of the cooling system. Applies to Central ACs and Mini-Split ACs.
+   * - ``hvac_cooling_shared_system``
+     - 
+     - The type of shared cooling system.
 .. _hvac_cooling_partial_space_conditioning:
 
 HVAC Cooling Partial Space Conditioning
@@ -30683,7 +30699,7 @@ Properties
      - The rated heating efficiency of the integrated backup.
    * - ``hvac_heating_shared_system``
      - 
-     - The type of shared system.
+     - The type of shared heating system.
    * - ``hvac_heat_pump_backup_use_existing_system``
      - 
      - Whether the heat pump uses the existing heating system as backup. If true and backup type of the heat pump is 'integrated', heat_pump_backup_xxx arguments are assigned values based on the existing heating system. If true and backup type of the heat pump is 'separate', heating_system_2_xxx arguments are assigned values based on the existing heating system. This argument is only applicable for heat pump upgrades.
@@ -31305,6 +31321,14 @@ From ``project_national`` the list of options, option stock saturation, and opti
      - FanCoil
      - 
      - 
+   * - ``hvac_cooling_shared_system``
+     - 
+     - 
+     - FanCoil
+     - FanCoil
+     - FanCoil
+     - 
+     - 
 
 Properties
 **********
@@ -31354,7 +31378,10 @@ Properties
      - The backup type. Use 'integrated' to represent e.g. built-in electric strip heat or dual-fuel integrated furnace. Use 'separate' to represent e.g. electric baseboard or boiler (based on Heating System 2).
    * - ``hvac_heating_shared_system``
      - 
-     - The type of shared system.
+     - The type of shared heating system.
+   * - ``hvac_cooling_shared_system``
+     - 
+     - The type of shared cooling system.
 .. _hvac_system_is_faulted:
 
 HVAC System Is Faulted

docs/technical_reference_guide/characteristics/options/HVAC Cooling Efficiency.tex

@@ -8,23 +8,27 @@
 \texttt{hvac\_cooling\_system\_cooling\_efficiency\_type} & SEER2 & SEER2 & SEER2 \\ \hline
 \texttt{hvac\_cooling\_system\_cooling\_efficiency} & 7.6 & 9.5 & 12.4 \\ \hline
 \texttt{hvac\_cooling\_system\_cooling\_compressor\_type} & single stage & single stage & single stage \\ \hline
+\texttt{hvac\_cooling\_shared\_system} & None & None & None \\ \hline
 \hline
 Option name & AC, SEER2 14.3 & Ducted Heat Pump & Non-Ducted Heat Pump \\ \hline
 Stock saturation & 12\% & 15\% & 0.97\% \\ \hline
 \texttt{hvac\_cooling\_system\_type} & central air conditioner & none & none \\ \hline
 \texttt{hvac\_cooling\_system\_cooling\_efficiency\_type} & SEER2 &  &  \\ \hline
 \texttt{hvac\_cooling\_system\_cooling\_efficiency} & 14.3 &  &  \\ \hline
 \texttt{hvac\_cooling\_system\_cooling\_compressor\_type} & single stage &  &  \\ \hline
+\texttt{hvac\_cooling\_shared\_system} & None & None & None \\ \hline
 \hline
 Option name & None & Room AC, CEER 8.4 & Room AC, CEER 9.7 \\ \hline
 Stock saturation & 11\% & 0.43\% & 2.6\% \\ \hline
 \texttt{hvac\_cooling\_system\_type} & none & room air conditioner & room air conditioner \\ \hline
 \texttt{hvac\_cooling\_system\_cooling\_efficiency\_type} &  & CEER & CEER \\ \hline
 \texttt{hvac\_cooling\_system\_cooling\_efficiency} &  & 8.4 & 9.7 \\ \hline
+\texttt{hvac\_cooling\_shared\_system} & None & None & None \\ \hline
 \hline
 Option name & Room AC, CEER 10.6 & Room AC, CEER 11.9 & Shared Cooling \\ \hline
 Stock saturation & 9.6\% & 7.4\% & 3.8\% \\ \hline
 \texttt{hvac\_cooling\_system\_type} & room air conditioner & room air conditioner &  \\ \hline
 \texttt{hvac\_cooling\_system\_cooling\_efficiency\_type} & CEER & CEER &  \\ \hline
-\texttt{hvac\_cooling\_system\_cooling\_efficiency} & 10.6 & 11.9 &  \\
+\texttt{hvac\_cooling\_system\_cooling\_efficiency} & 10.6 & 11.9 &  \\ \hline
+\texttt{hvac\_cooling\_shared\_system} & None & None &  \\
 \end{customLongTable}

docs/technical_reference_guide/characteristics/options/HVAC Shared Efficiencies.tex

@@ -17,6 +17,7 @@
 \texttt{hvac\_heat\_pump\_cooling\_load\_served\_fraction} & 1.0 & 1.0 &  \\ \hline
 \texttt{hvac\_heat\_pump\_backup\_type} & none & none &  \\ \hline
 \texttt{hvac\_heating\_shared\_system} & Baseboard & Baseboard &  \\ \hline
+\texttt{hvac\_cooling\_shared\_system} &  &  & FanCoil \\ \hline
 \hline
 Option name & Fan Coil Heating and Cooling, Electricity & Fan Coil Heating and Cooling, Fuel & None \\ \hline
 Stock saturation & 1.3\% & 1.1\% & 89\% \\ \hline
@@ -32,5 +33,6 @@
 \texttt{hvac\_heat\_pump\_heating\_load\_served\_fraction} & 1.0 & 1.0 &  \\ \hline
 \texttt{hvac\_heat\_pump\_cooling\_load\_served\_fraction} & 1.0 & 1.0 &  \\ \hline
 \texttt{hvac\_heat\_pump\_backup\_type} & none & none &  \\ \hline
-\texttt{hvac\_heating\_shared\_system} & FanCoil & FanCoil &  \\
+\texttt{hvac\_heating\_shared\_system} & FanCoil & FanCoil &  \\ \hline
+\texttt{hvac\_cooling\_shared\_system} & FanCoil & FanCoil &  \\
 \end{customLongTable}

docs/technical_reference_guide/characteristics/properties/HVAC Cooling Efficiency.tex

@@ -4,5 +4,6 @@
 \texttt{hvac\_cooling\_system\_type} &  & The type of system. \\ \hline
 \texttt{hvac\_cooling\_system\_cooling\_efficiency\_type} &  & The cooling efficiency type. Central ACs and Mini-Split ACs use SEER2 or EER2; Room ACs and Packaged Terminal ACs use CEER or EER. \\ \hline
 \texttt{hvac\_cooling\_system\_cooling\_efficiency} &  & The rated cooling efficiency. \\ \hline
-\texttt{hvac\_cooling\_system\_cooling\_compressor\_type} &  & The compressor type of the cooling system. Applies to Central ACs and Mini-Split ACs. \\
+\texttt{hvac\_cooling\_system\_cooling\_compressor\_type} &  & The compressor type of the cooling system. Applies to Central ACs and Mini-Split ACs. \\ \hline
+\texttt{hvac\_cooling\_shared\_system} &  & The type of shared cooling system. \\
 \end{customLongTable}

docs/technical_reference_guide/characteristics/properties/HVAC Heating Efficiency.tex

@@ -16,7 +16,7 @@
 \texttt{hvac\_heat\_pump\_backup\_type} &  & The backup type. Use 'integrated' to represent e.g. built-in electric strip heat or dual-fuel integrated furnace. Use 'separate' to represent e.g. electric baseboard or boiler (based on Heating System 2). \\ \hline
 \texttt{hvac\_heat\_pump\_backup\_fuel} &  & The fuel type of the integrated backup. \\ \hline
 \texttt{hvac\_heat\_pump\_backup\_heating\_efficiency} & Frac & The rated heating efficiency of the integrated backup. \\ \hline
-\texttt{hvac\_heating\_shared\_system} &  & The type of shared system. \\ \hline
+\texttt{hvac\_heating\_shared\_system} &  & The type of shared heating system. \\ \hline
 \texttt{hvac\_heat\_pump\_backup\_use\_existing\_system} &  & Whether the heat pump uses the existing heating system as backup. If true and backup type of the heat pump is 'integrated', heat\_pump\_backup\_xxx arguments are assigned values based on the existing heating system. If true and backup type of the heat pump is 'separate', heating\_system\_2\_xxx arguments are assigned values based on the existing heating system. This argument is only applicable for heat pump upgrades. \\ \hline
 \texttt{hvac\_heat\_pump\_sizing\_is\_duct\_limited} &  & Whether the (ducted) heat pump has an upper limit for autosized heating/cooling capacity and an adjusted blower fan efficiency (W/CFM) value. This argument is only applicable for heat pump upgrades. \\
 \end{customLongTable}

docs/technical_reference_guide/characteristics/properties/HVAC Shared Efficiencies.tex

@@ -13,5 +13,6 @@
 \texttt{hvac\_heat\_pump\_heating\_load\_served\_fraction} &  & Fraction of load served by the HVAC system. \\ \hline
 \texttt{hvac\_heat\_pump\_cooling\_load\_served\_fraction} &  & Fraction of load served by the HVAC system. \\ \hline
 \texttt{hvac\_heat\_pump\_backup\_type} &  & The backup type. Use 'integrated' to represent e.g. built-in electric strip heat or dual-fuel integrated furnace. Use 'separate' to represent e.g. electric baseboard or boiler (based on Heating System 2). \\ \hline
-\texttt{hvac\_heating\_shared\_system} &  & The type of shared system. \\
+\texttt{hvac\_heating\_shared\_system} &  & The type of shared heating system. \\ \hline
+\texttt{hvac\_cooling\_shared\_system} &  & The type of shared cooling system. \\
 \end{customLongTable}

measures/AddSharedSystem/measure.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+# see the URL below for information on how to write OpenStudio measures
+# http://nrel.github.io/OpenStudio-user-documentation/reference/measure_writing_guide/
+
+require 'openstudio'
+require 'openstudio-standards'
+require_relative '../../resources/buildstock'
+
+# start the measure
+class AddSharedSystem < OpenStudio::Measure::ModelMeasure
+  # human readable name
+  def name
+    return 'Add Shared System'
+  end
+
+  # human readable description
+  def description
+    return 'TODO'
+  end
+
+  # human readable description of modeling approach
+  def modeler_description
+    return 'TODO'
+  end
+
+  # define the arguments that the user will input
+  def arguments(model) # rubocop:disable Lint/UnusedMethodArgument
+    args = OpenStudio::Measure::OSArgumentVector.new
+
+    # Allow same arguments as ResStockArguments measure
+
+    full_measure_path = File.join(File.dirname(__FILE__), '..', 'ResStockArguments', 'measure.rb')
+    measure_arguments = get_measure_instance(full_measure_path).arguments(model)
+    measure_arguments.each do |arg|
+      arg.setRequired(false)
+      args << arg
+    end
+
+    arg = OpenStudio::Measure::OSArgument.makeStringArgument('hpxml_path', false)
+    arg.setDisplayName('HPXML File Path')
+    arg.setDescription('Absolute/relative path of the HPXML file.')
+    args << arg
+
+    return args
+  end
+
+  # define what happens when the measure is run
+  def run(model, runner, user_arguments)
+    super(model, runner, user_arguments)
+
+    # use the built-in error checking
+    if !runner.validateUserArguments(arguments(model), user_arguments)
+      return false
+    end
+
+    # Assign the user inputs to variables
+    args = runner.getArgumentValues(arguments(model), user_arguments)
+    args = convert_args(arguments(model), args)
+
+    if args[:hvac_heating_shared_system] == 'None' && args[:hvac_cooling_shared_system] == 'None'
+      register_value(runner, 'shared_system_type', 'None')
+      return true
+    end
+
+    systems = { ['Baseboard', 'None'] => 'Boiler Baseboards Heating Only',
+                ['None', 'FanCoil'] => 'Fan Coil Cooling Only',
+                ['FanCoil', 'FanCoil'] => 'Fan Coil Heating and Cooling' }
+    system = systems[[args[:hvac_heating_shared_system], args[:hvac_cooling_shared_system]]]
+    if system.nil?
+      register_value(runner, 'shared_system_type', 'Unsupported')
+      return true
+    end
+
+    if system == 'Boiler Baseboards Heating Only'
+      # method_a(model, args[:hvac_heating_system], args[:hvac_heating_system_fuel])
+
+      model.getSpaces.each do |space|
+        next unless space.name.to_s.include? 'conditioned'
+
+        ee_def = OpenStudio::Model::ElectricEquipmentDefinition.new(model)
+        ee = OpenStudio::Model::ElectricEquipment.new(ee_def)
+        ee.setName("Test Object #{space.name}")
+        ee.setSpace(space)
+        ee_def.setName("Test Object #{space.name}")
+        ee_def.setDesignLevel(100)
+        ee.setSchedule(model.alwaysOnDiscreteSchedule)
+        ee.setEndUseSubcategory('AddSharedSystem')
+      end
+
+    elsif system == 'Fan Coil Cooling Only'
+      # method_b(model, args[:hvac_cooling_system])
+    elsif system == 'Fan Coil Heating and Cooling'
+      # method_c(model, args[:hvac_heating_system], args[:hvac_heating_system_fuel], args[:hvac_cooling_system])
+    end
+
+    register_value(runner, 'shared_system_type', system)
+
+    return true
+  end
+
+  def convert_args(measure_arguments, args)
+    measure_arguments.each do |arg|
+      arg_name = arg.name.to_sym
+      value = args[arg_name]
+      next if value.nil?
+
+      case arg.type.valueName.downcase
+      when 'double'
+        args[arg_name] = Float(value)
+      when 'integer'
+        args[arg_name] = Integer(value)
+      end
+    end
+    return args
+  end
+end
+
+# register the measure to be used by the application
+AddSharedSystem.new.registerWithApplication