BoundingValueElementDamper

This class implements a damper that limits the value of a variable to be within user-specified bounds.

The value of the damper is modified at every quadrature point based on how far out of the defined bounds the variable is there, and in which direction the variable is 'incremented' between successive iterations, away or closer to the bound. The damping increases when the variable is moving further away from the prescribed bounds.

More information about dampers may be found on the Dampers syntax documentation.

Example input syntax

In this example, the variable u is being damped with minimum and maximum values of -1.5 and 1.5 respectively, with a minimum damping factor of 0.001.

[Dampers]
  [./limit]
    type = BoundingValueElementDamper
    variable = u
    max_value = 1.5
    min_value = -1.5
    min_damping = 0.001
  [../]
[]
(moose/test/tests/dampers/min_damping/min_elem_damping.i)

Input Parameters

  • 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

  • max_value1.79769e+308The maximum permissible iterative value for the variable.

    Default:1.79769e+308

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The maximum permissible iterative value for the variable.

  • 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

  • min_value-1.79769e+308The minimum permissible iterative value for the variable.

    Default:-1.79769e+308

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The minimum permissible iterative value for the variable.

  • 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