Modify sizing string prefix from "Design Size" to "Autosized" for more clarity in table headers and sizing outputs

[matthew-larson]

Pull request overview

• Fixes Component Sizing Summary Report table headers are redundant in using the word "Design" #8790
• To prevent redundant table header words and provide more consistency and clarity in tables and sizing outputs, I recommended replacing the "Design Size" prefix with "Autosized" in all sizing output strings. I'm open to other suggestions in prefixes but I feel this aligns more with its counter prefix "User-Specified" for hardsized values. Below shows the Before and After for a couple example tables (ignore difference in actual values).

Before:

After:

Before:

After:

Before:

After:

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

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
• CI status: all green or justified
• Check that performance is not impacted (CI Linux results include performance check)
• Run Unit Test(s) locally

[nealkruis]

@mjwitte we want to get your thoughts on this. Is there some historical context to calling things "Design Size" that we're missing here?

[mjwitte]

@nealkruis A long time ago, in a galaxy far, far away, EnergyPlus only reported the final answer without distinguishing between autosized and user-specified values. When the dual reporting was added (so users could see if the user-specified value was wildly different from what the auto-sized value would have been and throw warnings about that), the prefixes "Design Size" and "User-Specified" were chosen. I don't recall if there was some debate that steered away from "Autosized". @rraustad or @EnergyArchmage might remember.

[EnergyArchmage]

Not all "Design Size" values are actually used as Autosized values. This whole thing seems suspect. The idea is that users may hard size something that E+ is able to autosize and that their input may be very different from the design size calcs and we can do them a service by pointing out what the autosize value would be were the input set to autosize. I haven't taken a close look at this but it seems to create more problems.

[nealkruis]

@EnergyArchmage, I think I understand but I want to clarify: Are "Design Sizes" ever calculated if sizing is turned off? I think the point that you are making is that just because something is sized with the autosizing routines doesn't mean that the size will automatically be set. That is, in some cases it is simply provided as a point of comparison. I think "Autosized" will mean more to users than "Design Size" even if there are some semantics that are not technically accurate about it.

This change will cause problems for people parsing the output tables, but it would be covered in the output transition document for the next version just like every other breaking output change.

Thoughts?

[EnergyArchmage]

well I am not convinced the "issue" here is a defect. The dude: "Yeah, well, that's just, like, your opinion, man."

There may be/are places where the implementation is not uniform but yes the policy is that the "Design Size" is not always calculated if there is no sizing. Is repeating Autosize better than repeating Design Size?

[nrel-bot]

@matthew-larson @lgentile it has been 28 days since this pull request was last updated.

[nrel-bot]

@matthew-larson @lgentile it has been 28 days since this pull request was last updated.

[Myoldmopar]

@matthew-larson I marked this for the IO Freeze milestone because of the string change. I expect some interfaces and other tools might search in the output by string, and this has the potential to affect that. So getting it in for IO freeze (or punting until next release) will be important. Let me know if you need to chat about it. Thanks!

[matthew-larson]

@Myoldmopar After some discussion, we're going to go ahead and push this off until after the release to get a better plan going forward.

[nrel-bot]

@matthew-larson @lgentile it has been 28 days since this pull request was last updated.

[nrel-bot]

@matthew-larson @lgentile it has been 28 days since this pull request was last updated.

[nrel-bot-2]

@matthew-larson @lgentile it has been 28 days since this pull request was last updated.

[nrel-bot-2]

@matthew-larson @lgentile it has been 28 days since this pull request was last updated.

[nrel-bot-3]

@matthew-larson @lgentile it has been 28 days since this pull request was last updated.

[nrel-bot-3]

@matthew-larson @lgentile it has been 28 days since this pull request was last updated.

[nrel-bot-2]

@matthew-larson it has been 7 days since this pull request was last updated.

[nrel-bot-2]

@matthew-larson it has been 8 days since this pull request was last updated.

[nrel-bot-2]

@matthew-larson it has been 7 days since this pull request was last updated.

[nrel-bot-2]

@matthew-larson it has been 15 days since this pull request was last updated.

[nrel-bot-2]

@matthew-larson it has been 9 days since this pull request was last updated.

[nrel-bot-2]

@matthew-larson it has been 9 days since this pull request was last updated.

[nrel-bot-2]

@matthew-larson it has been 8 days since this pull request was last updated.

[nrel-bot-2c]

@matthew-larson it has been 14 days since this pull request was last updated.

[nrel-bot-2c]

@matthew-larson it has been 12 days since this pull request was last updated.

[nrel-bot-2c]

@matthew-larson it has been 8 days since this pull request was last updated.

[nrel-bot-2]

@matthew-larson it has been 8 days since this pull request was last updated.

[nrel-bot-2c]

@matthew-larson it has been 10 days since this pull request was last updated.

[nrel-bot-2c]

@matthew-larson it has been 12 days since this pull request was last updated.

[nrel-bot-2]

@matthew-larson it has been 59 days since this pull request was last updated.

[nrel-bot-2c]

@matthew-larson it has been 7 days since this pull request was last updated.

[nrel-bot-2c]

@matthew-larson it has been 7 days since this pull request was last updated.

[nrel-bot-2c]

@matthew-larson it has been 7 days since this pull request was last updated.

[nrel-bot-2]

@matthew-larson it has been 7 days since this pull request was last updated.

[nrel-bot-2c]

@matthew-larson it has been 7 days since this pull request was last updated.

[nrel-bot-2]

@matthew-larson it has been 7 days since this pull request was last updated.

[nrel-bot-2]

@matthew-larson it has been 7 days since this pull request was last updated.

[nrel-bot-2c]

@matthew-larson it has been 7 days since this pull request was last updated.

[nrel-bot-2]

@matthew-larson it has been 7 days since this pull request was last updated.

[nrel-bot-2]

@matthew-larson it has been 7 days since this pull request was last updated.

[nrel-bot-2c]

@matthew-larson it has been 7 days since this pull request was last updated.

[nrel-bot-2]

@matthew-larson it has been 7 days since this pull request was last updated.

[nrel-bot-2c]

@matthew-larson it has been 7 days since this pull request was last updated.

[nrel-bot-2c]

@matthew-larson it has been 7 days since this pull request was last updated.

[nrel-bot-2c]

@matthew-larson it has been 7 days since this pull request was last updated.

[nrel-bot-2c]

@matthew-larson it has been 8 days since this pull request was last updated.