Timer.h

Go to the documentation of this file.

///////////////////////////////////////////////////////////////////////////////
//
// File: Timer.h
//
// For more information, please see: http://www.nektar.info
//
// The MIT License
//
// Copyright (c) 2006 Scientific Computing and Imaging Institute,
// University of Utah (USA) and Department of Aeronautics, Imperial
// College London (UK).
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
// Description: Time getting class
//
///////////////////////////////////////////////////////////////////////////////
 
#ifndef NEKTAR_LIB_UTILITIES_BASIC_UTILS_TIMER_H
#define NEKTAR_LIB_UTILITIES_BASIC_UTILS_TIMER_H
 
#include <chrono>
#include <iostream>
#include <unordered_map>
 
#include <LibUtilities/BasicConst/NektarUnivConsts.hpp>
#include <LibUtilities/Communication/CommSerial.h>
#include <LibUtilities/LibUtilitiesDeclspec.h>
 
namespace Nektar::LibUtilities
{
 
class Timer
{
public:
    using Clock       = std::chrono::steady_clock;
    using CounterType = Clock::time_point;
    using Seconds     = std::chrono::duration<NekDouble>;
 
public:
    LIB_UTILITIES_EXPORT Timer()  = default;
    LIB_UTILITIES_EXPORT ~Timer() = default;
 
    Timer(const Timer &rhs) = delete;
    Timer &operator=(const Timer &rhs) = delete;
 
    LIB_UTILITIES_EXPORT void Start();
    LIB_UTILITIES_EXPORT void Stop();
    LIB_UTILITIES_EXPORT Seconds Elapsed();
 
    /// \brief Accumulate elapsed time for a region
    LIB_UTILITIES_EXPORT void AccumulateRegion(std::string, int iolevel = 0);
    /// \brief Print elapsed time and call count for each region
    /// with default serial communicator
    LIB_UTILITIES_EXPORT static void PrintElapsedRegions();
 
    /// \brief Print elapsed time and call count for each region
    LIB_UTILITIES_EXPORT static void PrintElapsedRegions(
        LibUtilities::CommSharedPtr comm, std::ostream &o = std::cout,
        int iolevel = 0);
 
    /// \brief Returns amount of seconds per iteration in
    ///        a test with n iterations.
    LIB_UTILITIES_EXPORT NekDouble TimePerTest(unsigned int n);
 
private:
    // Initialize start and end to 0
    CounterType m_start = CounterType();
    CounterType m_end   = CounterType();
    bool m_isactive     = false;
    static std::map<std::string, std::tuple<Seconds, size_t, int>>
        m_elapsedRegion;
};
 
} // namespace Nektar::LibUtilities
 
#endif // NEKTAR_LIB_UTILITIES_BASIC_UTILS_TIMER_H