Line data    Source code

       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 "ConstantDamper.h"
      11             : 
      12             : registerMooseObject("MooseApp", ConstantDamper);
      13             : 
      14             : InputParameters
      15        3175 : ConstantDamper::validParams()
      16             : {
      17        3175 :   InputParameters params = GeneralDamper::validParams();
      18        6350 :   params.addClassDescription("Modifies the non-linear step by applying a constant damping factor.");
      19        9525 :   params.addRequiredParam<Real>("damping",
      20             :                                 "The percentage (between 0 and 1) of the newton update to take.");
      21        3175 :   return params;
      22           0 : }
      23             : 
      24          57 : ConstantDamper::ConstantDamper(const InputParameters & parameters)
      25         114 :   : GeneralDamper(parameters), _damping(getParam<Real>("damping"))
      26             : {
      27          57 : }
      28             : 
      29             : Real
      30         362 : ConstantDamper::computeDamping(const NumericVector<Number> & /*solution*/,
      31             :                                const NumericVector<Number> & /*update*/)
      32             : {
      33         362 :   return _damping;
      34             : }