BoundingValueElementDamper.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 "BoundingValueElementDamper.h"
 
registerMooseObject("MooseApp", BoundingValueElementDamper);
 
InputParameters
BoundingValueElementDamper::validParams()
{
  InputParameters params = ElementDamper::validParams();
  params.addClassDescription("This class implements a damper that limits the value of a variable "
                             "to be within user-specified bounds.");
  params.addParam<Real>("max_value",
                        std::numeric_limits<Real>::max(),
                        "The maximum permissible iterative value for the variable.");
  params.addParam<Real>("min_value",
                        std::numeric_limits<Real>::lowest(),
                        "The minimum permissible iterative value for the variable.");
  return params;
}
 
BoundingValueElementDamper::BoundingValueElementDamper(const InputParameters & parameters)
  : ElementDamper(parameters),
    _max_value(parameters.get<Real>("max_value")),
    _min_value(parameters.get<Real>("min_value"))
{
  if (_min_value > _max_value)
    mooseError("max_value must be greater than min_value");
}
 
Real
BoundingValueElementDamper::computeQpDamping()
{
  // Note that _u_increment contains the negative of the increment
  if (_u[_qp] < _min_value)
    return 1.0 - (_u[_qp] - _min_value) / -_u_increment[_qp];
  else if (_u[_qp] > _max_value)
    return 1.0 - (_u[_qp] - _max_value) / -_u_increment[_qp];
 
  return 1.0;
}