Fix EMS flow diagram: remove BeginNewEnv from Setup Sim box (#11440)#11528
Open
brianlball wants to merge 1 commit intodevelopfrom
Open
Fix EMS flow diagram: remove BeginNewEnv from Setup Sim box (#11440)#11528brianlball wants to merge 1 commit intodevelopfrom
brianlball wants to merge 1 commit intodevelopfrom
Conversation
…box (#11440) Setup Simulation runs three kickoff timesteps for reverse-DD resolution; EMS user programs registered on BeginNewEnvironment do not fire during that phase. They fire in the main env loop (SimulationManager.cc:431). Timestep calling points do still fire during kickoff, so keep that annotation.
Contributor
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Summary
image003.jpg) in the EMS Application Guide.BeginNewEnvironmentnever fires duringSimulationManager::SetupSimulation. Verified against the code (SimulationManager.cc:431is the only place this calling point is invoked, inside the main env loop, not inside SetupSimulation).Closes #11440 (with docs clarification rather than code change).
What actually happens during Setup Simulation
BeginTimestepBeforePredictor, etc.) and user programs on those points run — the existing "(Timestep Calling Points)" annotation is accurate and is kept.BeginNewEnvironmentdoes not fire here. It fires once per environment atSimulationManager.cc:431, AFTER SetupSimulation completes and before warmup.EMSWindowShadeControl.idf,EMSConstantVolumePurchasedAir.idf) rely on this line-431 firing to initialize their Erl constants before the first reported timestep — they've been passing for years.Actual EMS calling point flow (for reviewers)
IDD-key / internal-enum name mismatches worth noting
AfterComponentInputReadIn↔ enumComponentGetInputEndOfZoneSizing↔ enumZoneSizingEndOfSystemSizing↔ enumSystemSizingAfterNewEnvironmentWarmUpIsComplete↔ enumBeginNewEnvironmentAfterWarmUpAfterPredictorBeforeHVACManagers↔ enumBeforeHVACManagersAfterPredictorAfterHVACManagers↔ enumAfterHVACManagersInsideHVACSystemIterationLoop↔ enumHVACIterationLoopFiles changed
doc/readthedocs/sphinx/ems-application-guide/media/image003.jpg— removed the spurious annotation.doc/readthedocs/sphinx/ems-application-guide/media/DrawingFileForEMSCallingPointFigures_LibreOfficeDraw.odg— editable source kept in sync.No code, test, IDD, or IDF changes.
Test plan