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