Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

EIO transition changes for simple glazing #9179

Merged
merged 6 commits into from
Nov 12, 2021
Merged

EIO transition changes for simple glazing #9179

merged 6 commits into from
Nov 12, 2021

Conversation

xuanluo113
Copy link
Contributor

@xuanluo113 xuanluo113 commented Nov 9, 2021 •
edited
Loading

Pull request overview

Adding Documentation and Transition Change descriptions for the previously merged branch #9117.

Pull Request Author

Add to this list or remove from it as applicable. This is a simple templated set of guidelines.

  • Title of PR should be user-synopsis style (clearly understandable in a standalone changelog context)
  • Label the PR with at least one of: Defect, Refactoring, NewFeature, Performance, and/or DoNoPublish
  • Pull requests that impact EnergyPlus code must also include unit tests to cover enhancement or defect repair
  • Author should provide a "walkthrough" of relevant code changes using a GitHub code review comment process
  • If any diffs are expected, author must demonstrate they are justified using plots and descriptions
  • If changes fix a defect, the fix should be demonstrated in plots and descriptions
  • If any defect files are updated to a more recent version, upload new versions here or on DevSupport
  • If IDD requires transition, transition source, rules, ExpandObjects, and IDFs must be updated, and add IDDChange label
  • If structural output changes, add to output rules file and add OutputChange label
  • If adding/removing any LaTeX docs or figures, update that document's CMakeLists file dependencies

Reviewer

This will not be exhaustively relevant to every PR.

  • Perform a Code Review on GitHub
  • If branch is behind develop, merge develop and build locally to check for side effects of the merge
  • 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
  • Check that performance is not impacted (CI Linux results include performance check)
  • Run Unit Test(s) locally
  • Check any new function arguments for performance impacts
  • Verify IDF naming conventions and styles, memos and notes and defaults
  • If new idf included, locally check the err file and other outputs

@xuanluo113 xuanluo113 added Defect Includes code to repair a defect in EnergyPlus Documentation Related primarily on the LaTeX-based EnergyPlus documentation labels Nov 9, 2021
@xuanluo113 xuanluo113 added this to the EnergyPlus 2022.1 milestone Nov 9, 2021
@xuanluo113 xuanluo113 self-assigned this Nov 9, 2021
@xuanluo113 xuanluo113 mentioned this pull request Nov 9, 2021
Merged
20 tasks
mjwitte
mjwitte reviewed Nov 11, 2021
View reviewed changes
Copy link
Contributor

@mjwitte mjwitte left a comment

Choose a reason for hiding this comment

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

@xuanluo113 A couple of minor comments and a request to fix some existing formatting issues, please, thanks, just for the window construction section, no need to work through other sections.

doc/output-details-and-examples/src/output-files/eplusout-eio.tex Outdated
@@ -2346,7 +2346,7 @@ \subsubsection{Description of the Windows Construction Report}\label{description

\subsubsection{Fields in Part 1 -- Window Construction Report}\label{fields-in-part-1-window-construction-report}

\textbf{Line 1:} ! \textless{}WindowConstruction\textgreater{},Construction Name,\#Layers,Roughness,Conductance \{W/m2-K\},SHGC,SolarTransmittanceNormalIncid,VisibleTransmittanceNormalIncid
\textbf{Line 1:} ! \textless{}WindowConstruction\textgreater{},Construction Name,\#Layers,Roughness,Conductance \{W/m2-K\},Conductance (Before Adjusted) \{W/m2-K\},Convection Coefficient Adjustment Ratio,SHGC,SolarTransmittanceNormalIncid,VisibleTransmittanceNormalIncid
Copy link
Contributor

Choose a reason for hiding this comment

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

The section below here include a description of each "field". Please add descriptions for the 2 new fields.

Copy link
Contributor

Choose a reason for hiding this comment

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

Also, since you're working in this file already, please update the old names "Material:WindowGlass" etc. to "WindowMaterial:Glazing" etc.

Copy link
Contributor

Choose a reason for hiding this comment

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

And it would be nice to use \begin{lstlisting} style for the sample eio lines (e.g. Chiller Standard Rating Information).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mjwitte I added the field descriptions and modified the list to \begin{lstlisting}. Can you please take a look if that's what you mean?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For the old "Material:WindowGlass" parts, I'm not following. Does it mean the Material:WindowGlass section should be deleted as Window Constructions section is a replacement?

Besides, part 2 fields in Window Constructions seem to be duplicated with part 1.

Copy link
Contributor

Choose a reason for hiding this comment

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

No, part 2 is for the material layers which follow for each WindowConstruction line. All I was asking for here was to substitute 3 instances of "Material:WindowGlass" (which is from long long ago) to "WindowMaterial:Glazing". And likewise for Material:WindowGas, Material:WindowShade, Material:WindowBlind, and Material:WindowScreen.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hope the latest commit fixed it.

src/Transition/OutputRulesFiles/OutputChanges9-6-0-to-9-7-0.md Outdated
### WindowConstruction EIO Fields Change
Two fields are added to the Description of the Windows Report - "WindowConstruction", namely "Construction Report Conductance (Before Adjusted) {W/m2-K}" and "Convection Coefficient Adjustment Ratio". They represent the glazing-only nominal U (nominal conductance in winter) and the adjustment ratio assuming highly conductive frames are applied along with the glazing.

See PR [#8653](https://github.com/NREL/EnergyPlus/pull/8653).
Copy link
Contributor

Choose a reason for hiding this comment

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

Also reference #9117 since that's when the actual eio output changes were made.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

mjwitte
mjwitte reviewed Nov 12, 2021
View reviewed changes
doc/output-details-and-examples/src/output-files/eplusout-eio.tex

\subsubsection{Field: Convection Coefficient Adjustment Ratio}\label{field-convection-coefficient-adjustment-ratio}

For simple glazing (WindowMaterial:SimpleGlazingSystem), this is the adjustment ratio to both inside and outside window film coefficients assuming highly conducting frames are applied to achieve a high Nominal U-Factor. The adjustment ratio is calculated such that the glazing-only conductance evaluated at winter conditions equals the input Nominal U-Factor.
Copy link
Contributor

Choose a reason for hiding this comment

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

@xuanluo113 I did some more cleanup and updated the text for this field. Please confirm if this is accurate.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mjwitte Reads great.

@mjwitte mjwitte merged commit 0eb3e9c into develop Nov 12, 2021
@mjwitte mjwitte deleted the simple-glazing-follow-up branch November 12, 2021 19:03
yujiex pushed a commit that referenced this pull request Jan 27, 2022
@mjwitte
Merge pull request #9179 from NREL/simple-glazing-follow-up
474e055 
EIO transition changes for simple glazing
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mjwitte mjwitte mjwitte approved these changes

@Myoldmopar Myoldmopar Awaiting requested review from Myoldmopar

Assignees

@xuanluo113 xuanluo113

Labels
Defect Includes code to repair a defect in EnergyPlus Documentation Related primarily on the LaTeX-based EnergyPlus documentation
Projects
None yet
Milestone
EnergyPlus 22.1
Development

Successfully merging this pull request may close these issues.
7 participants
@xuanluo113 @mjwitte @nrel-bot @nrel-bot-2 @nrel-bot-3 @nrel-bot-2b @nrel-bot-2c