- converge_onIf supplied, use only these variables in the individual variable convergence check
C++ Type:std::vector<NonlinearVariableName>
Unit:(no unit assumed)
Controllable:No
Description:If supplied, use only these variables in the individual variable convergence check
- normalization_typeglobal_L2The normalization type used to compare the reference and actual residuals.
Default:global_L2
C++ Type:MooseEnum
Controllable:No
Description:The normalization type used to compare the reference and actual residuals.
- residual_vectorThe tag name of the custom vector tag to use in place of the residual vector. This can be used to provide greater control over which variable is used in absolute and relative tolerancing. If not provided, the full residual vector will be used.
C++ Type:TagName
Controllable:No
Description:The tag name of the custom vector tag to use in place of the residual vector. This can be used to provide greater control over which variable is used in absolute and relative tolerancing. If not provided, the full residual vector will be used.
- unscale_the_residualFalseIf set to true, utilize the variable specific residual scalar to unscale the residual before comparing against the absolute tolerance. This will also print the un-scaled residual to console. This will not change the relative tolerance check except for console output
Default:False
C++ Type:bool
Controllable:No
Description:If set to true, utilize the variable specific residual scalar to unscale the residual before comparing against the absolute tolerance. This will also print the un-scaled residual to console. This will not change the relative tolerance check except for console output
- 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.
- zero_reference_residual_treatmentrelative_toleranceDetermine behavior if a reference residual value of zero is present for a particular variable.
Default:relative_tolerance
C++ Type:MooseEnum
Controllable:No
Description:Determine behavior if a reference residual value of zero is present for a particular variable.
ReferenceResidualConvergence
This Convergence is a DefaultNonlinearConvergence with a customized reference residual for its relative convergence checks. See ReferenceResidualProblem for more information.
Input Parameters
- acceptable_iterations0Iterations after which convergence to acceptable limits is accepted
Default:0
C++ Type:unsigned int
Controllable:No
Description:Iterations after which convergence to acceptable limits is accepted
- acceptable_multiplier1Multiplier applied to relative tolerance for acceptable limit
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Multiplier applied to relative tolerance for acceptable limit
Acceptable Convergence 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
- group_variablesName of variables that are grouped together to check convergence. (Multiple groups can be provided, separated by semicolon)
C++ Type:std::vector<std::vector<NonlinearVariableName>>
Unit:(no unit assumed)
Controllable:No
Description:Name of variables that are grouped together to check convergence. (Multiple groups can be provided, separated by semicolon)
Variables To Check For Convergence Parameters
- n_max_nonlinear_pingpong100The maximum number of times the nonlinear residual can ping pong before requesting halting the current evaluation and requesting timestep cut for transient simulations
Default:100
C++ Type:unsigned int
Controllable:No
Description:The maximum number of times the nonlinear residual can ping pong before requesting halting the current evaluation and requesting timestep cut for transient simulations
- nl_abs_div_tol1e+50Nonlinear Absolute Divergence Tolerance. A negative value disables this check.
Default:1e+50
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Nonlinear Absolute Divergence Tolerance. A negative value disables this check.
- nl_abs_step_tol0Nonlinear Absolute step Tolerance
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Nonlinear Absolute step Tolerance
- nl_abs_tol1e-50Nonlinear Absolute Tolerance
Default:1e-50
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Nonlinear Absolute Tolerance
- nl_div_tol1e+10Nonlinear Relative Divergence Tolerance. A negative value disables this check.
Default:1e+10
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Nonlinear Relative Divergence Tolerance. A negative value disables this check.
- nl_forced_its0The Number of Forced Nonlinear Iterations
Default:0
C++ Type:unsigned int
Controllable:No
Description:The Number of Forced Nonlinear Iterations
- nl_max_funcs10000Max Nonlinear solver function evaluations
Default:10000
C++ Type:unsigned int
Controllable:No
Description:Max Nonlinear solver function evaluations
- nl_max_its50Max Nonlinear Iterations
Default:50
C++ Type:unsigned int
Controllable:No
Description:Max Nonlinear Iterations
- nl_rel_step_tol0Nonlinear Relative step Tolerance
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Nonlinear Relative step Tolerance
- nl_rel_tol1e-08Nonlinear Relative Tolerance
Default:1e-08
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Nonlinear Relative Tolerance
Nonlinear Solver Parameters
- reference_vectorThe tag name of the reference residual vector.
C++ Type:TagName
Controllable:No
Description:The tag name of the reference residual vector.