Scope guard for starting and stopping timing for a node. More...

#include <PerfGuard.h>

Public Member Functions
	PerfGuard (PerfGraph &graph, const PerfID id)
	Start timing for the given ID.

	~PerfGuard ()
	Stop timing.

Protected Attributes
PerfGraph &	_graph
	The graph we're working on.

Detailed Description

Scope guard for starting and stopping timing for a node.

Note that the PerfGuard timing itself will take approximately 0.00015 milliseconds.

That might not sound very long - but you still don't want that in the inside of tiny loops

Definition at line 25 of file PerfGuard.h.

Constructor & Destructor Documentation

◆ PerfGuard()

PerfGuard::PerfGuard	(	PerfGraph &	graph,
		const PerfID	id
	)

Start timing for the given ID.

Parameters

graph	The graph to add time into
id	The unique id of the section

Definition at line 16 of file PerfGuard.C.

                                                       : _graph(graph)
{
  _graph.push(id);
#ifdef LIBMESH_HAVE_NVTX_API
  nvtxRangePushA(moose::internal::getPerfGraphRegistry().sectionInfo(id)._name.c_str());
#endif
}

◆ ~PerfGuard()

PerfGuard::~PerfGuard ( )

Stop timing.

Definition at line 24 of file PerfGuard.C.

{
  _graph.pop();
#ifdef LIBMESH_HAVE_NVTX_API
  nvtxRangePop();
#endif
}

Member Data Documentation

◆ _graph

PerfGraph& PerfGuard::_graph

protected

The graph we're working on.

Definition at line 43 of file PerfGuard.h.

Referenced by PerfGuard(), and ~PerfGuard().

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

include/utils/PerfGuard.h
src/utils/PerfGuard.C