Skip to content

Make ExternalInterface:FunctionalMockupUnitExport:To:Schedule/Actuator Initial Value field optional #10943

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
Merged
Myoldmopar merged 8 commits into from
Apr 9, 2025
Merged

Make ExternalInterface:FunctionalMockupUnitExport:To:Schedule/Actuator Initial Value field optional #10943

Myoldmopar merged 8 commits into from
Apr 9, 2025

Conversation

@mjwitte
Copy link
Contributor

@mjwitte mjwitte commented Feb 18, 2025 •
edited
Loading

Pull request overview

Description of the purpose of this PR

Pull Request Author

  • 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

  • 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

@mjwitte mjwitte added the Defect Includes code to repair a defect in EnergyPlus label Feb 18, 2025
@mjwitte mjwitte added this to the EnergyPlus 25.1 IO Freeze milestone Feb 18, 2025
@mjwitte mjwitte added the IDDChange Code changes impact the IDD file (cannot be merged after IO freeze) label Feb 18, 2025
@mjwitte mjwitte changed the title Misc cleanups Make initial value field optional for ExternalInterface:FunctionalMockupUnitExport:To:Schedule and Actuator Apr 8, 2025
@mjwitte mjwitte changed the title Make initial value field optional for ExternalInterface:FunctionalMockupUnitExport:To:Schedule and Actuator Make ExternalInterface:FunctionalMockupUnitExport:To:Schedule/Actuator Initial Value field optional Apr 8, 2025
@mjwitte mjwitte marked this pull request as ready for review April 9, 2025 14:05
@mjwitte
Copy link
Contributor Author

mjwitte commented Apr 9, 2025

The FMU IDD changes were tested successfully by @Florian-Sim (who posted the issue) and Thierry N. This is ready for final review.

@Myoldmopar Myoldmopar self-assigned this Apr 9, 2025
Myoldmopar
Myoldmopar approved these changes Apr 9, 2025
View reviewed changes
idd/Energy+.idd.in
\memo space air node, air inlet nodes, air exhaust nodes, and the air return node.
\memo If any space in a zone has a SpaceHVAC:EquipmentConnections object, then all spaces in the zone must have one.
\memo Used only when ZoneAirHeatBalanceAlgorithm "Do Space Heat Balance for Sizing"is Yes.
\memo Used only when ZoneAirHeatBalanceAlgorithm "Do Space Heat Balance for Simulation" is Yes.
Copy link
Member

@Myoldmopar Myoldmopar Apr 9, 2025

Choose a reason for hiding this comment

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

A fine fix

idd/Energy+.idd.in
\reference SpaceSplitterNames
A2, \field Zone Name
\note Must be a controlled zone which has a ZoneHVAC:EquipmentConfiguration object.
\note Must be a controlled zone which has a ZoneHVAC:EquipmentConnections object.
Copy link
Member

@Myoldmopar Myoldmopar Apr 9, 2025

Choose a reason for hiding this comment

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

Yes, good.

idd/Energy+.idd.in
\type real
\required-field
\note Used during the first call of EnergyPlus.
\note Used during EnergyPlus sizing and warm-up.
Copy link
Member

@Myoldmopar Myoldmopar Apr 9, 2025

Choose a reason for hiding this comment

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

👍

idd/Energy+.idd.in
\required-field
\note Used during the first call of EnergyPlus.
\note Used during EnergyPlus sizing and warm-up.
\note If no value is specified, then the actuated component will only be updated after sizing and warm-up.
Copy link
Member

@Myoldmopar Myoldmopar Apr 9, 2025

Choose a reason for hiding this comment

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

Sounds good to me.

@Myoldmopar
Copy link
Member

Myoldmopar commented Apr 9, 2025

Everything reads well and looks good, thanks @mjwitte

@Myoldmopar Myoldmopar merged commit 9070da7 into develop Apr 9, 2025
9 checks passed
@Myoldmopar Myoldmopar deleted the miscCleanups10338_7593 branch April 9, 2025 18:50
jmarrec
jmarrec reviewed Oct 20, 2025
View reviewed changes
idd/Energy+.idd.in
\type real
\required-field
\note Used during the first call of EnergyPlus.
\note Used during EnergyPlus sizing and warm-up.
Copy link
Contributor

@jmarrec jmarrec Oct 20, 2025

Choose a reason for hiding this comment

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

NumErrorFlag is set. But that's not used later to throw.

Is allowing a blank really intended though, given the warning?

EnergyPlus/src/EnergyPlus/ScheduleManager.cc

Lines 2047 to 2053 in 0befe77

// Initialize the ExternalInterface day schedule for the ExternalInterface compact schedule.
// It will be overwritten during run time stepping after the warm up period
if (NumNumbers < 1) {
ShowWarningCustom(state, eoh, "Initial value is not numeric or is missing. Fix idf file.");
NumErrorFlag = true;
}
ExternalInterfaceSetSchedule(state, daySched->Num, Numbers(1));

Copy link
Contributor Author

@mjwitte mjwitte Oct 20, 2025

Choose a reason for hiding this comment

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

@jmarrec I wasn't set up to test this, so it was tested by two others. This warning should go, but I wonder if line 2053 should be inside this if.

Copy link
Contributor Author

@mjwitte mjwitte Oct 20, 2025

Choose a reason for hiding this comment

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

For the record, looking further at this code, it appears that this is creating a new schedule, so it would need a value to initialize it.

@jmarrec jmarrec mentioned this pull request Oct 20, 2025
Merged
19 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jmarrec jmarrec jmarrec left review comments

@Myoldmopar Myoldmopar Myoldmopar approved these changes

Assignees

@Myoldmopar Myoldmopar

Labels

Defect Includes code to repair a defect in EnergyPlus IDDChange Code changes impact the IDD file (cannot be merged after IO freeze)

Projects

None yet

Milestone

EnergyPlus 25.2 IO Freeze

Development

Successfully merging this pull request may close these issues.

Correct idd file for ExternalInterface:FunctionalMockupUnitExport object

6 participants

@mjwitte @Myoldmopar @jmarrec @nrel-bot-2 @nrel-bot-2c