www.mooseframework.org
TimeExtremeValue.h
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
15 #ifndef TIMEEXTREMEVALUE_H
16 #define TIMEEXTREMEVALUE_H
17 
18 #include "GeneralPostprocessor.h"
19 
20 // Forward Declarations
21 class TimeExtremeValue;
22 
23 // Input parameters
24 template <>
26 
29 {
30 public:
33  {
34  MAX,
35  MIN,
38  };
39 
45  virtual void initialize() override {}
46  virtual void execute() override;
47  virtual Real getValue() override;
48 
49 protected:
51 
54 
56  Real & _value;
57 };
58 
59 #endif
ExtremeType _type
The extreme value type ("max", "min", etc.)
virtual Real getValue() override
This will get called to actually grab the final value the postprocessor has calculated.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
virtual void execute() override
Execute method.
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
InputParameters validParams< TimeExtremeValue >()
Real PostprocessorValue
MOOSE typedefs.
Definition: MooseTypes.h:73
TimeExtremeValue(const InputParameters &parameters)
Class constructor.
ExtremeType
What type of extreme value we are going to compute.
const PostprocessorValue & _postprocessor
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:53
Real & _value
The extreme value.
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
A postprocessor for reporting the max/min value of another postprocessor over time.