Interface for objects interacting with the PerfGraph. More...
#include <PerfGraphInterface.h>
Public Member Functions | |
PerfGraphInterface (const MooseObject *moose_object) | |
For objects that are MooseObjects with a default prefix of type() More... | |
PerfGraphInterface (const MooseObject *moose_object, const std::string prefix) | |
For objects that are MooseObjects. More... | |
PerfGraphInterface (PerfGraph &perf_graph, const std::string prefix="") | |
For objects that aren't MooseObjects. More... | |
PerfGraphInterface (MooseApp &moose_app, const std::string prefix="") | |
For objects that construct the PerfGraphInterface before the PerfGraph is initialized (see MooseApp and OutputWarehouse) More... | |
virtual | ~PerfGraphInterface ()=default |
PerfGraph & | perfGraph () |
Get the PerfGraph. More... | |
Static Public Member Functions | |
static InputParameters | validParams () |
Protected Member Functions | |
PerfID | registerTimedSection (const std::string §ion_name, const unsigned int level) const |
Call to register a named section for timing. More... | |
PerfID | registerTimedSection (const std::string §ion_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const |
Call to register a named section for timing. More... | |
std::string | timedSectionName (const std::string §ion_name) const |
Protected Attributes | |
MooseApp & | _pg_moose_app |
The MooseApp that owns the PerfGraph. More... | |
const std::string | _prefix |
A prefix to use for all sections. More... | |
Interface for objects interacting with the PerfGraph.
Enables getting PerfGraph information and registering PerfGraph timed sections.
Definition at line 59 of file PerfGraphInterface.h.
PerfGraphInterface::PerfGraphInterface | ( | const MooseObject * | moose_object | ) |
For objects that are MooseObjects with a default prefix of type()
Definition at line 22 of file PerfGraphInterface.C.
PerfGraphInterface::PerfGraphInterface | ( | const MooseObject * | moose_object, |
const std::string | prefix | ||
) |
For objects that are MooseObjects.
Definition at line 29 of file PerfGraphInterface.C.
PerfGraphInterface::PerfGraphInterface | ( | PerfGraph & | perf_graph, |
const std::string | prefix = "" |
||
) |
For objects that aren't MooseObjects.
Definition at line 41 of file PerfGraphInterface.C.
PerfGraphInterface::PerfGraphInterface | ( | MooseApp & | moose_app, |
const std::string | prefix = "" |
||
) |
For objects that construct the PerfGraphInterface before the PerfGraph is initialized (see MooseApp and OutputWarehouse)
Definition at line 36 of file PerfGraphInterface.C.
|
virtualdefault |
PerfGraph & PerfGraphInterface::perfGraph | ( | ) |
Get the PerfGraph.
Definition at line 78 of file PerfGraphInterface.C.
Referenced by CommonOutputAction::act(), PerfGraphData::finalize(), and PerfGraphOutput::output().
|
protected |
Call to register a named section for timing.
section_name | The name of the code section to be timed |
level | The importance of the timer - lower is more important (0 will always come out) |
Definition at line 53 of file PerfGraphInterface.C.
|
protected |
Call to register a named section for timing.
section_name | The name of the code section to be timed |
level | The importance of the timer - lower is more important (0 will always come out) |
live_message | The message to be printed to the screen during execution |
print_dots | Whether or not progress dots should be printed for this section |
Definition at line 64 of file PerfGraphInterface.C.
|
protected |
section_name
.Optionally adds a prefix if one is defined.
Definition at line 47 of file PerfGraphInterface.C.
Referenced by registerTimedSection().
|
static |
Definition at line 16 of file PerfGraphInterface.C.
|
protected |
The MooseApp that owns the PerfGraph.
Definition at line 124 of file PerfGraphInterface.h.
Referenced by perfGraph().
|
protected |
A prefix to use for all sections.
Definition at line 127 of file PerfGraphInterface.h.
Referenced by timedSectionName().