https://mooseframework.inl.gov
Loading...
Searching...
No Matches
TimeExtremeValue.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
13
14// Input parameters
17{
18public:
20
22 enum class ExtremeType
23 {
24 MAX,
25 MIN,
26 ABS_MAX,
28 };
29
31 enum class OutputType
32 {
34 TIME
35 };
36
42 virtual void initialize() override {}
43 virtual void execute() override;
44 virtual Real getValue() const override;
45
46protected:
48
51
52 // The output type ("extreme_value", "time")
54
56 Real & _value;
57
59 Real & _time;
60};
Real PostprocessorValue
various MOOSE typedefs
Definition MooseTypes.h:230
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
const InputParameters & parameters() const
Get the parameters of the object.
Definition MooseBase.h:131
A postprocessor for reporting the max/min value of another postprocessor over time.
ExtremeType
What type of extreme value we are going to compute.
Real & _time
The time the extreme value occurred.
OutputType
What output to return, the extreme value, or the time it occurred.
static InputParameters validParams()
virtual Real getValue() const override
This will get called to actually grab the final value the postprocessor has calculated.
virtual void execute() override
Execute method.
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Real & _value
The extreme value.
const PostprocessorValue & _postprocessor
ExtremeType _type
The extreme value type ("max", "min", etc.)
OutputType _output_type