https://mooseframework.inl.gov
PerfGraphData.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 "GeneralPostprocessor.h"
13 
15 {
16 public:
18 
20 
21  virtual void initialize() override {}
22  virtual void execute() override {}
23  virtual void finalize() override;
24  virtual Real getValue() const override;
25 
26 protected:
28  const int _data_type;
29 
31  const std::string & _section_name;
32 
34  const bool _must_exist;
35 
36 private:
39 };
virtual void execute() override
Execute method.
Definition: PerfGraphData.h:22
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
virtual Real getValue() const override
This will get called to actually grab the final value the postprocessor has calculated.
Definition: PerfGraphData.C:49
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
static InputParameters validParams()
Definition: PerfGraphData.C:15
virtual void finalize() override
This is called after execute() and after threadJoin()! This is probably where you want to do MPI comm...
Definition: PerfGraphData.C:41
Real _current_data
The current data.
Definition: PerfGraphData.h:38
const int _data_type
The data type to request in regards to the PerfGraph section.
Definition: PerfGraphData.h:28
PerfGraphData(const InputParameters &parameters)
Definition: PerfGraphData.C:32
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Definition: PerfGraphData.h:21
const InputParameters & parameters() const
Get the parameters of the object.
const bool _must_exist
Whether or not the section must exist (if it does not, 0 is returned)
Definition: PerfGraphData.h:34
const std::string & _section_name
The section name in the PerfGraph to query.
Definition: PerfGraphData.h:31