SideExtremeValue.C

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html

#include "SideExtremeValue.h"

registerMooseObject("MooseApp", SideExtremeValue);

InputParameters
SideExtremeValue::validParams()
{
  InputParameters params = ExtremeValueBase<SideVariablePostprocessor>::validParams();
  params.addCoupledVar("proxy_variable",
                       "The name of the variable to use to identify the location at which "
                       "the variable value should be taken; if not provided, this defaults "
                       "to the 'variable'.");
  params.addClassDescription(
      "Finds either the min or max variable value of a variable over a boundary.");
  return params;
}

SideExtremeValue::SideExtremeValue(const InputParameters & parameters)
  : ExtremeValueBase<SideVariablePostprocessor>(parameters),
    _proxy_variable(isParamValid("proxy_variable") ? coupledValue("proxy_variable") : _u)
{
}

std::pair<Real, Real>
SideExtremeValue::getProxyValuePair()
{
  return std::make_pair(_proxy_variable[_qp], _u[_qp]);
}