Line data    Source code

       1             : // EnergyPlus, Copyright (c) 1996-2024, The Board of Trustees of the University of Illinois,
       2             : // The Regents of the University of California, through Lawrence Berkeley National Laboratory
       3             : // (subject to receipt of any required approvals from the U.S. Dept. of Energy), Oak Ridge
       4             : // National Laboratory, managed by UT-Battelle, Alliance for Sustainable Energy, LLC, and other
       5             : // contributors. All rights reserved.
       6             : //
       7             : // NOTICE: This Software was developed under funding from the U.S. Department of Energy and the
       8             : // U.S. Government consequently retains certain rights. As such, the U.S. Government has been
       9             : // granted for itself and others acting on its behalf a paid-up, nonexclusive, irrevocable,
      10             : // worldwide license in the Software to reproduce, distribute copies to the public, prepare
      11             : // derivative works, and perform publicly and display publicly, and to permit others to do so.
      12             : //
      13             : // Redistribution and use in source and binary forms, with or without modification, are permitted
      14             : // provided that the following conditions are met:
      15             : //
      16             : // (1) Redistributions of source code must retain the above copyright notice, this list of
      17             : //     conditions and the following disclaimer.
      18             : //
      19             : // (2) Redistributions in binary form must reproduce the above copyright notice, this list of
      20             : //     conditions and the following disclaimer in the documentation and/or other materials
      21             : //     provided with the distribution.
      22             : //
      23             : // (3) Neither the name of the University of California, Lawrence Berkeley National Laboratory,
      24             : //     the University of Illinois, U.S. Dept. of Energy nor the names of its contributors may be
      25             : //     used to endorse or promote products derived from this software without specific prior
      26             : //     written permission.
      27             : //
      28             : // (4) Use of EnergyPlus(TM) Name. If Licensee (i) distributes the software in stand-alone form
      29             : //     without changes from the version obtained under this License, or (ii) Licensee makes a
      30             : //     reference solely to the software portion of its product, Licensee must refer to the
      31             : //     software as "EnergyPlus version X" software, where "X" is the version number Licensee
      32             : //     obtained under this License and may not use a different name for the software. Except as
      33             : //     specifically required in this Section (4), Licensee shall not use in a company name, a
      34             : //     product name, in advertising, publicity, or other promotional activities any name, trade
      35             : //     name, trademark, logo, or other designation of "EnergyPlus", "E+", "e+" or confusingly
      36             : //     similar designation, without the U.S. Department of Energy's prior written consent.
      37             : //
      38             : // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
      39             : // IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
      40             : // AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
      41             : // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
      42             : // CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
      43             : // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
      44             : // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
      45             : // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
      46             : // POSSIBILITY OF SUCH DAMAGE.
      47             : 
      48             : #include <EnergyPlus/Timer.hh>
      49             : 
      50             : #include <fmt/format.h>
      51             : #ifndef NDEBUG
      52             : #include <stdexcept>
      53             : #endif
      54             : 
      55             : namespace EnergyPlus {
      56             : 
      57         796 : void Timer::tick()
      58             : {
      59         796 :     m_end = TimePointType{};
      60         796 :     m_start = ClockType::now();
      61         796 : }
      62             : 
      63         796 : void Timer::tock()
      64             : {
      65             : #ifndef NDEBUG
      66         796 :     if (m_start == TimePointType{}) {
      67           0 :         throw std::runtime_error("Timer was not started");
      68             :     }
      69             : #endif
      70         796 :     m_end = ClockType::now();
      71         796 :     m_duration = m_duration + std::chrono::duration_cast<DurationType>(m_end - m_start);
      72         796 : }
      73             : 
      74         799 : Timer::DurationType Timer::duration() const
      75             : {
      76             : #ifndef NDEBUG
      77         799 :     if (m_end == TimePointType{}) {
      78           0 :         throw std::runtime_error("Timer was not stopped");
      79             :     }
      80             : #endif
      81         799 :     return m_duration;
      82             : }
      83             : 
      84         796 : std::string Timer::formatAsHourMinSecs() const
      85             : {
      86             :     // We're working with ms as base.
      87             :     // TODO: do we want to report elapsed time of 25 hours as 1 day 1hr 0min 0sec or 25hr 0min 0sec?
      88             :     // constexpr auto num_ms_in_day = 1000 * 3600 * 24;
      89             :     // if (duration().count() > num_ms_in_day) {
      90             :     //     return fmt::format("{:.2%j days %Hhr %Mmin %Ssec}\n", duration());
      91             :     // } else {
      92             :     //     return fmt::format("{:%Hhr %Mmin %Ssec}\n", duration());
      93             :     // }
      94         796 :     auto count = duration().count();
      95         796 :     auto Hours = count / 3600000;
      96         796 :     count -= Hours * 3600000;
      97             : 
      98         796 :     auto Minutes = count / 60000;
      99         796 :     count -= Minutes * 60000;
     100         796 :     double Seconds = count / 1000.0;
     101         796 :     if (Seconds < 0.0) {
     102           0 :         Seconds = 0.0;
     103             :     }
     104         796 :     return fmt::format("{:02}hr {:02}min {:5.2F}sec", Hours, Minutes, Seconds);
     105             : }
     106             : 
     107           3 : Real64 Timer::elapsedSeconds() const
     108             : {
     109           3 :     return duration().count() / 1000.0;
     110             : }
     111             : 
     112             : } // namespace EnergyPlus