PostprocessorConvergence

This Convergence derives from IterationCountConvergence and compares a Postprocessor value to a tolerance :

For this to work as expected, the execute_on parameter of the post-processor must include values that trigger execution before the desired check. For example, for assessing convergence of the nonlinear solve, the value NONLINEAR_CONVERGENCE should be used.

Typically the post-processor used should attempt to approximate the error in a system, such as AverageVariableChange.

Input Parameters

  • postprocessorPost-processor to use for convergence criteria

    C++ Type:PostprocessorName

    Unit:(no unit assumed)

    Controllable:No

    Description:Post-processor to use for convergence criteria

  • toleranceTolerance to use for convergence criteria

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Tolerance to use for convergence criteria

Required Parameters

  • converge_at_max_iterationsFalseConverge at 'max_iterations' instead of diverging

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Converge at 'max_iterations' instead of diverging

  • execute_onLINEARThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

    Default:LINEAR

    C++ Type:ExecFlagEnum

    Unit:(no unit assumed)

    Options:NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM

    Controllable:No

    Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

  • max_iterations50Maximum number of iterations

    Default:50

    C++ Type:unsigned int

    Unit:(no unit assumed)

    Controllable:No

    Description:Maximum number of iterations

  • min_iterations0Minimum number of iterations

    Default:0

    C++ Type:unsigned int

    Unit:(no unit assumed)

    Controllable:No

    Description:Minimum number of iterations

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:No

    Description:Set the enabled status of the MooseObject.

Advanced Parameters