Fix #1472 - Respect user's SimulationControl choices and move smart defaults to the modelObject #5118
Conversation
This file contains 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
jmarrec
added
component - Model
component - IDF Translation
Pull Request - Ready for CI
jmarrec
commented
Mar 22, 2024
Comment on lines
181
to
+211
| bool SimulationControl_Impl::doZoneSizingCalculation() const { | ||
| boost::optional<std::string> value = getString(OS_SimulationControlFields::DoZoneSizingCalculation, true); | ||
| OS_ASSERT(value); | ||
| return openstudio::istringEqual(value.get(), "Yes"); | ||
|
|
||
| auto shouldItBeOn = [this]() -> bool { | ||
| const auto m = model(); | ||
| const auto hasSizingPeriods = !m.getModelObjects<SizingPeriod>().empty(); | ||
| if (!hasSizingPeriods) { | ||
| return false; | ||
| } | ||
|
|
||
| const auto zones = m.getConcreteModelObjects<ThermalZone>(); | ||
| const auto hasZoneEquipment = std::any_of(zones.cbegin(), zones.cend(), [](const auto& z) { return !z.equipment().empty(); }); | ||
|
|
||
| return hasZoneEquipment; | ||
| }; | ||
|
|
||
| if (!isDoZoneSizingCalculationDefaulted()) { | ||
| boost::optional<std::string> value = getString(OS_SimulationControlFields::DoZoneSizingCalculation, true); | ||
| OS_ASSERT(value); | ||
| const auto result = openstudio::istringEqual(value.get(), "Yes"); | ||
| if (!result && shouldItBeOn()) { | ||
| LOG(Warn, "You have zonal equipment and design days, it's possible you should enable SimulationControl::DoZoneSizingCalculation"); | ||
| } | ||
| return result; | ||
| } | ||
|
|
||
| const auto result = shouldItBeOn(); | ||
| if (result) { | ||
| LOG(Debug, "You have zonal equipment and design days, and SimulationControl::DoZoneSizingCalculation is defaulted: turning on."); | ||
| } | ||
|
|
||
| return result; |
There was a problem hiding this comment.
Example with doZoneSizing: the model object has smart logic.
- If not defaulted, but we think it should be on: warn
- If defaulted, we check whether we think it should be on. If so, since this is the opposite of the IDD default, we issue a Debug message explaining why we picked it
|
CI Results for 6374961:
|
|
@jmarrec I like the principles that you laid out and I expect that most other people will too. I think this is a good pattern to use as much as we can.
|
kbenne
approved these changes
Apr 1, 2024
mdahlhausen
added a commit
to NREL/openstudio-standards
that referenced
this pull request
Apr 18, 2024
Run zone, sytem, and plant sizing due to avoid error due to changes from NREL/OpenStudio#5118
mdahlhausen
added a commit
to NREL/openstudio-standards
that referenced
this pull request
Apr 18, 2024
Explicitly run zone, system, and plant sizing due to changes in NREL/OpenStudio#5118
jmarrec
added a commit
to NREL/OpenStudio-resources
that referenced
this pull request
May 6, 2024
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.
Pull request overview
Fixes SimulationControl choices not translating to E+ #1472
We always respect a value that the user has picked
When defaulted, the smart default is in the model object itself
@kbenne does that make sense to you?
Pull Request Author
src/model/test)src/energyplus/Test)src/osversion/VersionTranslator.cpp)Labels:
IDDChangeAPIChangePull Request - Ready for CIso that CI builds your PRReview Checklist
This will not be exhaustively relevant to every PR.