Appendix G dev swh single building #1692

lzwang26 · 2024-02-20T22:38:53Z

Pull request overview

Fixes #ISSUENUMBERHERE (IF THIS IS A DEFECT)

Pull Request Author

Method changes or additions
Data changes or additions
Added tests for added methods
If methods have been deprecated, update rest of code to use the new methods
Documented new methods using yard syntax
Resolved yard documentation errors for new code (ran bundle exec rake doc)
Resolved rubocop syntax errors for new code (ran bundle exec rake rubocop)
All new and existing tests passes
If the code adds new require statements, ensure these are in core ruby or add to the gemspec

Review Checklist

This will not be exhaustively relevant to every PR.

Perform a code review on GitHub
All related changes have been implemented: method additions, changes, tests
Check rubocop errors
Check yard doc errors
If fixing a defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
If a new feature, test the new feature and try creative ways to break it
CI status: all green or justified

weilixu

Some comments need to address

weilixu · 2024-02-21T15:34:36Z

...tudio-standards/standards/ashrae_90_1_prm/ashrae_90_1_prm_2019/ashrae_90_1_prm_2019.Model.rb

+      wateruse_equipment_hash[wateruse_equipment.name.get.to_s] = wateruse_equipment.additionalProperties.getFeatureAsString('building_type_swh').to_s
+    end
+
+    # If there is additional properties, test uniq user data.


Comment does not seem matching the code below.

Revised the comments.

weilixu · 2024-02-21T15:37:22Z

...tudio-standards/standards/ashrae_90_1_prm/ashrae_90_1_prm_2019/ashrae_90_1_prm_2019.Model.rb

+    # Get the building area type from the additional properties of wateruse_equipment
+    wateruse_equipment_hash = {}
+    model.getWaterUseEquipments.each do |wateruse_equipment|
+      wateruse_equipment_hash[wateruse_equipment.name.get.to_s] = wateruse_equipment.additionalProperties.getFeatureAsString('building_type_swh').to_s


It is suggested using the get_additional_property_as_string function to retrieve a string additional properties.
See the function signature in the utilities/assertion.rb

Modified the code to use get_additional_property_as_string.

weilixu · 2024-02-21T15:43:10Z

...tudio-standards/standards/ashrae_90_1_prm/ashrae_90_1_prm_2019/ashrae_90_1_prm_2019.Model.rb

+      end
+    else
+      # Todo: service water heater with multiple building area type
+      puts "Todo: service water heater with multiple building area type"


Don't use puts here.
If it is not implemented, just leave as it is with a # todo comment.
I would comment out the if-else statement as well since it is not completed.

Deleted puts and comment out the if-else statement.

weilixu · 2024-02-21T15:46:36Z

...ards/standards/ashrae_90_1_prm/ashrae_90_1_prm_2019/ashrae_90_1_prm_2019_WaterHeaterMixed.rb

+      comp_qty = water_heater_mixed.additionalProperties.getFeatureAsInteger('component_quantity').get
+    else
+      comp_qty = 1
+    end


Using the get_additional_property_as_integer can replace the above code block to:

comp_qty = get_additional_property_as_integer(water_heater_mixed, 'component_quantity', 1)

To avoid duplication, use the existing water_heater_mixed_apply_efficiency function in Standards.WaterHeaterMixed.rb instead of developing a new function.

weilixu · 2024-02-21T15:48:17Z

...ards/standards/ashrae_90_1_prm/ashrae_90_1_prm_2019/ashrae_90_1_prm_2019_WaterHeaterMixed.rb

+    # Get the capacity of the water heater
+    capacity_w = water_heater_mixed.heaterMaximumCapacity
+    if capacity_w.empty?
+      OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.WaterHeaterMixed', "For #{water_heater_mixed.name}, cannot find capacity, standard will not be applied.")


Update the Warn to Error

To avoid duplication, use the existing water_heater_mixed_apply_efficiency function in Standards.WaterHeaterMixed.rb instead of developing a new function.

weilixu · 2024-02-21T15:58:10Z

...ards/standards/ashrae_90_1_prm/ashrae_90_1_prm_2019/ashrae_90_1_prm_2019_WaterHeaterMixed.rb

+      search_criteria['draw_profile'] = "medium"
+      wh_props = model_find_object(standards_data['water_heaters'], search_criteria, capacity = capacity_btu_per_hr, date = nil, area = nil, num_floors = nil, fan_motor_bhp = nil, volume = volumn_gal)
+      unless wh_props
+        OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.WaterHeaterMixed', "For #{water_heater_mixed.name}, cannot find water heater properties, cannot apply efficiency standard.")


Update the Warn to Error

To avoid duplication, use the existing water_heater_mixed_apply_efficiency function in Standards.WaterHeaterMixed.rb instead of developing a new function.

weilixu · 2024-02-21T16:04:10Z

...ards/standards/ashrae_90_1_prm/ashrae_90_1_prm_2019/ashrae_90_1_prm_2019_WaterHeaterMixed.rb

+        return false
+      end
+      uniform_energy_factor_base = wh_props['uniform_energy_factor_base']
+      uniform_energy_factor_volume_allowance = wh_props['uniform_energy_factor_volume_allowance']


I do not see these two data in the water_heaters dataset. Could you verify and let me know which data file I should look into?

The dataset is at \lib\openstudio-standards\standards\ashrae_90_1_prm\ashrae_90_1_prm_2019\data\ashrae_90_1_prm_2019.water_heaters.json.

weilixu · 2024-02-21T16:21:00Z

...ards/standards/ashrae_90_1_prm/ashrae_90_1_prm_2019/ashrae_90_1_prm_2019_WaterHeaterMixed.rb

+    if ua_btu_per_hr_per_f.nil?
+      OpenStudio.logFree(OpenStudio::Warn, 'openstudio.standards.WaterHeaterMixed', "For #{water_heater_mixed.name}, cannot calculate UA, cannot apply efficiency standard.")
+      return false
+    end


The above two checks will never reached because the if-else statement covers all scenarios. It is OK to skip the check.

To avoid duplication, use the existing water_heater_mixed_apply_efficiency function in Standards.WaterHeaterMixed.rb instead of developing a new function.

weilixu · 2024-02-21T16:31:55Z

...tudio-standards/standards/ashrae_90_1_prm/ashrae_90_1_prm_2019/ashrae_90_1_prm_2019.Model.rb

+    original_water_heater_info_hash = {}
+    model.getWaterHeaterMixeds.sort.each do |water_heater|
+      original_water_heater_info_hash = {water_heater.name.get.to_s => model_get_object_hash(water_heater)}
+    end


Why do we need the original water heater info? Is it designed for the multi SHW workflow?

Yes, it is for multi SHW. Maybe we could move it next to the multi SWH code.

weilixu · 2024-02-21T16:36:24Z

...tudio-standards/standards/ashrae_90_1_prm/ashrae_90_1_prm_2019/ashrae_90_1_prm_2019.Model.rb

+      else
+        matching_objects = matching_volume_objects
+      end
+    end


I still don't quite understand why the volume needs to code the same as the capacity. It is based on the data form? You can coordinate with Jeremy on the new PRM data.
In addition, I cannot find a water heater data file in the repo that has volume. Could you check it again?

Now we are using a new model_find_object function in Standards.Model.rb (line 2509) developed by Jeremy.

… property.

…ponent quantity.

…andards into AppendixG_Dev_swh_single_building

weilixu · 2024-03-25T15:49:38Z

Appx G is merged, please merge Appx G to this branch. Thanks! @lzwang26

…andards into AppendixG_Dev_swh_single_building

…into AppendixG_Dev_swh_single_building_merge_test

…andards into AppendixG_Dev_swh_single_building

…m/NREL/openstudio-standards into AppendixG_Dev_swh_single_building

weilixu · 2024-05-07T19:48:37Z

...tudio-standards/standards/ashrae_90_1_prm/ashrae_90_1_prm_2019/ashrae_90_1_prm_2019.Model.rb

+          end
+        end
+      end
+    else


suggest commenting out the else for now.

weilixu · 2024-05-07T21:03:29Z

...ards/standards/ashrae_90_1_prm/ashrae_90_1_prm_2019/ashrae_90_1_prm_2019_WaterHeaterMixed.rb

+    # There are only two water heater fuel type in the prm database:
+    # ("Gas Storage" and "Electric Resistance Storage")
+    # Change the prm fuel type to openstudio fuel type
+    if new_fuel_data == "Gas Storage"


I would like to start using enums instead of strings.
Do this:
new_fuel = OpenStudio::FuelType::new('NaturalGas')

Keep using string as discussed.

weilixu · 2024-05-07T21:04:50Z

...ards/standards/ashrae_90_1_prm/ashrae_90_1_prm_2019/ashrae_90_1_prm_2019_WaterHeaterMixed.rb

+  # Apply the prm fuel type to a water heater based on the
+  # building area type.
+  # @param building_type [String] the building type (For consistency with the standard class, not used in the method)
+  # @return [string] returns the new fuel


Use enum
@return [OpenStudio::FuelType] returns fuel type

Keep using string as discussed.

weilixu · 2024-05-08T15:53:41Z

...ards/standards/ashrae_90_1_prm/ashrae_90_1_prm_2019/ashrae_90_1_prm_2019_WaterHeaterMixed.rb

+    if new_fuel_data == "Gas Storage"
+      new_fuel = "NaturalGas"
+    else
+      new_fuel = "Electricity"


Use single quote for strings 'Electricity'

lzwang26 added 8 commits February 20, 2024 14:15

Add check_swh_single_building_type() in prm_check.rb

d6b87f3

Add test_swh_single_building_type in test_appendix_g_prm.rb

1136187

Add swh_single_building_type data to prototype_list.json

0789749

Modify the model_apply_baseline_swh_loops() in Standards.Model.rb

49a70a0

Modify ashrae_90_1_prm_2019.Model.rb

d1c39f1

Add ashrae_90_1_prm_2019_WaterHeaterMixed.rb

4373118

Modify openstudio-standards.rb

7a2b8ab

Update water heater data

47fdc19

lzwang26 requested a review from weilixu February 20, 2024 22:38

weilixu reviewed Feb 21, 2024

View reviewed changes

lzwang26 added 13 commits February 22, 2024 08:28

Modified the comment.

5a96948

Use get_additional_property_as_string to retrieve a string additional…

0b13eb8

… property.

Delete puts. Comment out if-else statement.

70b087b

Use get_additional_property_as_integer() to retrieve water heater com…

8b20f11

…ponent quantity.

Update the Warn to Error.

8048cc3

Update the Warn to Error.

7a3aff4

Delete the checks for efficiency and surface loss coefficient.

a9fa54d

Merge branch 'AppendixG_Dev' of https://github.com/NREL/openstudio-st…

52bb35d

…andards into AppendixG_Dev_swh_single_building

Solve conflicts and merge

3e82d1f

Modify single swh model_apply_water_heater_prm_parameter()

b60765e

Add the function water_heater_mixed_apply_prm_baseline_fuel_type()

4f9de06

Remove model_find_object() in prm_2019.

8e76845

Fix an issue.

3e5dd2f

lzwang26 added 3 commits March 26, 2024 11:42

Merge branch 'AppendixG_Dev' of https://github.com/NREL/openstudio-st…

70ba3bb

…andards into AppendixG_Dev_swh_single_building

Update fuel type function.

d3c5c99

Update fuel type function.

93e47dd

lymereJ mentioned this pull request Apr 4, 2024

Appendix G updates #1719

Merged

15 tasks

mdahlhausen changed the title ~~Appendix g dev swh single building~~ Appendix G dev swh single building Apr 9, 2024

Merge branch 'master' of https://github.com/NREL/openstudio-standards …

08ca98a

…into AppendixG_Dev_swh_single_building_merge_test

lzwang26 and others added 7 commits April 30, 2024 08:22

Modify single building type swh

134e463

Modify single building type swh

9848c1c

Merge branch 'AppendixG_Dev' into AppendixG_Dev_swh_single_building

1a14429

Merge branch 'AppendixG_Dev' of https://github.com/NREL/openstudio-st…

7f801c9

…andards into AppendixG_Dev_swh_single_building

Pull AppendixG_Dev and update single building type swh

dfdc686

Merge branch 'AppendixG_Dev_swh_single_building' of https://github.co…

6fab85f

…m/NREL/openstudio-standards into AppendixG_Dev_swh_single_building

Modify comments

8e451f5

weilixu reviewed May 8, 2024

View reviewed changes

Update single building type swh

a346a74

weilixu merged commit f8d9c23 into AppendixG_Dev May 13, 2024
1 of 2 checks passed

mdahlhausen mentioned this pull request Sep 9, 2024

PRM: gracefully handle Service Hot Water Loops #96

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Appendix G dev swh single building #1692

Appendix G dev swh single building #1692

lzwang26 commented Feb 20, 2024 •

edited

Loading

weilixu left a comment

weilixu Feb 21, 2024

lzwang26 Mar 21, 2024

weilixu Feb 21, 2024

lzwang26 Mar 21, 2024

weilixu Feb 21, 2024

lzwang26 Mar 21, 2024

weilixu Feb 21, 2024

lzwang26 Mar 21, 2024

weilixu Feb 21, 2024

lzwang26 Mar 21, 2024

weilixu Feb 21, 2024

lzwang26 Mar 21, 2024

weilixu Feb 21, 2024

lzwang26 Mar 21, 2024

weilixu Feb 21, 2024

lzwang26 Mar 21, 2024

weilixu Feb 21, 2024

lzwang26 Mar 21, 2024

weilixu Feb 21, 2024

lzwang26 Mar 21, 2024

weilixu commented Mar 25, 2024

weilixu May 7, 2024

lzwang26 May 9, 2024

weilixu May 7, 2024

lzwang26 May 9, 2024

weilixu May 7, 2024

lzwang26 May 9, 2024

weilixu May 8, 2024

lzwang26 May 9, 2024

Appendix G dev swh single building #1692

Appendix G dev swh single building #1692

Conversation

lzwang26 commented Feb 20, 2024 • edited Loading

Pull request overview

Pull Request Author

Review Checklist

weilixu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

weilixu commented Mar 25, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lzwang26 commented Feb 20, 2024 •

edited

Loading