- dampingThe percentage (between 0 and 1) of the newton update to take.
C++ Type:double
Description:The percentage (between 0 and 1) of the newton update to take.
ConstantDamper
buildconstruction:Undocumented Class
The ConstantDamper has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
# ConstantDamper
!syntax description /Dampers/ConstantDamper
## Overview
!! Replace these lines with information regarding the ConstantDamper object.
## Example Input File Syntax
!! Describe and include an example of how to use the ConstantDamper object.
!syntax parameters /Dampers/ConstantDamper
!syntax inputs /Dampers/ConstantDamper
!syntax children /Dampers/ConstantDamper
Modifies the non-linear step by applying a constant damping factor.
Input Parameters
- min_damping0Minimum value of computed damping. Damping lower than this will result in an exception being thrown and cutting the time step
Default:0
C++ Type:double
Description:Minimum value of computed damping. Damping lower than this will result in an exception being thrown and cutting the time step
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Description:Adds user-defined labels for accessing object parameters via control logic.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Description:Set the enabled status of the MooseObject.