Merge pull request dealii#18878 from gassmoeller/track_laps_in_timer

Add the functionality to count laps to the timer class

Author: marcfehling

include/deal.II/base/timer.h

@@ -258,6 +258,15 @@ class Timer
   double
   last_cpu_time() const;
 
+  /**
+   * Return the number of laps that have been timed by calling
+   * stop() since creation of the timer or the last
+   * call to reset(). If a timer is currently running
+   * the current lap is included in the count.
+   */
+  unsigned int
+  n_laps() const;
+
 private:
   /**
    * The Timer class stores timing information for two different clocks: a
@@ -370,6 +379,13 @@ class Timer
    * number of MPI processes in the MPI_Comm for the total run time.
    */
   Utilities::MPI::MinMaxAvg accumulated_wall_time_data;
+
+  /**
+   * The number of laps that have been timed. If
+   * the timer is currently running
+   * the current lap is included in the count.
+   */
+  unsigned int n_timed_laps;
 };
 
 

source/base/timer.cc

@@ -175,6 +175,9 @@ Timer::Timer(const MPI_Comm mpi_communicator, const bool sync_lap_times_)
 void
 Timer::start()
 {
+  if (running == false)
+    ++n_timed_laps;
+
   running = true;
 #ifdef DEAL_II_WITH_MPI
   if (sync_lap_times)
@@ -287,13 +290,22 @@ Timer::reset()
 {
   wall_times.reset();
   cpu_times.reset();
-  running = false;
+  running      = false;
+  n_timed_laps = 0;
   internal::TimerImplementation::clear_timing_data(last_lap_wall_time_data);
   internal::TimerImplementation::clear_timing_data(accumulated_wall_time_data);
 }
 
 
 
+unsigned int
+Timer::n_laps() const
+{
+  return n_timed_laps;
+}
+
+
+
 /* ---------------------------- TimerOutput -------------------------- */
 
 TimerOutput::TimerOutput(std::ostream         &stream,

tests/base/timer_03.cc

@@ -0,0 +1,40 @@
+// ------------------------------------------------------------------------
+//
+// SPDX-License-Identifier: LGPL-2.1-or-later
+// Copyright (C) 2017 - 2018 by the deal.II authors
+//
+// This file is part of the deal.II library.
+//
+// Part of the source code is dual licensed under Apache-2.0 WITH
+// LLVM-exception OR LGPL-2.1-or-later. Detailed license information
+// governing the source code and code contributions can be found in
+// LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II.
+//
+// ------------------------------------------------------------------------
+
+// the same as timer_02.cc but test the function n_laps().
+
+#include <deal.II/base/timer.h>
+
+#include "../tests.h"
+
+
+int
+main()
+{
+  initlog();
+
+  Timer t;
+
+  AssertThrow(t.n_laps() == 1, ExcInternalError());
+  t.stop();
+  AssertThrow(t.n_laps() == 1, ExcInternalError());
+  t.start();
+  AssertThrow(t.n_laps() == 2, ExcInternalError());
+  t.stop();
+  AssertThrow(t.n_laps() == 2, ExcInternalError());
+  t.reset();
+  AssertThrow(t.n_laps() == 0, ExcInternalError());
+
+  deallog << "OK" << std::endl;
+}

tests/base/timer_03.output

@@ -0,0 +1,2 @@
+
+DEAL::OK