www.mooseframework.org
TimeExtremeValue.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
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 // Input parameters
17 {
18 public:
20 
22  enum class ExtremeType
23  {
24  MAX,
25  MIN,
26  ABS_MAX,
27  ABS_MIN
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 
46 protected:
48 
51 
52  // The output type ("extreme_value", "time")
54 
57 
60 };
static InputParameters validParams()
ExtremeType _type
The extreme value type ("max", "min", etc.)
Real & _time
The time the extreme value occurred.
OutputType _output_type
virtual Real getValue() const 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...
Real PostprocessorValue
various MOOSE typedefs
Definition: MooseTypes.h:191
TimeExtremeValue(const InputParameters &parameters)
Class constructor.
ExtremeType
What type of extreme value we are going to compute.
const PostprocessorValue & _postprocessor
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
const InputParameters & parameters() const
Get the parameters of the object.
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.
OutputType
What output to return, the extreme value, or the time it occurred.