- 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.
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.
commentnote:Clarification of starting iteration index
Some iteration loops, such as nonlinear iteration, begin with a convergence check with before taking any "step"; then after the first step, it has . Other iteration loops such as the fixed point iteration loop do not have such an initial convergence check, so in that case corresponds to the end of the first step. Choose "max_iterations" and "min_iterations" accordingly.
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
- 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