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.

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

Fix Emission Output Variable Names "Environmental Impact OtherFuel1 CO2 Water Consumption Volume" and "Environmental Impact OtherFuel2 CO2 Water Consumption Volume" #9089

Merged
merged 5 commits into from
Dec 9, 2021

Conversation

matthew-larson
Copy link
Contributor

Pull request overview

  • Fixes Report variable Environmental Impact OtherFuel1 CO2 Water Consumption Volume makes no sense #9069
  • This pull request corrects the output variable strings "Environmental Impact OtherFuel1 CO2 Water Consumption Volume" and "Environmental Impact OtherFuel2 CO2 Water Consumption Volume" by removing the "CO2" portion of the string.
  • This also creates a new unit test file for PullutionModule.unit.cc and a unit test for the SetupPollutionMeterReporting function that checks the output variables.

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

@matthew-larson matthew-larson added Defect Includes code to repair a defect in EnergyPlus NotIDDChange Code does not impact IDD (can be merged after IO freeze) labels Sep 22, 2021
@matthew-larson matthew-larson added this to the EnergyPlus 2022.1 milestone Sep 22, 2021
@matthew-larson matthew-larson self-assigned this Sep 22, 2021
@matthew-larson matthew-larson marked this pull request as ready for review September 24, 2021 16:33
@nrel-bot-3
Copy link

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

Copy link
Member

@Myoldmopar Myoldmopar left a comment

Choose a reason for hiding this comment

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

Could the reformatting be pulled out of here? If we need to do a broad reformatting of files, let's do it in a single commit on a single PR so we can then add it to the git commit skip file. I haven't tested this branch, but if I understand the intent, then the tiny fix is quite reasonable. Let me know if you want me to pull back the changes in that file.

@@ -4242,7 +4242,7 @@ void SetupPollutionMeterReporting(EnergyPlusData &state)
_,
"");
SetupOutputVariable(state,
"Environmental Impact OtherFuel2 CO2 Water Consumption Volume",
"Environmental Impact OtherFuel2 Water Consumption Volume",
Copy link
Member

Choose a reason for hiding this comment

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

OK

if(USE_GLYCOL_CACHING)
add_definitions("-DEP_cache_GlycolSpecificHeat")
endif()
if (USE_GLYCOL_CACHING)
Copy link
Member

Choose a reason for hiding this comment

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

Is there a reason this file was reformatted here? Should've just been a one line addition for the new unit test file...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

CLion kept forcing this on me when I was updating this file for the one line addition. If it's an issue, I can try to revert this back and do this manually to not effect the formatting.

@Myoldmopar
Copy link
Member

I'll take out the formatting changes, but this will also need a line in the transition output variables csv file. That file isn't created yet. I need to make the new version number change, then I'll fix this one up.

@nrel-bot-3
Copy link

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

@Myoldmopar
Copy link
Member

Alright, got the formatting issue taken care of, and added these report variables to the appropriate support file. I think this one also might be good to go now.

@Myoldmopar
Copy link
Member

Pulling develop into this now locally to do final testing but if it passes I'll get this one merged next.

@Myoldmopar
Copy link
Member

Good to go, pulled develop and tested. Merging this one too.

@Myoldmopar Myoldmopar merged commit 2e46e2f into NREL:develop Dec 9, 2021
@Myoldmopar Myoldmopar deleted the fix-emissions-variables branch December 9, 2021 21:39
yujiex pushed a commit that referenced this pull request Jan 27, 2022
Fix Emission Output Variable Names "Environmental Impact OtherFuel1 CO2 Water Consumption Volume" and "Environmental Impact OtherFuel2 CO2 Water Consumption Volume"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Defect Includes code to repair a defect in EnergyPlus NotIDDChange Code does not impact IDD (can be merged after IO freeze)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Report variable Environmental Impact OtherFuel1 CO2 Water Consumption Volume makes no sense
7 participants