dd/d27/Timer_8h_source.html

// Copyright (C) 2008 Anders Logg, 2015 Jan Blechta

//

// This file is part of DOLFINx (https://www.fenicsproject.org)

//

// SPDX-License-Identifier:    LGPL-3.0-or-later


#pragma once


#include <array>

#include <boost/timer/timer.hpp>

#include <string>


namespace dolfinx::common

{


class Timer

{

public:

  Timer();


  Timer(const std::string& task);


  ~Timer();


  void start();


  void resume();


  double stop();


  std::array<double, 3> elapsed() const;


private:

  // Name of task

  std::string _task;


  // Implementation of timer

  boost::timer::cpu_timer _timer;

};


} // namespace dolfinx::common

dolfinx::common::Timer
A timer can be used for timing tasks. The basic usage is.
Definition Timer.h:31

dolfinx::common::Timer::stop
double stop()
Stop timer, return wall time elapsed and store timing data into logger.
Definition Timer.cpp:45

dolfinx::common::Timer::resume
void resume()
Resume timer. Not well-defined for logging timer.
Definition Timer.cpp:34

dolfinx::common::Timer::~Timer
~Timer()
Destructor.
Definition Timer.cpp:26

dolfinx::common::Timer::start
void start()
Zero and start timer.
Definition Timer.cpp:32

dolfinx::common::Timer::Timer
Timer()
Create timer without logging.
Definition Timer.cpp:16

dolfinx::common::Timer::elapsed
std::array< double, 3 > elapsed() const
Return wall, user and system time in seconds.
Definition Timer.cpp:54

dolfinx::common
Miscellaneous classes, functions and types.
Definition dolfinx_common.h:8