Fix #10399 - Long elapsed times are not recorded correctly

src/EnergyPlus/CMakeLists.txt

@@ -254,7 +254,7 @@ set(SRC
     ElectricPowerServiceManager.cc
     ElectricPowerServiceManager.hh
     EnergyPlus.hh
-    EnergyPlusLogger.cc 
+    EnergyPlusLogger.cc
     EnergyPlusLogger.hh
     EvaporativeCoolers.cc
     EvaporativeCoolers.hh
@@ -602,6 +602,8 @@ set(SRC
     TARCOGParams.hh
     TarcogShading.cc
     TarcogShading.hh
+    Timer.cc
+    Timer.hh
     ThermalChimney.cc
     ThermalChimney.hh
     ThermalComfort.cc

src/EnergyPlus/DataSystemVariables.hh

@@ -56,6 +56,7 @@
 #include <EnergyPlus/EnergyPlus.hh>
 #include <EnergyPlus/FileSystem.hh>
 #include <EnergyPlus/IOFiles.hh>
+#include <EnergyPlus/Timer.hh>
 
 namespace EnergyPlus {
 
@@ -125,9 +126,7 @@ struct SystemVarsData : BaseGlobalStruct
     bool UpdateDataDuringWarmupExternalInterface = false; // variable sets in the external interface.
 
     // This update the value during the warmup added for FMI
-    Real64 Elapsed_Time = 0.0;      // For showing elapsed time at end of run
-    Real64 Time_Start = 0.0;        // Call to CPU_Time for start time of simulation
-    Real64 Time_Finish = 0.0;       // Call to CPU_Time for end time of simulation
+    Timer runtimeTimer;
     std::string MinReportFrequency; // String for minimum reporting frequency
     bool SortedIDD = true;          // after processing, use sorted IDD to obtain Defs, etc.
     bool lMinimalShadowing = false; // TRUE if Minimal is to override Solar Distribution flag
@@ -177,9 +176,7 @@ struct SystemVarsData : BaseGlobalStruct
         ReportDetailedWarmupConvergence = false;
         UpdateDataDuringWarmupExternalInterface = false;
 
-        Elapsed_Time = 0.0;
-        Time_Start = 0.0;
-        Time_Finish = 0.0;
+        runtimeTimer = Timer{};
         SortedIDD = true;
         lMinimalShadowing = false;
         TestAllPaths = false;

src/EnergyPlus/Timer.cc

@@ -0,0 +1,112 @@
+// EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University of Illinois,
+// The Regents of the University of California, through Lawrence Berkeley National Laboratory
+// (subject to receipt of any required approvals from the U.S. Dept. of Energy), Oak Ridge
+// National Laboratory, managed by UT-Battelle, Alliance for Sustainable Energy, LLC, and other
+// contributors. All rights reserved.
+//
+// NOTICE: This Software was developed under funding from the U.S. Department of Energy and the
+// U.S. Government consequently retains certain rights. As such, the U.S. Government has been
+// granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable,
+// worldwide license in the Software to reproduce, distribute copies to the public, prepare
+// derivative works, and perform publicly and display publicly, and to permit others to do so.
+//
+// Redistribution and use in source and binary forms, with or without modification, are permitted
+// provided that the following conditions are met:
+//
+// (1) Redistributions of source code must retain the above copyright notice, this list of
+//     conditions and the following disclaimer.
+//
+// (2) Redistributions in binary form must reproduce the above copyright notice, this list of
+//     conditions and the following disclaimer in the documentation and/or other materials
+//     provided with the distribution.
+//
+// (3) Neither the name of the University of California, Lawrence Berkeley National Laboratory,
+//     the University of Illinois, U.S. Dept. of Energy nor the names of its contributors may be
+//     used to endorse or promote products derived from this software without specific prior
+//     written permission.
+//
+// (4) Use of EnergyPlus(TM) Name. If Licensee (i) distributes the software in stand-alone form
+//     without changes from the version obtained under this License, or (ii) Licensee makes a
+//     reference solely to the software portion of its product, Licensee must refer to the
+//     software as "EnergyPlus version X" software, where "X" is the version number Licensee
+//     obtained under this License and may not use a different name for the software. Except as
+//     specifically required in this Section (4), Licensee shall not use in a company name, a
+//     product name, in advertising, publicity, or other promotional activities any name, trade
+//     name, trademark, logo, or other designation of "EnergyPlus", "E+", "e+" or confusingly
+//     similar designation, without the U.S. Department of Energy's prior written consent.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
+// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
+
+#include <EnergyPlus/Timer.hh>
+
+#include <fmt/format.h>
+#ifndef NDEBUG
+#include <stdexcept>
+#endif
+
+namespace EnergyPlus {
+
+void Timer::tick()
+{
+    m_end = TimePointType{};
+    m_start = ClockType::now();
+}
+
+void Timer::tock()
+{
+#ifndef NDEBUG
+    if (m_start == TimePointType{}) {
+        throw std::runtime_error("Timer was not started");
+    }
+#endif
+    m_end = ClockType::now();
+    m_duration = m_duration + std::chrono::duration_cast<DurationType>(m_end - m_start);
+}
+
+Timer::DurationType Timer::duration() const
+{
+#ifndef NDEBUG
+    if (m_end == TimePointType{}) {
+        throw std::runtime_error("Timer was not stopped");
+    }
+#endif
+    return m_duration;
+}
+
+std::string Timer::formatAsHourMinSecs() const
+{
+    // We're working with ms as base.
+    // TODO: do we want to report elapsed time of 25 hours as 1 day 1hr 0min 0sec or 25hr 0min 0sec?
+    // constexpr auto num_ms_in_day = 1000 * 3600 * 24;
+    // if (duration().count() > num_ms_in_day) {
+    //     return fmt::format("{:.2%j days %Hhr %Mmin %Ssec}\n", duration());
+    // } else {
+    //     return fmt::format("{:%Hhr %Mmin %Ssec}\n", duration());
+    // }
+    auto count = duration().count();
+    auto Hours = count / 3600000;
+    count -= Hours * 3600000;
+
+    auto Minutes = count / 60000;
+    count -= Minutes * 60000;
+    double Seconds = count / 1000.0;
+    if (Seconds < 0.0) {
+        Seconds = 0.0;
+    }
+    return fmt::format("{:02}hr {:02}min {:5.2F}sec", Hours, Minutes, Seconds);
+}
+
+Real64 Timer::elapsedSeconds() const
+{
+    return duration().count() / 1000.0;
+}
+
+} // namespace EnergyPlus

src/EnergyPlus/Timer.hh

@@ -0,0 +1,88 @@
+// EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University of Illinois,
+// The Regents of the University of California, through Lawrence Berkeley National Laboratory
+// (subject to receipt of any required approvals from the U.S. Dept. of Energy), Oak Ridge
+// National Laboratory, managed by UT-Battelle, Alliance for Sustainable Energy, LLC, and other
+// contributors. All rights reserved.
+//
+// NOTICE: This Software was developed under funding from the U.S. Department of Energy and the
+// U.S. Government consequently retains certain rights. As such, the U.S. Government has been
+// granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable,
+// worldwide license in the Software to reproduce, distribute copies to the public, prepare
+// derivative works, and perform publicly and display publicly, and to permit others to do so.
+//
+// Redistribution and use in source and binary forms, with or without modification, are permitted
+// provided that the following conditions are met:
+//
+// (1) Redistributions of source code must retain the above copyright notice, this list of
+//     conditions and the following disclaimer.
+//
+// (2) Redistributions in binary form must reproduce the above copyright notice, this list of
+//     conditions and the following disclaimer in the documentation and/or other materials
+//     provided with the distribution.
+//
+// (3) Neither the name of the University of California, Lawrence Berkeley National Laboratory,
+//     the University of Illinois, U.S. Dept. of Energy nor the names of its contributors may be
+//     used to endorse or promote products derived from this software without specific prior
+//     written permission.
+//
+// (4) Use of EnergyPlus(TM) Name. If Licensee (i) distributes the software in stand-alone form
+//     without changes from the version obtained under this License, or (ii) Licensee makes a
+//     reference solely to the software portion of its product, Licensee must refer to the
+//     software as "EnergyPlus version X" software, where "X" is the version number Licensee
+//     obtained under this License and may not use a different name for the software. Except as
+//     specifically required in this Section (4), Licensee shall not use in a company name, a
+//     product name, in advertising, publicity, or other promotional activities any name, trade
+//     name, trademark, logo, or other designation of "EnergyPlus", "E+", "e+" or confusingly
+//     similar designation, without the U.S. Department of Energy's prior written consent.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
+// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+// POSSIBILITY OF SUCH DAMAGE.
+
+#ifndef Timer_hh_INCLUDED
+#define Timer_hh_INCLUDED
+
+#include <EnergyPlus/api/TypeDefs.h>
+
+#include <chrono>
+#include <string>
+
+namespace EnergyPlus {
+
+// A restartable Timer (stopwatch) with formatting convenience functions
+struct Timer
+{
+    using DurationType = std::chrono::milliseconds;
+    using ClockType = std::chrono::system_clock;
+    using TimePointType = ClockType::time_point;
+
+    Timer() = default;
+
+    DurationType duration() const;
+
+    // Reset start to now, end to none
+    void tick();
+
+    // Capture end time, add to duration
+    void tock();
+
+    std::string formatAsHourMinSecs() const;
+
+    Real64 elapsedSeconds() const;
+
+    // private:
+    TimePointType m_start;
+    TimePointType m_end;
+
+private:
+    DurationType m_duration{};
+};
+} // namespace EnergyPlus
+
+#endif // Timer_hh_INCLUDED

src/EnergyPlus/UtilityRoutines.cc

@@ -87,6 +87,7 @@ extern "C" {
 #include <EnergyPlus/SimulationManager.hh>
 #include <EnergyPlus/SolarShading.hh>
 #include <EnergyPlus/SystemReports.hh>
+#include <EnergyPlus/Timer.hh>
 #include <EnergyPlus/UtilityRoutines.hh>
 // Third Party Headers
 #include <fast_float/fast_float.h>
@@ -451,40 +452,6 @@ namespace Util {
             fsPerfLog.close();
         }
     }
-
-    Real64 epElapsedTime()
-    {
-
-        // FUNCTION INFORMATION:
-        //       AUTHOR         Linda Lawrie
-        //       DATE WRITTEN   February 2012
-        //       MODIFIED       na
-        //       RE-ENGINEERED  na
-
-        // PURPOSE OF THIS FUNCTION:
-        // An alternative method for timing elapsed times is to call the standard
-        // Date_And_Time routine and set the "time".
-
-        // Return value
-        Real64 calctime; // calculated time based on hrs, minutes, seconds, milliseconds
-
-        // FUNCTION LOCAL VARIABLE DECLARATIONS:
-        Array1D<Int32> clockvalues(8);
-        // value(1)   Current year
-        // value(2)   Current month
-        // value(3)   Current day
-        // value(4)   Time difference with respect to UTC in minutes (0-59)
-        // value(5)   Hour of the day (0-23)
-        // value(6)   Minutes (0-59)
-        // value(7)   Seconds (0-59)
-        // value(8)   Milliseconds (0-999)
-
-        date_and_time(_, _, _, clockvalues);
-        calctime = clockvalues(5) * 3600.0 + clockvalues(6) * 60.0 + clockvalues(7) + clockvalues(8) / 1000.0;
-
-        return calctime;
-    }
-
 } // namespace Util
 
 int AbortEnergyPlus(EnergyPlusData &state)
@@ -587,17 +554,8 @@ int AbortEnergyPlus(EnergyPlusData &state)
     NumSevereDuringSizing = fmt::to_string(state.dataErrTracking->TotalSevereErrorsDuringSizing);
 
     // catch up with timings if in middle
-    state.dataSysVars->Time_Finish = Util::epElapsedTime();
-    if (state.dataSysVars->Time_Finish < state.dataSysVars->Time_Start) state.dataSysVars->Time_Finish += 24.0 * 3600.0;
-    state.dataSysVars->Elapsed_Time = state.dataSysVars->Time_Finish - state.dataSysVars->Time_Start;
-    if (state.dataSysVars->Elapsed_Time < 0.0) state.dataSysVars->Elapsed_Time = 0.0;
-    Hours = state.dataSysVars->Elapsed_Time / 3600.0;
-    state.dataSysVars->Elapsed_Time -= Hours * 3600.0;
-    Minutes = state.dataSysVars->Elapsed_Time / 60.0;
-    state.dataSysVars->Elapsed_Time -= Minutes * 60.0;
-    Seconds = state.dataSysVars->Elapsed_Time;
-    if (Seconds < 0.0) Seconds = 0.0;
-    const std::string Elapsed = format("{:02}hr {:02}min {:5.2F}sec", Hours, Minutes, Seconds);
+    state.dataSysVars->runtimeTimer.tock();
+    const std::string Elapsed = state.dataSysVars->runtimeTimer.formatAsHourMinSecs();
 
     state.dataResultsFramework->resultsFramework->SimulationInformation.setRunTime(Elapsed);
     state.dataResultsFramework->resultsFramework->SimulationInformation.setNumErrorsWarmup(NumWarningsDuringWarmup, NumSevereDuringWarmup);
@@ -727,20 +685,11 @@ int EndEnergyPlus(EnergyPlusData &state)
     NumSevereDuringSizing = fmt::to_string(state.dataErrTracking->TotalSevereErrorsDuringSizing);
     strip(NumSevereDuringSizing);
 
-    state.dataSysVars->Time_Finish = Util::epElapsedTime();
-    if (state.dataSysVars->Time_Finish < state.dataSysVars->Time_Start) state.dataSysVars->Time_Finish += 24.0 * 3600.0;
-    state.dataSysVars->Elapsed_Time = state.dataSysVars->Time_Finish - state.dataSysVars->Time_Start;
+    state.dataSysVars->runtimeTimer.tock();
     if (state.dataGlobal->createPerfLog) {
-        Util::appendPerfLog(state, "Run Time [seconds]", format("{:.2R}", state.dataSysVars->Elapsed_Time));
+        Util::appendPerfLog(state, "Run Time [seconds]", format("{:.2R}", state.dataSysVars->runtimeTimer.elapsedSeconds()));
     }
-    Hours = state.dataSysVars->Elapsed_Time / 3600.0;
-    state.dataSysVars->Elapsed_Time -= Hours * 3600.0;
-    Minutes = state.dataSysVars->Elapsed_Time / 60.0;
-    state.dataSysVars->Elapsed_Time -= Minutes * 60.0;
-    Seconds = state.dataSysVars->Elapsed_Time;
-    if (Seconds < 0.0) Seconds = 0.0;
-    const std::string Elapsed = format("{:02}hr {:02}min {:5.2F}sec", Hours, Minutes, Seconds);
-
+    const std::string Elapsed = state.dataSysVars->runtimeTimer.formatAsHourMinSecs();
     state.dataResultsFramework->resultsFramework->SimulationInformation.setRunTime(Elapsed);
     state.dataResultsFramework->resultsFramework->SimulationInformation.setNumErrorsWarmup(NumWarningsDuringWarmup, NumSevereDuringWarmup);
     state.dataResultsFramework->resultsFramework->SimulationInformation.setNumErrorsSizing(NumWarningsDuringSizing, NumSevereDuringSizing);

src/EnergyPlus/UtilityRoutines.hh

@@ -273,8 +273,6 @@ namespace Util {
     {
     };
 
-    Real64 epElapsedTime();
-
     Real64 ProcessNumber(std::string_view String, bool &ErrorFlag);
 
     int FindItemInList(std::string_view const String, Array1_string const &ListOfItems, int NumItems);

src/EnergyPlus/api/EnergyPlusPgm.cc

@@ -270,7 +270,7 @@ void commonInitialize(EnergyPlus::EnergyPlusData &state)
 #endif
 #endif
 
-    state.dataSysVars->Time_Start = Util::epElapsedTime();
+    state.dataSysVars->runtimeTimer.tick();
 
     state.dataStrGlobals->CurrentDateTime = CreateCurrentDateTimeString();
 

tst/EnergyPlus/unit/CMakeLists.txt

@@ -230,6 +230,7 @@ set(test_src
     SwimmingPool.unit.cc
     SystemAvailabilityManager.unit.cc
     SystemReports.unit.cc
+    Timer.unit.cc
     ThermalChimney.unit.cc
     ThermalComfort.unit.cc
     TranspiredCollector.unit.cc