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 
16 {
18  params.addClassDescription("Modifies the non-linear step by applying a constant damping factor.");
19  params.addRequiredParam<Real>("damping",
20  "The percentage (between 0 and 1) of the newton update to take.");
21  return params;
22 }
23 
25  : GeneralDamper(parameters), _damping(getParam<Real>("damping"))
26 {
27 }
28 
29 Real
31  const NumericVector<Number> & /*update*/)
32 {
33  return _damping;
34 }
virtual Real computeDamping(const NumericVector< Number > &solution, const NumericVector< Number > &update) override
Return the constant damping value.
Base class for deriving general dampers.
Definition: GeneralDamper.h:21
ConstantDamper(const InputParameters &parameters)
static InputParameters validParams()
Definition: GeneralDamper.C:13
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Real _damping
The constant amount of the Newton update to take.
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...
registerMooseObject("MooseApp", ConstantDamper)
Simple constant damper.
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
static InputParameters validParams()