ConstantDamper

under construction:Undocumented Class

The ConstantDamper has not been documented. The content contained on this page 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.

!syntax description /Dampers/ConstantDamper

Input Parameters

  • dampingThe percentage (between 0 and 1) of the newton update to take.

    C++ Type:double

    Options:

    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

    Options:

    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

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

Advanced Parameters

Input Files

References