https://mooseframework.inl.gov
Loading...
Searching...
No Matches
src
postprocessors
SideExtremeValue.C
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
#include "
SideExtremeValue.h
"
11
12
registerMooseObject
(
"MooseApp"
,
SideExtremeValue
);
13
14
InputParameters
15
SideExtremeValue::validParams
()
16
{
17
InputParameters
params =
ExtremeValueBase<SideVariablePostprocessor>::validParams
();
18
params.
addCoupledVar
(
"proxy_variable"
,
19
"The name of the variable to use to identify the location at which "
20
"the variable value should be taken; if not provided, this defaults "
21
"to the 'variable'."
);
22
params.
addClassDescription
(
23
"Finds either the min or max variable value of a variable over a boundary."
);
24
return
params;
25
}
26
27
SideExtremeValue::SideExtremeValue
(
const
InputParameters
& parameters)
28
:
ExtremeValueBase
<
SideVariablePostprocessor
>(parameters),
29
_proxy_variable(isParamValid(
"proxy_variable"
) ? coupledValue(
"proxy_variable"
) : _u)
30
{
31
}
32
33
std::pair<Real, Real>
34
SideExtremeValue::getProxyValuePair
()
35
{
36
return
std::make_pair(
_proxy_variable
[
_qp
],
_u
[
_qp
]);
37
}
registerMooseObject
registerMooseObject("MooseApp", SideExtremeValue)
SideExtremeValue.h
ExtremeValueBase
Definition
ExtremeValueBase.h:20
ExtremeValueBase::validParams
static InputParameters validParams()
Definition
ExtremeValueBase.C:21
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition
InputParameters.h:68
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump.
Definition
InputParameters.C:81
InputParameters::addCoupledVar
void addCoupledVar(const std::string &name, const std::string &doc_string)
This method adds a coupled variable name pair.
Definition
InputParameters.C:253
SideExtremeValue
A postprocessor for collecting the side min or max value.
Definition
SideExtremeValue.h:17
SideExtremeValue::validParams
static InputParameters validParams()
Definition
SideExtremeValue.C:15
SideExtremeValue::getProxyValuePair
virtual std::pair< Real, Real > getProxyValuePair() override
Definition
SideExtremeValue.C:34
SideExtremeValue::_proxy_variable
const VariableValue & _proxy_variable
A proxy variable used to find the quadrature point at which to evaluate the variable.
Definition
SideExtremeValue.h:32
SideExtremeValue::SideExtremeValue
SideExtremeValue(const InputParameters ¶meters)
Definition
SideExtremeValue.C:27
SideVariablePostprocessor
Definition
SideVariablePostprocessor.h:16
SideVariablePostprocessor::_u
const VariableValue & _u
Holds the solution at current quadrature points.
Definition
SideVariablePostprocessor.h:29
SideVariablePostprocessor::_qp
unsigned int _qp
The current quadrature point.
Definition
SideVariablePostprocessor.h:35
Generated on Fri Aug 21 2026 13:33:59 for https://mooseframework.inl.gov by
1.9.8