ConstantDamper

under construction:Undocumented Class

The ConstantDamper has not been documented, if you would like to contribute to MOOSE by writing documentation, please see Documenting MOOSE. The content contained on this page explains the typical documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

!syntax description /Dampers/ConstantDamper

Input Parameters

  • 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.

Required 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

    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.

Advanced Parameters

References