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

Fix #5116 - Annoying FT warnings for always XX Scheduled missing the schedule type limits object #5117

Merged
merged 2 commits into from
Mar 25, 2024
Merged

Fix #5116 - Annoying FT warnings for always XX Scheduled missing the schedule type limits object #5117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2960b7
Add a failing test demonstrating #5116
jmarrec Mar 19, 2024
dc326bb
Fix #5116 - reorder the translatation of alwaysOn schedules
jmarrec Mar 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions src/energyplus/ForwardTranslator.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3672,6 +3672,16 @@ namespace energyplus {

void ForwardTranslator::translateSchedules(const model::Model& model) {

// Make sure these get in the idf file
{
auto schedule = model.alwaysOnDiscreteSchedule();
translateAndMapModelObject(schedule);
schedule = model.alwaysOffDiscreteSchedule();
translateAndMapModelObject(schedule);
schedule = model.alwaysOnContinuousSchedule();
translateAndMapModelObject(schedule);
}
Comment on lines +3675 to +3683
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Just reordering things a bit.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Reordering is the fix?

Copy link
Collaborator Author

@jmarrec jmarrec Mar 25, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

yep. auto schedule = model.alwaysOnDiscreteSchedule(); => this creates a schedule BUT also a ScheduleTypeLimits, if it wasn't instantiated already.

I put it above and not below the loop to translate all ScheduleTypeLimits.

Translating a scheduleconstant does not trigger translate of the ScheduleTypeLimits attached to it.


// loop over schedule type limits
std::vector<WorkspaceObject> objects = model.getObjectsByType(IddObjectType::OS_ScheduleTypeLimits);
std::sort(objects.begin(), objects.end(), WorkspaceObjectNameLess());
Expand All @@ -3698,16 +3708,6 @@ namespace energyplus {
translateAndMapModelObject(modelObject);
}
}

// Make sure these get in the idf file
{
auto schedule = model.alwaysOnDiscreteSchedule();
translateAndMapModelObject(schedule);
schedule = model.alwaysOffDiscreteSchedule();
translateAndMapModelObject(schedule);
schedule = model.alwaysOnContinuousSchedule();
translateAndMapModelObject(schedule);
}
}

void ForwardTranslator::translateAirflowNetwork(const model::Model& model) {
Expand Down
39 changes: 32 additions & 7 deletions src/energyplus/Test/ForwardTranslator_GTest.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@
#include "../../model/OutputVariable_Impl.hpp"
#include "../../model/Version.hpp"
#include "../../model/Version_Impl.hpp"
#include "../../model/YearDescription.hpp"
#include "../../model/YearDescription_Impl.hpp"
#include "../../model/ZoneCapacitanceMultiplierResearchSpecial.hpp"
#include "../../model/ZoneCapacitanceMultiplierResearchSpecial_Impl.hpp"

Expand All @@ -64,14 +66,15 @@

#include <boost/algorithm/string/predicate.hpp>

#include <future>

#include <resources.hxx>

#include <future>
#include <sstream>

#include <vector>

#include <fmt/format.h>
#include <fmt/ranges.h>

using namespace openstudio::energyplus;
using namespace openstudio::model;
using namespace openstudio;
Expand Down Expand Up @@ -557,8 +560,8 @@ TEST_F(EnergyPlusFixture,ForwardTranslatorTest_AllObjects) {
}
*/

/* This test fails because objects of the same type share state across the Logger
See detailed notes below. This test is disabled and commented out.
/* This test fails because objects of the same type share state across the Logger
See detailed notes below. This test is disabled and commented out.
TEST_F(EnergyPlusFixture, ForwardTranslatorTest_MultipleTranslatorsInScope) {
Model model;
Space space(model); // not in thermal zone will generate a warning
Expand Down Expand Up @@ -632,8 +635,8 @@ class ForwardTranslatorThread
std::future<Workspace> future;
};

/* ForwardTranslatorTest_MultiThreadedLogMessages is disabled.
See notes below for reasons why this tests fails due to race conditions.
/* ForwardTranslatorTest_MultiThreadedLogMessages is disabled.
See notes below for reasons why this tests fails due to race conditions.
TEST_F(EnergyPlusFixture, ForwardTranslatorTest_MultiThreadedLogMessages) {

// Logger::instance().standardOutLogger().enable();
Expand Down Expand Up @@ -961,3 +964,25 @@ TEST_F(EnergyPlusFixture, Ensure_Name_Unicity_ZoneAndZoneListAndSpaceAndSpaceLis
EXPECT_NE(wos[i1].nameString(), wos[i2].nameString());
}
}

TEST_F(EnergyPlusFixture, NoUselessWarnings) {
// Test for #5116
Model m;
auto yd = m.getUniqueModelObject<model::YearDescription>();
EXPECT_TRUE(yd.setDayofWeekforStartDay("Tuesday"));

ForwardTranslator ft;
StringStreamLogSink sink;
sink.setLogLevel(Warn);

Workspace w = ft.translateModel(m);
EXPECT_EQ(0u, ft.errors().size());
EXPECT_EQ(0u, ft.warnings().size());

std::vector<openstudio::LogMessage> logMessages = sink.logMessages();

std::vector<std::string> logStrings;
std::transform(logMessages.cbegin(), logMessages.cend(), std::back_inserter(logStrings),
[](const auto& logMessage) { return logMessage.logMessage(); });
EXPECT_EQ(0, logMessages.size()) << fmt::format("Expected no messages logged, got: {}", logStrings);
}
Comment on lines +968 to +988
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

New test.

Before fix:

$ Products/openstudio_energyplus_tests -- --gtest_filter=*NoUselessWarnings*
Running main() from /home/conan/w/BuildSingleReference/.conan/data/gtest/1.11.0/_/_/build/e019a06362b932ca5d1b082b6c112aa150c88de4/source_subfolder/googletest/src/gtest_main.cc
Note: Google Test filter = *NoUselessWarnings*
[==========] Running 1 test from 1 test suite.
[----------] Global test environment set-up.
[----------] 1 test from EnergyPlusFixture
[ RUN      ] EnergyPlusFixture.NoUselessWarnings
/home/julien/Software/Others/OpenStudio/src/energyplus/Test/ForwardTranslator_GTest.cpp:987: Failure
Expected equality of these values:
  0
  logMessages.size()
    Which is: 3
Expected no messages logged, got: ["Object of type 'Schedule:Constant' and named 'Always On Discrete', points to an object named OnOff from field 1, but that object cannot be located.", "Object of type 'Schedule:Constant' and named 'Always Off Discrete', points to an object named OnOff 1 from field 1, but that object cannot be located.", "Object of type 'Schedule:Constant' and named 'Always On Continuous', points to an object named Fractional from field 1, but that object cannot be located."]
[  FAILED  ] EnergyPlusFixture.NoUselessWarnings (16 ms)
[----------] 1 test from EnergyPlusFixture (16 ms total)

[----------] Global test environment tear-down
[==========] 1 test from 1 test suite ran. (16 ms total)
[  PASSED  ] 0 tests.
[  FAILED  ] 1 test, listed below:
[  FAILED  ] EnergyPlusFixture.NoUselessWarnings

Loading