www.mooseframework.org
ConstantDamper.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 
10 #include "ConstantDamper.h"
11 
13 
15 
18 {
20  params.addRequiredParam<Real>("damping",
21  "The percentage (between 0 and 1) of the newton update to take.");
22  return params;
23 }
24 
26  : GeneralDamper(parameters), _damping(getParam<Real>("damping"))
27 {
28 }
29 
30 Real
31 ConstantDamper::computeDamping(const NumericVector<Number> & /*solution*/,
32  const NumericVector<Number> & /*update*/)
33 {
34  return _damping;
35 }
ConstantDamper::ConstantDamper
ConstantDamper(const InputParameters &parameters)
Definition: ConstantDamper.C:25
GeneralDamper::validParams
static InputParameters validParams()
Definition: GeneralDamper.C:15
ConstantDamper::_damping
Real _damping
The constant amount of the Newton update to take.
Definition: ConstantDamper.h:41
ConstantDamper::computeDamping
virtual Real computeDamping(const NumericVector< Number > &solution, const NumericVector< Number > &update) override
Return the constant damping value.
Definition: ConstantDamper.C:31
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition: InputParameters.h:53
ConstantDamper.h
registerMooseObject
registerMooseObject("MooseApp", ConstantDamper)
GeneralDamper
Base class for deriving general dampers.
Definition: GeneralDamper.h:26
defineLegacyParams
defineLegacyParams(ConstantDamper)
ConstantDamper::validParams
static InputParameters validParams()
Definition: ConstantDamper.C:17
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
Definition: InputParameters.h:1176
ConstantDamper
Simple constant damper.
Definition: ConstantDamper.h:26