MaxIncrement

Limits a variable's update by some max fraction

The MaxIncrement damper limits the change of a variable from one nonlinear iteration to the following iteration. A smaller value set as the max_increment will results in more nonlinear steps.

Example Input Syntax

[Dampers]
  [./max_inc_damp]
    type = MaxIncrement
    max_increment = 0.1
    variable = u
  [../]
[]
(moose/test/tests/dampers/max_increment/max_increment_damper_test.i)

Input Parameters

  • max_incrementThe maximum newton increment for the variable.

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The maximum newton increment for the variable.

  • variableThe name of the variable that this damper operates on

    C++ Type:NonlinearVariableName

    Unit:(no unit assumed)

    Controllable:No

    Description:The name of the variable that this damper operates on

Required Parameters

  • increment_typeabsoluteType of increment to compare against max_increment. 'absolute': use variable increment. 'fractional': use variable increment divided by the variable value.

    Default:absolute

    C++ Type:MooseEnum

    Unit:(no unit assumed)

    Options:absolute, fractional

    Controllable:No

    Description:Type of increment to compare against max_increment. 'absolute': use variable increment. 'fractional': use variable increment divided by the variable value.

  • 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

    Unit:(no unit assumed)

    Controllable:No

    Description:Minimum value of computed damping. Damping lower than this will result in an exception being thrown and cutting the time step

  • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Unit:(no unit assumed)

    Controllable:No

    Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

  • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Unit:(no unit assumed)

    Controllable:No

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

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:Yes

    Description:Set the enabled status of the MooseObject.

Advanced Parameters