20 "solver_sys",
"nl0",
"Solver system for which this object applies.");
23 "The tag name of the custom vector tag to use in place of the residual vector. This can be "
24 "used to provide greater control over which variable is used in absolute and relative "
25 "tolerancing. If not provided, the full residual vector will be used.");
26 params.
addParam<TagName>(
"reference_vector",
"The tag name of the reference residual vector.");
27 params.
addParam<Real>(
"acceptable_multiplier",
29 "Multiplier applied to relative tolerance for acceptable limit");
31 "acceptable_iterations",
33 "Iterations after which convergence to acceptable limits is accepted");
34 params.
addParam<std::vector<std::vector<NonlinearVariableName>>>(
36 "Name of variables that are grouped together to check convergence. (Multiple groups can be "
37 "provided, separated by semicolon)");
38 params.
addParam<std::vector<NonlinearVariableName>>(
41 "If supplied, use only these variables in the individual variable convergence check");
42 params.
addParam<std::map<std::string, Real>>(
43 "variable_nl_abs_tol",
45 "Pairs of a variable name and the absolute tolerance that replaces nl_abs_tol in that "
46 "variable's convergence check. Variables in a group must have the same tolerance.");
47 params.
addParam<
bool>(
"unscale_the_residual",
49 "If set to true, utilize the variable specific residual scalar to unscale "
50 "the residual before comparing against the absolute tolerance. This will "
51 "also print the un-scaled residual to console. This will not change the "
52 "relative tolerance check except for console output");
53 MooseEnum Lnorm(
"global_L2 local_L2 global_Linf local_Linf",
"global_L2");
57 "The normalization type used to compare the reference and actual residuals.");
59 "Compare the L2 norm of the residual vector to the L2 norm of the "
60 "absolute reference vector to determine relative convergence");
61 Lnorm.addDocumentation(
63 "Compute the L2 norm of the residual vector divided component-wise by the absolute reference "
64 "vector to the L2 norm of the absolute reference vector to determine relative convergence");
65 Lnorm.addDocumentation(
67 "Compare the L-infinity norm of the residual vector to the L-infinity norm of the "
68 "absolute reference vector to determine relative convergence");
69 Lnorm.addDocumentation(
71 "Compute the L-infinity norm of the residual vector divided component-wise "
72 "by the absolute reference "
73 "vector to the L-infinity norm of the absolute reference vector to "
74 "determine relative convergence");
76 MooseEnum zero_ref_res(
"zero_tolerance relative_tolerance",
"relative_tolerance");
79 "Determine behavior if a reference residual value of zero is present "
80 "for a particular variable.");
82 "Solve is treated as converged if the residual is zero");
85 "Solve is treated as converged if the residual is below the relative tolerance");
88 "Acceptable convergence");
91 "Variables to check for convergence");
97 : _use_group_variables(false)
102 moose_object->
getParam<std::vector<std::vector<NonlinearVariableName>>>(
"group_variables");
const T & getParam(const std::string &name) const
Retrieve a parameter for the object.
bool isParamValid(const std::string &name) const
Test if the supplied parameter is valid.
void addDocumentation(const std::string &name, const std::string &doc)
Add an item documentation string.
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Every object that can be built by the factory should be derived from this class.
static InputParameters validParams()
ReferenceResidualInterface(const MooseObject *moose_object)
bool _use_group_variables
True if any variables are grouped.
std::vector< std::vector< NonlinearVariableName > > _group_variables
Name of variables that are grouped together to check convergence.