IterationCountConvergence

This Convergence specifies:

  • , the maximum number of iterations, via "max_iterations", and

  • , the minimum number of iterations, via "min_iterations".

If "converge_at_max_iterations" is set to true, then the solve will converge when instead of diverge.

Design

Other Convergence objects may inherit from this class and override checkConvergenceInner(iter) instead of the usual checkConvergence(iter), to inherit the iteration bounds. An example is PostprocessorConvergence.

Input 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

  • verboseFalseEnable printing of additional information, including convergence and divergence reasons.

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Enable printing of additional information, including convergence and divergence reasons.

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