Skip to content

Fix #5339 - Fixup Idd units m3/s -> gal/min#5346

Merged
jmarrec merged 1 commit intodevelopfrom
5339_IDDUnits
Jan 15, 2025
Merged

Fix #5339 - Fixup Idd units m3/s -> gal/min#5346
jmarrec merged 1 commit intodevelopfrom
5339_IDDUnits

Conversation

@jmarrec
Copy link
Copy Markdown
Collaborator

@jmarrec jmarrec commented Jan 14, 2025

Pull request overview

Temporarily changed the ruby script

diff --git a/developer/ruby/FindAndAddMissingIPUnits.rb b/developer/ruby/FindAndAddMissingIPUnits.rb
index ba4d846c89..0459f3bd1c 100644
--- a/developer/ruby/FindAndAddMissingIPUnits.rb
+++ b/developer/ruby/FindAndAddMissingIPUnits.rb
@@ -46,8 +46,8 @@ iddWrapper = oIddFile.get
 def apply_water_flow_rate(iddWrapper)

   puts "Looking for missing gal/min in Water Flow Rate fields"
-  include_words = ['water', 'flow', 'rate']
-  exclude_words = ['ratio', 'fraction', 'curve', 'length', 'mass']
+  include_words = ['flow', 'rate']
+  exclude_words = ['air', 'ratio', 'fraction', 'curve', 'length', 'mass', ' per ', 'schedule', 'method']

   n_missing = 0

Pull Request Author

  • Model API Changes / Additions
  • Any new or modified fields have been implemented in the EnergyPlus ForwardTranslator (and ReverseTranslator as appropriate)
  • Model API methods are tested (in src/model/test)
  • EnergyPlus ForwardTranslator Tests (in src/energyplus/Test)
  • If a new object or method, added a test in NREL/OpenStudio-resources: Add Link
  • If needed, added VersionTranslation rules for the objects (src/osversion/VersionTranslator.cpp)
  • Verified that C# bindings built fine on Windows, partial classes used as needed, etc.
  • All new and existing tests passes
  • If methods have been deprecated, update rest of code to use the new methods

Labels:

  • If change to an IDD file, add the label IDDChange
  • If breaking existing API, add the label APIChange
  • If deemed ready, add label Pull Request - Ready for CI so that CI builds your PR

Review Checklist

This will not be exhaustively relevant to every PR.

  • Perform a Code Review on GitHub
  • Code Style, strip trailing whitespace, etc.
  • All related changes have been implemented: model changes, model tests, FT changes, FT tests, VersionTranslation, OS App
  • Labeling is ok
  • If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
  • If feature, test running new feature, try creative ways to break it
  • CI status: all green or justified

@jmarrec
FIx #5339 - Fixup Idd units m3/s -> gal/min
318d772 
Temporarily changed the ruby script

```diff
diff --git a/developer/ruby/FindAndAddMissingIPUnits.rb b/developer/ruby/FindAndAddMissingIPUnits.rb
index ba4d846..0459f3bd1c 100644
--- a/developer/ruby/FindAndAddMissingIPUnits.rb
+++ b/developer/ruby/FindAndAddMissingIPUnits.rb
@@ -46,8 +46,8 @@ iddWrapper = oIddFile.get
 def apply_water_flow_rate(iddWrapper)

   puts "Looking for missing gal/min in Water Flow Rate fields"
-  include_words = ['water', 'flow', 'rate']
-  exclude_words = ['ratio', 'fraction', 'curve', 'length', 'mass']
+  include_words = ['flow', 'rate']
+  exclude_words = ['air', 'ratio', 'fraction', 'curve', 'length', 'mass', ' per ', 'schedule', 'method']

   n_missing = 0

```
@jmarrec jmarrec added Enhancement Request Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge. IDDChange labels Jan 14, 2025
@jmarrec jmarrec self-assigned this Jan 14, 2025
jmarrec
jmarrec commented Jan 14, 2025
View reviewed changes
resources/model/OpenStudio.idd
\autosizable
\minimum> 0
\units m3/s
\ip-units gal/min
Copy link
Copy Markdown
Collaborator Author

@jmarrec jmarrec Jan 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://bigladdersoftware.com/epx/docs/24-2/input-output-reference/group-plant-equipment.html#field-design-flow-rate

Field: Design Flow Rate
The volumetric design flow rate of the water side in [m3/s].

resources/model/OpenStudio.idd
\autosizable
\minimum> 0
\units m3/s
\ip-units gal/min
Copy link
Copy Markdown
Collaborator Author

@jmarrec jmarrec Jan 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same

resources/model/OpenStudio.idd
\required-field
\type real
\units m3/s
\ip-units gal/min
Copy link
Copy Markdown
Collaborator Author

@jmarrec jmarrec Jan 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://bigladdersoftware.com/epx/docs/24-2/input-output-reference/group-condenser-equipment.html#groundheatexchangerhorizontaltrench

Field: Design Flow Rate [m3/s]
This numeric field is the designed flow rate for this heat exchanger; the plant loop solver will attempt to meet this request based on flow and loop conditions.

resources/model/OpenStudio.idd
\note Not yet implemented
\type real
\units m3/s
\ip-units gal/min
Copy link
Copy Markdown
Collaborator Author

@jmarrec jmarrec Jan 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Being thorough:

Field: Heater Ignition Minimum Flow Rate
NOT YET IMPLEMENTED.

resources/model/OpenStudio.idd
\type real
\minimum> 0
\units m3/s
\ip-units gal/min
Copy link
Copy Markdown
Collaborator Author

@jmarrec jmarrec Jan 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://bigladdersoftware.com/epx/docs/24-2/input-output-reference/group-solar-collectors.html#field-test-flow-rate

Field: Test Flow Rate
The volumetric flow rate during testing [m3/s]. If the value is available as flow rate per unit area, it is recommended to multiply by the Gross Area of the collector module, not the net aperture area.

resources/model/OpenStudio.idd
\type real
\minimum> 0
\units m3/s
\ip-units gal/min
Copy link
Copy Markdown
Collaborator Author

@jmarrec jmarrec Jan 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Specific fix for the "Design Flow Rate" field of the SolarCollectorFlatPlate mentioned in #5339

resources/model/OpenStudio.idd
\type real
\minimum> 0
\units m3/s
\ip-units gal/min
Copy link
Copy Markdown
Collaborator Author

@jmarrec jmarrec Jan 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same for OS:SolarCollectorPerformance:IntegralCollectorStorage,

@ci-commercialbuildings
Copy link
Copy Markdown
Collaborator

ci-commercialbuildings commented Jan 14, 2025 •
edited
Loading

CI Results for 318d772:

@jmarrec jmarrec merged commit f5e77a2 into develop Jan 15, 2025
@jmarrec jmarrec deleted the 5339_IDDUnits branch January 15, 2025 06:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@joseph-robertson joseph-robertson joseph-robertson approved these changes

Assignees

@jmarrec jmarrec

Labels

Enhancement Request IDDChange Pull Request - Ready for CI This pull request if finalized and is ready for continuous integration verification prior to merge.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Update IDD fields for water equipment to have \ip-units gal/min

3 participants

@jmarrec @ci-commercialbuildings @joseph-robertson