Reference documentation for deal.II version 9.5.0
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
No Matches
Public Member Functions | Private Attributes | List of all members
TimerOutput::Scope Class Reference

#include <deal.II/base/timer.h>

Public Member Functions

 Scope (::TimerOutput &timer_, const std::string &section_name)
 ~Scope ()
void stop ()

Private Attributes

const std::string section_name
bool in

Detailed Description

Helper class to enter/exit sections in TimerOutput be constructing a simple scope-based object. The purpose of this class is explained in the documentation of TimerOutput.

Definition at line 557 of file timer.h.

Constructor & Destructor Documentation

◆ Scope()

TimerOutput::Scope::Scope ( ::TimerOutput timer_,
const std::string &  section_name 

Enter the given section in the timer. Exit automatically when calling stop() or destructor runs.

Definition at line 945 of file timer.h.

◆ ~Scope()

TimerOutput::Scope::~Scope ( )

Destructor calls stop()

Definition at line 1042 of file

Member Function Documentation

◆ stop()

void TimerOutput::Scope::stop ( )

In case you want to exit the scope before the destructor is executed, call this function.

Definition at line 957 of file timer.h.

Member Data Documentation

◆ timer

::TimerOutput& TimerOutput::Scope::timer

Reference to the TimerOutput object

Definition at line 582 of file timer.h.

◆ section_name

const std::string TimerOutput::Scope::section_name

Name of the section we need to exit

Definition at line 587 of file timer.h.

◆ in

bool TimerOutput::Scope::in

Do we still need to exit the section we are in?

Definition at line 592 of file timer.h.

The documentation for this class was generated from the following files: