www.mooseframework.org
BoundingValueElementDamper.C
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 
11 
13 
14 template <>
17 {
19  params.addParam<Real>("max_value",
20  std::numeric_limits<Real>::max(),
21  "The maximum permissible iterative value for the variable.");
22  params.addParam<Real>("min_value",
23  std::numeric_limits<Real>::lowest(),
24  "The minimum permissible iterative value for the variable.");
25  return params;
26 }
27 
29  : ElementDamper(parameters),
30  _max_value(parameters.get<Real>("max_value")),
31  _min_value(parameters.get<Real>("min_value"))
32 {
33  if (_min_value > _max_value)
34  mooseError("max_value must be greater than min_value");
35 }
36 
37 Real
39 {
40  // Note that _u_increment contains the negative of the increment
41  if (_u[_qp] < _min_value)
42  return 1.0 - (_u[_qp] - _min_value) / -_u_increment[_qp];
43  else if (_u[_qp] > _max_value)
44  return 1.0 - (_u[_qp] - _max_value) / -_u_increment[_qp];
45 
46  return 1.0;
47 }
const Real & _min_value
The minimum permissible value of the variable.
const VariableValue & _u
Holds the current solution at the current quadrature point.
Definition: ElementDamper.h:81
unsigned int _qp
Quadrature point index.
Definition: ElementDamper.h:70
This class implements a damper that limits the value of a variable to be within user-specified bounds...
const VariableValue & _u_increment
The current Newton increment.
Definition: ElementDamper.h:79
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void mooseError(Args &&... args) const
Definition: MooseObject.h:147
const Real & _max_value
The maximum permissible value of the variable.
InputParameters validParams< BoundingValueElementDamper >()
Base class for deriving element dampers.
Definition: ElementDamper.h:33
InputParameters validParams< ElementDamper >()
Definition: ElementDamper.C:23
virtual Real computeQpDamping() override
Compute the damping for the current qp.
registerMooseObject("MooseApp", BoundingValueElementDamper)
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...
BoundingValueElementDamper(const InputParameters &parameters)