- 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.
DefaultMultiAppFixedPointConvergence
This Convergence is the default convergence for fixed point solves, using a combination of criteria to determine convergence.
warningwarning:Shared executioner parameters
This object shares several parameters with the executioner. If one of these parameters is set by the user in the executioner and not in the convergence object, then the value is taken from the executioner, rather than the default value. If a parameter is set by the user in both the executioner and the convergence object, an error is thrown.
The parameter "fixed_point_min_its" specifies the minimum number of iterations before convergence can occur. The parameter "fixed_point_max_its" specifies the maximum number of iterations, upon which the solution will either diverge or if "accept_on_max_fixed_point_iteration" is specified to be true, converge.
This Convergence allows checking for convergence on iteration in two ways:
checking the nonlinear residual norm (discrete norm) against tolerances, and
checking a post-processor value or change in value, specified by "custom_pp", against tolerances.
Residual Norm Checks
The residual norm checks are active unless "disable_fixed_point_residual_norm_check" is set to true; convergence is declared if either of the following are true:
where
.
is the
TIMESTEP_BEGINnorm for iteration .is the
TIMESTEP_ENDnorm for iteration .is the
MULTIAPP_FIXED_POINT_BEGINnorm.is the absolute residual tolerance, provided by "fixed_point_abs_tol".
is the relative residual tolerance, provided by "fixed_point_rel_tol".
Post-processor Checks
For the post-processor checks, activated by specifying "custom_pp", there is an option "direct_pp_value" which determines whether the post-processor value itself is checked or if the difference with the previous iteration value is used. If "direct_pp_value" is set to true, convergence is declared if either of the following are true:
where
is the absolute post-processor tolerance., provided by "custom_abs_tol".
is the relative post-processor tolerance., provided by "custom_rel_tol".
If "direct_pp_value" is set to false, convergence is declared if either of the following are true:
Input Parameters
- accept_on_max_fixed_point_iterationFalseTrue to treat reaching the maximum number of fixed point iterations as converged.
Default:False
C++ Type:bool
Controllable:No
Description:True to treat reaching the maximum number of fixed point iterations as converged.
- custom_abs_tol1e-50The absolute nonlinear residual to shoot for during fixed point iterations. This check is performed based on postprocessor defined by the custom_pp residual.
Default:1e-50
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The absolute nonlinear residual to shoot for during fixed point iterations. This check is performed based on postprocessor defined by the custom_pp residual.
- custom_ppPostprocessor for custom fixed point convergence check.
C++ Type:PostprocessorName
Unit:(no unit assumed)
Controllable:No
Description:Postprocessor for custom fixed point convergence check.
- custom_rel_tol1e-08The relative nonlinear residual drop to shoot for during fixed point iterations. This check is performed based on the postprocessor defined by custom_pp residual.
Default:1e-08
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The relative nonlinear residual drop to shoot for during fixed point iterations. This check is performed based on the postprocessor defined by custom_pp residual.
- direct_pp_valueFalseTrue to use direct postprocessor value (scaled by value on first iteration). False (default) to use difference in postprocessor value between fixed point iterations.
Default:False
C++ Type:bool
Controllable:No
Description:True to use direct postprocessor value (scaled by value on first iteration). False (default) to use difference in postprocessor value between fixed point iterations.
- disable_fixed_point_residual_norm_checkFalseDisable the residual norm evaluation thus the three parameters fixed_point_rel_tol, fixed_point_abs_tol and fixed_point_force_norms.
Default:False
C++ Type:bool
Controllable:No
Description:Disable the residual norm evaluation thus the three parameters fixed_point_rel_tol, fixed_point_abs_tol and fixed_point_force_norms.
- fixed_point_abs_tol1e-50The absolute nonlinear residual to shoot for during fixed point iterations. This check is performed based on the main app's nonlinear residual.
Default:1e-50
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The absolute nonlinear residual to shoot for during fixed point iterations. This check is performed based on the main app's nonlinear residual.
- fixed_point_force_normsFalseForce the evaluation of both the TIMESTEP_BEGIN and TIMESTEP_END norms regardless of the existence of active MultiApps with those execute_on flags, default: false.
Default:False
C++ Type:bool
Controllable:No
Description:Force the evaluation of both the TIMESTEP_BEGIN and TIMESTEP_END norms regardless of the existence of active MultiApps with those execute_on flags, default: false.
- fixed_point_max_its1Specifies the maximum number of fixed point iterations.
Default:1
C++ Type:unsigned int
Controllable:No
Description:Specifies the maximum number of fixed point iterations.
- fixed_point_min_its1Specifies the minimum number of fixed point iterations.
Default:1
C++ Type:unsigned int
Controllable:No
Description:Specifies the minimum number of fixed point iterations.
- fixed_point_rel_tol1e-08The relative nonlinear residual drop to shoot for during fixed point iterations. This check is performed based on the main app's nonlinear residual.
Default:1e-08
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:The relative nonlinear residual drop to shoot for during fixed point iterations. This check is performed based on the main app's nonlinear residual.
Fixed Point Iterations 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