www.mooseframework.org
include
postprocessors
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
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
};
TimeExtremeValue::validParams
static InputParameters validParams()
Definition:
TimeExtremeValue.C:18
TimeExtremeValue::_type
ExtremeType _type
The extreme value type ("max", "min", etc.)
Definition:
TimeExtremeValue.h:50
TimeExtremeValue::ExtremeType::MAX
TimeExtremeValue::_time
Real & _time
The time the extreme value occurred.
Definition:
TimeExtremeValue.h:59
TimeExtremeValue::_output_type
OutputType _output_type
Definition:
TimeExtremeValue.h:53
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
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Definition:
InputParameters.h:63
TimeExtremeValue::execute
virtual void execute() override
Execute method.
Definition:
TimeExtremeValue.C:86
GeneralPostprocessor
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
Definition:
GeneralPostprocessor.h:21
TimeExtremeValue::OutputType::EXTREME_VALUE
PostprocessorValue
Real PostprocessorValue
various MOOSE typedefs
Definition:
MooseTypes.h:191
TimeExtremeValue::TimeExtremeValue
TimeExtremeValue(const InputParameters ¶meters)
Class constructor.
Definition:
TimeExtremeValue.C:47
TimeExtremeValue::OutputType::TIME
TimeExtremeValue::ExtremeType::ABS_MIN
TimeExtremeValue::ExtremeType
ExtremeType
What type of extreme value we are going to compute.
Definition:
TimeExtremeValue.h:22
TimeExtremeValue::ExtremeType::ABS_MAX
TimeExtremeValue::_postprocessor
const PostprocessorValue & _postprocessor
Definition:
TimeExtremeValue.h:47
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
GeneralPostprocessor.h
MooseBaseParameterInterface::parameters
const InputParameters & parameters() const
Get the parameters of the object.
Definition:
MooseBaseParameterInterface.h:62
TimeExtremeValue::_value
Real & _value
The extreme value.
Definition:
TimeExtremeValue.h:56
TimeExtremeValue::initialize
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Definition:
TimeExtremeValue.h:42
TimeExtremeValue::ExtremeType::MIN
TimeExtremeValue
A postprocessor for reporting the max/min value of another postprocessor over time.
Definition:
TimeExtremeValue.h:16
TimeExtremeValue::OutputType
OutputType
What output to return, the extreme value, or the time it occurred.
Definition:
TimeExtremeValue.h:31
Generated on Wed Mar 27 2024 17:44:37 for www.mooseframework.org by
1.8.14