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

Correct Input Field Description in Component Sizing Information for Multi-Speed DX Heating Coils #10612

Merged
merged 3 commits into from
Jul 31, 2024
Merged

Correct Input Field Description in Component Sizing Information for Multi-Speed DX Heating Coils #10612

merged 3 commits into from
Jul 31, 2024

Conversation

Nigusse
Copy link
Contributor

@Nigusse Nigusse commented Jul 19, 2024 •
edited
Loading

Pull request overview

NOTE: ENHANCEMENTS MUST FOLLOW A SUBMISSION PROCESS INCLUDING A FEATURE PROPOSAL AND DESIGN DOCUMENT PRIOR TO SUBMITTING CODE

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

@Nigusse Nigusse added the Defect Includes code to repair a defect in EnergyPlus label Jul 19, 2024
Nigusse
Nigusse commented Jul 19, 2024
View reviewed changes
Copy link
Contributor Author

@Nigusse Nigusse left a comment

Choose a reason for hiding this comment

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

Code change walk through.

  • This change corrects the indices of numeric field names of multi-speed DX heating coils. This update was probably missed when a new field was added for the HSPF2 calculation.

src/EnergyPlus/DXCoils.cc
@@ -8290,7 +8290,7 @@ void SizeDXCoil(EnergyPlusData &state, int const DXCoilNum)
CompType = thisDXCoil.DXCoilType;
// Sizing rated air flow rate
if (Mode == thisDXCoil.NumOfSpeeds) {
FieldNum = 12 + (Mode - 1) * 5;
FieldNum = 12 + (Mode - 1) * 6;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Corrected indices to Field Names of multi-speed DX Heating Coils.

src/EnergyPlus/DXCoils.cc
@@ -8313,7 +8313,7 @@ void SizeDXCoil(EnergyPlusData &state, int const DXCoilNum)
bPRINT = true;
}
} else {
FieldNum = 12 + (Mode - 1) * 5;
FieldNum = 12 + (Mode - 1) * 6;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same as above.

src/EnergyPlus/DXCoils.cc
@@ -8407,7 +8407,7 @@ void SizeDXCoil(EnergyPlusData &state, int const DXCoilNum)
if (Mode == thisDXCoil.NumOfSpeeds) {
SizingMethod = HVAC::HeatingCapacitySizing;
state.dataSize->DataFlowUsedForSizing = thisDXCoil.MSRatedAirVolFlowRate(Mode);
FieldNum = 10 + (Mode - 1) * 5;
FieldNum = 10 + (Mode - 1) * 6;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same as above.

src/EnergyPlus/DXCoils.cc
@@ -8448,7 +8448,7 @@ void SizeDXCoil(EnergyPlusData &state, int const DXCoilNum)
} else {
PrintFlag = true;
SizingMethod = HVAC::HeatingCapacitySizing;
FieldNum = 10 + (Mode - 1) * 5;
FieldNum = 10 + (Mode - 1) * 6;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Same as above.

tst/EnergyPlus/unit/DXCoils.unit.cc
@@ -107,7 +107,7 @@ TEST_F(EnergyPlusFixture, DXCoils_Test1)

state->dataDXCoils->DXCoilNumericFields.allocate(state->dataDXCoils->NumDXCoils);
state->dataDXCoils->DXCoilNumericFields(2).PerfMode.allocate(1);
state->dataDXCoils->DXCoilNumericFields(2).PerfMode(1).FieldNames.allocate(17);
state->dataDXCoils->DXCoilNumericFields(2).PerfMode(1).FieldNames.allocate(18);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Modified array size allocation.

tst/EnergyPlus/unit/DXCoils.unit.cc
Component Sizing Information, Coil:Heating:DX:MultiSpeed, ASHP HTG COIL, Design Size Speed 1 Rated Air Flow Rate [m3/s], 0.87500
Component Sizing Information, Coil:Heating:DX:MultiSpeed, ASHP HTG COIL, Design Size Speed 1 Rated Waste Heat Fraction of Power Input [W], 32731.91226
Component Sizing Information, Coil:Heating:DX:MultiSpeed, ASHP HTG COIL, Design Size Speed 2 Gross Rated Heating Capacity [W], 32731.91226
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Modified the text to match the correct input field description in the eio output file.

@Nigusse
Copy link
Contributor Author

Nigusse commented Jul 19, 2024

EIO file results comparison based on the defect file:

Component Sizing Information Before the Fix:

Component Sizing Information, Coil:Heating:DX:MultiSpeed, DX HEATING COIL_UNIT1, Design Size Speed 2 Gross Rated Heating COP [m3/s], 0.39225
Component Sizing Information, Coil:Heating:DX:MultiSpeed, DX HEATING COIL_UNIT1, User-Specified Speed 2 Gross Rated Heating COP [m3/s], 0.49554
Component Sizing Information, Coil:Heating:DX:MultiSpeed, DX HEATING COIL_UNIT1, User-Specified Speed 1 Rated Waste Heat Fraction of Power Input [W], 9760.00000

Component Sizing Information After the Fix:

Component Sizing Information, Coil:Heating:DX:MultiSpeed, DX HEATING COIL_UNIT1, Design Size Speed 2 Rated Air Flow Rate [m3/s], 0.39225
Component Sizing Information, Coil:Heating:DX:MultiSpeed, DX HEATING COIL_UNIT1, User-Specified Speed 2 Rated Air Flow Rate [m3/s], 0.49554
Component Sizing Information, Coil:Heating:DX:MultiSpeed, DX HEATING COIL_UNIT1, User-Specified Speed 2 Gross Rated Heating Capacity [W], 9760.00000

@Nigusse
Copy link
Contributor Author

Nigusse commented Jul 19, 2024

Html file results comparison based on the defect file:

Results before the fix:
image

Results after the fix:
image

@Nigusse
Copy link
Contributor Author

Nigusse commented Jul 19, 2024

Defect file:
in.idf.txt

@Nigusse
Copy link
Contributor Author

Nigusse commented Jul 19, 2024 •
edited
Loading

Diffs are expected in the Component Sizing Information input field descriptions in the EIO and html files. This fix impacts 18 example files with the Coil:Heating:DX:MultiSpeed object. This PR is ready for review.

@Nigusse Nigusse requested a review from Myoldmopar July 19, 2024 16:03
@Nigusse Nigusse added this to the EnergyPlus 24.2 milestone Jul 21, 2024
@mjwitte mjwitte self-assigned this Jul 31, 2024
mjwitte
mjwitte approved these changes Jul 31, 2024
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.

Changes look good (even is they are a bit awkward). eio and table diffs are as expected. This is good to go. Thanks @Nigusse

@mjwitte mjwitte merged commit 342372b into develop Jul 31, 2024
15 checks passed
@mjwitte mjwitte deleted the multispeed_dx_htg_coil_reporting branch July 31, 2024 20:33
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

@mjwitte mjwitte

Labels
Defect Includes code to repair a defect in EnergyPlus
Projects
None yet
Milestone
EnergyPlus 24.2
Development

Successfully merging this pull request may close these issues.

Incorrect Input Field Description in Component Sizing Information in EIO file for Multi-Speed DX Heating Coils
7 participants
@Nigusse @mjwitte @nrel-bot @nrel-bot-2 @nrel-bot-3 @nrel-bot-2b @nrel-bot-2c