ComponentsConvergence

This IterationCountConvergence can be used with the Components system to check the convergence of all Components that return a Convergence object with getNonlinearConvergence(). The inner convergence check returns its convergence status as follows:

  • CONVERGED: All Convergence objects created by Components are CONVERGED

  • DIVERGED: Any Convergence object created by a Component is DIVERGED

  • ITERATING: Not CONVERGED nor DIVERGED

Input Parameters

  • converge_at_max_iterationsFalseConverge at 'max_iterations' instead of diverging

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Converge at 'max_iterations' instead of diverging

  • max_iterations50Maximum number of iterations

    Default:50

    C++ Type:unsigned int

    Controllable:No

    Description:Maximum number of iterations

  • min_iterations0Minimum number of iterations

    Default:0

    C++ Type:unsigned int

    Controllable:No

    Description:Minimum number of iterations

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

    Default:False

    C++ Type:bool

    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>

    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

    Controllable:No

    Description:Set the enabled status of the MooseObject.

  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Determines whether this object is calculated using an implicit or explicit form

Advanced Parameters

Input Files