Skip to content

Conversation

@RKStrand
Copy link
Contributor

Pull request overview

  • Fixes Availability Manager List Name for AirLoopHVAC:OutdoorAirSystem not working #8814
  • When the AirLoopHVAC:OutdoorAirSystem was implemented, it had an input field for an availability manager. While it read that in and made sure that availability manager existed in the idf, it never actually did anything else with that information or even assign it to the local data structure. There was nothing in place in the code to support using that information had it been assigned. The IORef had a statement that basically said it was ignored by EnergyPlus. Testing showed that it didn't matter what was entered for this field--the results were always the same. This work removed this input since it wasn't being used by the code. This involved changing the E+ code, creating a new unit test call from within an existing test, modifying both the transition and the expand objects programs, editing over 300 idf files to remove this line, and removing this text for this unused field from the IORef. No differences are noted in the test suite (because this field was never used anyway--confirming again that this field was not being used). Two input files show differences, but those differences are valid.

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

RKStrand added 3 commits July 9, 2021 10:24
Code, IDD, and IDF (many) changes to get rid of the unused last input field for the AirLoopHVAC:OutdoorAirSystem.  Also had to change many unit tests to account for this change.  Added a unit very basic unit test to read the input.
This commit includes changes to the transition and expand objects programs, modified documentation, and many more idfs that were missed in Part 1.
Correction to two more input files.  Hopefully the last ones.
@RKStrand RKStrand added the Defect Includes code to repair a defect in EnergyPlus label Jul 13, 2021
@RKStrand RKStrand requested review from Myoldmopar and mjwitte July 13, 2021 13:01
@RKStrand RKStrand self-assigned this Jul 13, 2021
@Myoldmopar
Copy link
Member

Anyone have any problem with this change? Removing an unused field is acceptable to me, I just don't want to accept this and someone immediately mention that they are about to implement the availability manager logic to make the field used... I'll hold on this for now, but if I don't hear anything soon then I'll get this pulled up with develop for final review.

@RKStrand
Copy link
Contributor Author

@Myoldmopar I posted this on Slack just over a week ago and the only reply I got was from @mjwitte who was okay with getting rid of it. If you want to let this sit for a little while longer, that's fine.

@Myoldmopar
Copy link
Member

If you want to let this sit for a little while longer, that's fine.

Oh I don't. 😄 I'll take a final look and test it and get it merged in. I knew I had seen a conversation about it, but I didn't see it here on the PR so I thought I was making it up...

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.

👍 Not much to say, this is good to go.

\type object-list
\object-list ControllerLists
A3, \field Outdoor Air Equipment List Name
A3; \field Outdoor Air Equipment List Name
Copy link
Member

Choose a reason for hiding this comment

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

👍

PSZ-AC:1_OA_Controllers, !- Controller List Name
PSZ-AC:1_OA_Equipment, !- Outdoor Air Equipment List Name
PSZ-AC:1 Availability Manager List; !- Availability Manager List Name
PSZ-AC:1_OA_Equipment; !- Outdoor Air Equipment List Name
Copy link
Member

Choose a reason for hiding this comment

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

👍

state, CurrentModuleObject + " = \"" + AlphArray(1) + "\" invalid " + cAlphaFields(4) + "=\"" + AlphArray(4) + "\" not found.");
ErrorsFound = true;
}
}
Copy link
Member

Choose a reason for hiding this comment

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

👍

CALL AddToObjFld('Controller List Name', base + vsAirHandlerNameOff,' OA System Controllers')
CALL AddToObjFld('Outdoor Air Equipment List Name', base + vsAirHandlerNameOff,' OA System Equipment')
CALL AddToObjFld('Availability Manager List Name', base + vsAirHandlerNameOff,' Availability Managers',.TRUE.)
CALL AddToObjFld('Outdoor Air Equipment List Name', base + vsAirHandlerNameOff,' OA System Equipment',.TRUE.)
Copy link
Member

Choose a reason for hiding this comment

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

Set to true to end the object and remove the now unneeded line 👍

CALL GetNewObjectDefInIDD(ObjectName,NwNumArgs,NwAorN,NwReqFld,NwObjMinFlds,NwFldNames,NwFldDefaults,NwFldUnits)
nodiff=.false.
OutArgs(1:3)=InArgs(1:3)
CurArgs = CurArgs - 1
Copy link
Member

Choose a reason for hiding this comment

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

Simple transition here. Good.

Copy link
Contributor

Choose a reason for hiding this comment

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

@RKStrand I don't see this rule added to \src\Transition\InputRulesFiles\Rules9-5-0-to-9-6-0.md Since this is merged, you can slip that into one of your other PRs.

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 Whoops! Totally forgot about that. I'll attach it to the next defect that I work on. I'll also update that file because currently it is "blank" but it talks about V9.4 to V9.5 not V9.5 to V9.6.

@Myoldmopar
Copy link
Member

1050 lines of "code" removed from the repo. I'll take it. Thanks @RKStrand !

@Myoldmopar Myoldmopar merged commit 0301ca9 into develop Jul 16, 2021
@Myoldmopar Myoldmopar deleted the 8814RemoveAvailManForOAS branch July 16, 2021 13:10
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Availability Manager List Name for AirLoopHVAC:OutdoorAirSystem not working

9 participants