Loading [MathJax]/extensions/tex2jax.js
https://mooseframework.inl.gov
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
PerfGraphReporter.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://mooseframework.inl.gov
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 #include "GeneralReporter.h"
13 
14 class PerfNode;
15 class PerfGraph;
16 
21 {
22 public:
24 
26 
27  void initialize() override {}
28  void finalize() override {}
29  void execute() override {}
30 
31 private:
32  const PerfGraph * const & _graph;
33 };
34 
35 void to_json(nlohmann::json & json, const PerfGraph * const & perf_graph);
36 void to_json(nlohmann::json & json, const PerfNode & node);
37 
46 void
48 dataStore(std::ostream &, const PerfGraph *&, void *)
49 {
50 }
51 void
52 dataLoad(std::istream &, const PerfGraph *&, void *)
53 {
54 }
static InputParameters validParams()
void initialize() override
Called before execute() is ever called so that data can be cleared.
const PerfGraph *const & _graph
Reporter object that has a single execution of the "execute" method for for each execute flag...
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Reports the full graph from the PerfGraph.
void execute() override
Execute method.
void dataStore(std::ostream &, const PerfGraph *&, void *)
Store and load methods for const PerfGraph *, used in the PerfGraphReporter, which does nothing...
void dataLoad(std::istream &, const PerfGraph *&, void *)
void finalize() override
Finalize.
PerfGraphReporter(const InputParameters &parameters)
const InputParameters & parameters() const
Get the parameters of the object.
void to_json(nlohmann::json &json, const PerfGraph *const &perf_graph)
The PerfGraph will hold the master list of all registered performance segments and the head PerfNode...
Definition: PerfGraph.h:43
A node in the PerfGraph.
Definition: PerfNode.h:24