https://mooseframework.inl.gov
include
postprocessors
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
14
class
PerfGraphData
:
public
GeneralPostprocessor
15
{
16
public
:
17
static
InputParameters
validParams
();
18
19
PerfGraphData
(
const
InputParameters
&
parameters
);
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
:
38
Real
_current_data
;
39
};
PerfGraphData::execute
virtual void execute() override
Execute method.
Definition:
PerfGraphData.h:22
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Definition:
InputParameters.h:66
PerfGraphData::getValue
virtual Real getValue() const override
This will get called to actually grab the final value the postprocessor has calculated.
Definition:
PerfGraphData.C:49
GeneralPostprocessor
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
Definition:
GeneralPostprocessor.h:21
PerfGraphData::validParams
static InputParameters validParams()
Definition:
PerfGraphData.C:15
PerfGraphData::finalize
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
PerfGraphData::_current_data
Real _current_data
The current data.
Definition:
PerfGraphData.h:38
PerfGraphData::_data_type
const int _data_type
The data type to request in regards to the PerfGraph section.
Definition:
PerfGraphData.h:28
PerfGraphData::PerfGraphData
PerfGraphData(const InputParameters ¶meters)
Definition:
PerfGraphData.C:32
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
PerfGraphData::initialize
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Definition:
PerfGraphData.h:21
GeneralPostprocessor.h
PerfGraphData
Definition:
PerfGraphData.h:14
MooseBaseParameterInterface::parameters
const InputParameters & parameters() const
Get the parameters of the object.
Definition:
MooseBaseParameterInterface.h:62
PerfGraphData::_must_exist
const bool _must_exist
Whether or not the section must exist (if it does not, 0 is returned)
Definition:
PerfGraphData.h:34
PerfGraphData::_section_name
const std::string & _section_name
The section name in the PerfGraph to query.
Definition:
PerfGraphData.h:31
Generated on Wed Jul 16 2025 13:56:05 for https://mooseframework.inl.gov by
1.8.14