ReferenceResidualConvergence

This Convergence is a DefaultNonlinearConvergence with a customized reference residual for its relative convergence checks. See ReferenceResidualProblem for more information.

Input Parameters

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
Options:global_L2, local_L2, global_Linf, local_Linf
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
Options:zero_tolerance, relative_tolerance
Controllable:No
Description:Determine behavior if a reference residual value of zero is present for a particular variable.

Optional 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.

Reference Residual Parameters

Input Files

(test/tests/convergence/reference_residual_convergence/abs_ref.i)
(test/tests/convergence/reference_residual_convergence/custom_residual.i)
(test/tests/convergence/reference_residual_convergence/abs_ref_acceptable.i)
(test/tests/convergence/reference_residual_convergence/ad_abs_ref.i)
(modules/combined/test/tests/reference_residual/contact.i)
(test/tests/convergence/reference_residual_convergence/formatting.i)
(test/tests/convergence/reference_residual_convergence/reference_residual.i)
(test/tests/convergence/reference_residual_convergence/no_ref.i)

(test/tests/convergence/reference_residual_convergence/abs_ref.i)

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 10
[]

[GlobalParams]
  absolute_value_vector_tags = 'absref'
[]

[Problem]
  extra_tag_vectors = 'absref'
[]

[Variables]
  [u][]
  [v]
    scaling = 1e-6
  []
[]

[Functions]
  [ramp]
    type = ParsedFunction
    expression = 'if(t < 5, t - 5, 0) * x'
  []
[]

[Kernels]
  [u_dt]
    type = TimeDerivative
    variable = u
  []
  [u_coupled_rx]
    type = CoupledForce
    variable = u
    v = v
    coef = 1
  []

  [v_dt]
    type = TimeDerivative
    variable = v
  []
  [v_neg_force]
    type = BodyForce
    variable = v
    value = ${fparse -1 / 2}
    function = ramp
  []
  [v_force]
    type = BodyForce
    variable = v
    value = 1
    function = ramp
  []
[]

[Postprocessors]
  [u_avg]
    type = ElementAverageValue
    variable = u
    execute_on = 'TIMESTEP_END INITIAL'
  []
  [v_avg]
    type = ElementAverageValue
    variable = v
    execute_on = 'TIMESTEP_END INITIAL'
  []
  [timestep]
    type = TimePostprocessor
    outputs = 'none'
  []
  [v_old]
    type = ElementAverageValue
    variable = v
    execute_on = TIMESTEP_BEGIN
    outputs = none
  []
  [u_old]
    type = ElementAverageValue
    variable = u
    execute_on = TIMESTEP_BEGIN
    outputs = none
  []
  [v_exact]
    type = ParsedPostprocessor
    pp_names = 'timestep v_old'
    expression = 't := if(timestep > 5, 5, timestep); (t^2 - 9 * t) / 8'
  []
  [u_exact]
    type = ParsedPostprocessor
    pp_names = 'u_old v_exact'
    expression = 'u_old + v_exact'
  []
[]

[Convergence]
  [conv]
    type = ReferenceResidualConvergence
    reference_vector = 'absref'
  []
[]

[Executioner]
  type = Transient
  petsc_options = '-snes_converged_reason'
  petsc_options_iname = '-pc_type'
  petsc_options_value = 'lu'
  line_search = none
  num_steps = 10
  nl_rel_tol = 1e-06
  nonlinear_convergence = conv
  verbose = true
[]

[Outputs]
  csv = true
[]

(test/tests/convergence/reference_residual_convergence/custom_residual.i)

coef=1

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 2
[]

[Problem]
  # type = ReferenceResidualProblem
  extra_tag_vectors = 'u_ref u_res v_ref v_res'
[]

[Variables]
  [u][]
  [v][]
[]

[Kernels]
  [u_diff]
    type = CoefDiffusion
    variable = u
    coef = 1
    extra_vector_tags = 'u_res'
  []
  [u_rxn]
    type = PReaction
    variable = u
    coefficient = 1
    power = 2
    extra_vector_tags = 'u_res'
  []
  [u_f]
    type = BodyForce
    variable = u
    value = 1
    extra_vector_tags = 'u_res'
  []
  [v_diff]
    type = Diffusion
    variable = v
    extra_vector_tags = 'v_res'
  []
  [v_rxn]
    type = PReaction
    variable = v
    coefficient = 1
    power = 2
    extra_vector_tags = 'v_res'
  []
  [v_f]
    type = BodyForce
    variable = v
    value = 1
    extra_vector_tags = 'v_res'
  []
[]

[BCs]
  [u]
    type = RobinBC
    boundary = 'left right'
    coef = ${coef}
    variable = u
    extra_vector_tags = 'u_ref u_res'
  []
  [v]
    type = RobinBC
    boundary = 'left right'
    coef = 1
    variable = v
    extra_vector_tags = 'v_ref v_res'
  []
[]

[Convergence]
  [u_conv]
    type = ReferenceResidualConvergence
    reference_vector = 'u_ref'
    residual_vector = 'u_res'
  []
  [v_conv]
    type = ReferenceResidualConvergence
    reference_vector = 'v_ref'
    residual_vector = 'v_res'
  []
  [conv]
    type = ParsedConvergence
    convergence_expression = 'u_conv & v_conv'
    symbol_names = 'u_conv v_conv'
    symbol_values = 'u_conv v_conv'
  []
[]

[Executioner]
  type = Steady
  nonlinear_convergence = conv
[]

[Outputs]
  exodus = true
[]

(test/tests/convergence/reference_residual_convergence/abs_ref_acceptable.i)

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 10
[]

[GlobalParams]
  absolute_value_vector_tags = 'absref'
[]

[Problem]
  extra_tag_vectors = 'absref'
[]

[Variables]
  [u][]
  [v]
    scaling = 1e-6
  []
[]

[Functions]
  [ramp]
    type = ParsedFunction
    expression = 'if(t < 5, t - 5, 0) * x'
  []
[]

[Kernels]
  [u_dt]
    type = TimeDerivative
    variable = u
  []
  [u_coupled_rx]
    type = CoupledForce
    variable = u
    v = v
    coef = 1
  []

  [v_dt]
    type = TimeDerivative
    variable = v
  []
  [v_neg_force]
    type = BodyForce
    variable = v
    value = ${fparse -1 / 2}
    function = ramp
  []
  [v_force]
    type = BodyForce
    variable = v
    value = 1
    function = ramp
  []
[]

[Postprocessors]
  [u_avg]
    type = ElementAverageValue
    variable = u
    execute_on = 'TIMESTEP_END INITIAL'
  []
  [v_avg]
    type = ElementAverageValue
    variable = v
    execute_on = 'TIMESTEP_END INITIAL'
  []
  [timestep]
    type = TimePostprocessor
    outputs = 'none'
  []
  [v_old]
    type = ElementAverageValue
    variable = v
    execute_on = TIMESTEP_BEGIN
    outputs = none
  []
  [u_old]
    type = ElementAverageValue
    variable = u
    execute_on = TIMESTEP_BEGIN
    outputs = none
  []
  [v_exact]
    type = ParsedPostprocessor
    pp_names = 'timestep v_old'
    expression = 't := if(timestep > 5, 5, timestep); (t^2 - 9 * t) / 8'
  []
  [u_exact]
    type = ParsedPostprocessor
    pp_names = 'u_old v_exact'
    expression = 'u_old + v_exact'
  []
[]

[Convergence]
  [conv]
    type = ReferenceResidualConvergence
    reference_vector = 'absref'
    acceptable_iterations = 1
    acceptable_multiplier = 1e6
  []
[]

[Executioner]
  type = Transient
  petsc_options = '-snes_converged_reason'
  petsc_options_iname = '-pc_type'
  petsc_options_value = 'lu'
  line_search = none
  num_steps = 3
  nl_rel_tol = 1e-06
  nonlinear_convergence = conv
  verbose = true
[]

[Outputs]
  csv = true
  perf_graph = true
[]

(test/tests/convergence/reference_residual_convergence/ad_abs_ref.i)

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 10
[]

[GlobalParams]
  absolute_value_vector_tags = 'absref'
[]

[Problem]
  extra_tag_vectors = 'absref'
[]

[Variables]
  [u][]
  [v]
    scaling = 1e-6
  []
[]

[Functions]
  [ramp]
    type = ParsedFunction
    expression = 'if(t < 5, t - 5, 0) * x'
  []
[]

[Kernels]
  [u_dt]
    type = ADTimeDerivative
    variable = u
  []
  [u_coupled_rx]
    type = ADCoupledForce
    variable = u
    v = v
    coef = 1
  []

  [v_dt]
    type = ADTimeDerivative
    variable = v
  []
  [v_neg_force]
    type = ADBodyForce
    variable = v
    value = ${fparse -1 / 2}
    function = ramp
  []
  [v_force]
    type = ADBodyForce
    variable = v
    value = 1
    function = ramp
  []
[]

[Postprocessors]
  [u_avg]
    type = ElementAverageValue
    variable = u
    execute_on = 'TIMESTEP_END INITIAL'
  []
  [v_avg]
    type = ElementAverageValue
    variable = v
    execute_on = 'TIMESTEP_END INITIAL'
  []
  [timestep]
    type = TimePostprocessor
    outputs = 'none'
  []
  [v_old]
    type = ElementAverageValue
    variable = v
    execute_on = TIMESTEP_BEGIN
    outputs = none
  []
  [u_old]
    type = ElementAverageValue
    variable = u
    execute_on = TIMESTEP_BEGIN
    outputs = none
  []
  [v_exact]
    type = ParsedPostprocessor
    pp_names = 'timestep v_old'
    expression = 't := if(timestep > 5, 5, timestep); (t^2 - 9 * t) / 8'
  []
  [u_exact]
    type = ParsedPostprocessor
    pp_names = 'u_old v_exact'
    expression = 'u_old + v_exact'
  []
[]

[Convergence]
  [conv]
    type = ReferenceResidualConvergence
    reference_vector = 'absref'
  []
[]

[Executioner]
  type = Transient
  petsc_options = '-snes_converged_reason'
  petsc_options_iname = '-pc_type'
  petsc_options_value = 'lu'
  line_search = none
  num_steps = 10
  nl_rel_tol = 1e-06
  nonlinear_convergence = conv
  verbose = true
[]

[Outputs]
  csv = true
[]

(modules/combined/test/tests/reference_residual/contact.i)

AD = ''
use_ad = false
temp_scaling = 1
disp_x_scaling = ${fparse 1 / temp_scaling}

[GlobalParams]
  order = FIRST
  displacements = 'disp_x disp_y'
[]

[Problem]
  extra_tag_vectors = 'constraint_res kernel_res constraint_ref kernel_ref absolute_ref total_res'
[]

[Mesh]
  [gen]
    type = CartesianMeshGenerator
    dim = 2
    dx = '1 0.01 1'
    dy = 1
    ix = '5 1 5'
    iy = '20'
    subdomain_id = '0 1 2'
  []
  [rename]
    type = RenameBlockGenerator
    input = gen
    old_block = '0 1 2'
    new_block = 'a b c'
  []
  [sidesets_a]
    type = SideSetsBetweenSubdomainsGenerator
    input = rename
    new_boundary = a_right
    paired_block = b
    primary_block = a
  []
  [sidesets_c]
    type = SideSetsBetweenSubdomainsGenerator
    input = sidesets_a
    new_boundary = c_left
    paired_block = b
    primary_block = c
  []
  [delete]
    type = BlockDeletionGenerator
    input = sidesets_c
    block = b
  []

  patch_update_strategy = always
  coord_type = RZ
[]

[Variables]
  [temp]
    initial_condition = 298
    scaling = ${temp_scaling}
  []
  [disp_x]
    scaling = ${disp_x_scaling}
  []
  [disp_y]
  []
[]

[AuxVariables]
  [constraint_res_temp]
  []
  [constraint_res_disp_x]
  []
  [constraint_res_disp_y]
  []
  [kernel_res_temp]
  []
  [kernel_res_disp_x]
  []
  [kernel_res_disp_y]
  []

  [constraint_ref_temp]
  []
  [constraint_ref_disp_x]
  []
  [constraint_ref_disp_y]
  []
  [kernel_ref_temp]
  []
  [kernel_ref_disp_x]
  []
  [kernel_ref_disp_y]
  []

  [absolute_ref_temp]
  []
  [absolute_ref_disp_x]
  []
  [absolute_ref_disp_y]
  []
  [total_res_temp]
  []
  [total_res_disp_x]
  []
  [total_res_disp_y]
  []
[]

[AuxKernels]
  [constraint_res_temp_aux]
    type = TagVectorAux
    variable = constraint_res_temp
    v = temp
    vector_tag = constraint_res
  []
  [constraint_res_disp_x_aux]
    type = TagVectorAux
    variable = constraint_res_disp_x
    v = disp_x
    vector_tag = constraint_res
  []
  [constraint_res_disp_y_aux]
    type = TagVectorAux
    variable = constraint_res_disp_y
    v = disp_y
    vector_tag = constraint_res
  []
  [kernel_res_temp_aux]
    type = TagVectorAux
    variable = kernel_res_temp
    v = temp
    vector_tag = kernel_res
  []
  [kernel_res_disp_x_aux]
    type = TagVectorAux
    variable = kernel_res_disp_x
    v = disp_x
    vector_tag = kernel_res
  []
  [kernel_res_disp_y_aux]
    type = TagVectorAux
    variable = kernel_res_disp_y
    v = disp_y
    vector_tag = kernel_res
  []

  [constraint_ref_temp_aux]
    type = TagVectorAux
    variable = constraint_ref_temp
    v = temp
    vector_tag = constraint_ref
  []
  [constraint_ref_disp_x_aux]
    type = TagVectorAux
    variable = constraint_ref_disp_x
    v = disp_x
    vector_tag = constraint_ref
  []
  [constraint_ref_disp_y_aux]
    type = TagVectorAux
    variable = constraint_ref_disp_y
    v = disp_y
    vector_tag = constraint_ref
  []
  [kernel_ref_temp_aux]
    type = TagVectorAux
    variable = kernel_ref_temp
    v = temp
    vector_tag = kernel_ref
  []
  [kernel_ref_disp_x_aux]
    type = TagVectorAux
    variable = kernel_ref_disp_x
    v = disp_x
    vector_tag = kernel_ref
  []
  [kernel_ref_disp_y_aux]
    type = TagVectorAux
    variable = kernel_ref_disp_y
    v = disp_y
    vector_tag = kernel_ref
  []

  [absolute_ref_temp_aux]
    type = TagVectorAux
    variable = absolute_ref_temp
    v = temp
    vector_tag = absolute_ref
  []
  [absolute_ref_disp_x_aux]
    type = TagVectorAux
    variable = absolute_ref_disp_x
    v = disp_x
    vector_tag = absolute_ref
  []
  [absolute_ref_disp_y_aux]
    type = TagVectorAux
    variable = absolute_ref_disp_y
    v = disp_y
    vector_tag = absolute_ref
  []
  [total_res_temp_aux]
    type = TagVectorAux
    variable = total_res_temp
    v = temp
    vector_tag = total_res
  []
  [total_res_disp_x_aux]
    type = TagVectorAux
    variable = total_res_disp_x
    v = disp_x
    vector_tag = total_res
  []
  [total_res_disp_y_aux]
    type = TagVectorAux
    variable = total_res_disp_y
    v = disp_y
    vector_tag = total_res
  []
[]

[Physics/SolidMechanics/QuasiStatic]
  [all]
    block = 'a c'
    strain = FINITE
    eigenstrain_names = 'thermal_strain'
    temperature = temp
    use_automatic_differentiation = ${use_ad}
    volumetric_locking_correction = true
    extra_vector_tags = 'kernel_res total_res'
    absolute_value_vector_tags = 'absolute_ref kernel_ref'
  []
[]

[Kernels]
  [heat]
    type = ${AD}Diffusion
    block = 'a c'
    variable = temp
    extra_vector_tags = 'kernel_res total_res'
    absolute_value_vector_tags = 'absolute_ref kernel_ref'
  []
  [heat_ie]
    type = ${AD}HeatConductionTimeDerivative
    block = 'a c'
    variable = temp
    specific_heat = 1
    density_name = 1
    extra_vector_tags = 'kernel_res total_res'
    absolute_value_vector_tags = 'absolute_ref kernel_ref'
  []
  [heat_source]
    type = BodyForce
    block = 'a c'
    variable = temp
    value = 5e3
    extra_vector_tags = 'kernel_res total_res'
    absolute_value_vector_tags = 'absolute_ref kernel_ref'
  []
[]

[Contact]
  [frictional]
    model = coulomb
    # model = frictionless
    formulation = mortar
    primary = a_right
    secondary = c_left
    friction_coefficient = 0.2
    extra_vector_tags = 'constraint_res total_res'
    absolute_value_vector_tags = 'absolute_ref constraint_ref'
  []
[]

[MortarGapHeatTransfer]
  [mortar_heat_transfer]
    temperature = temp
    use_displaced_mesh = true
    gap_flux_options = conduction
    gap_conductivity = 1
    boundary = 'a_right c_left'
    primary_boundary = a_right
    secondary_boundary = c_left
    primary_subdomain = frictional_primary_subdomain
    secondary_subdomain = frictional_secondary_subdomain
    gap_geometry_type = CYLINDER
    primary_emissivity = 0
    secondary_emissivity = 0
    extra_vector_tags = 'constraint_res total_res'
    absolute_value_vector_tags = 'absolute_ref constraint_ref'
  []
[]

[BCs]
  [no_y_clad]
    type = ${AD}DirichletBC
    variable = disp_y
    boundary = 'bottom'
    value = 0.0
    preset = false
    extra_vector_tags = 'constraint_res total_res'
    absolute_value_vector_tags = 'absolute_ref constraint_ref'
  []
  [no_x_clad]
    type = ${AD}DirichletBC
    variable = disp_x
    boundary = 'right'
    value = 0.0
    preset = false
    extra_vector_tags = 'constraint_res total_res'
    absolute_value_vector_tags = 'absolute_ref constraint_ref'
  []
  [Pressure]
    [coolantPressure]
      boundary = 'a_right c_left'
      factor = 0.345e6
      use_automatic_differentiation = ${use_ad}
      extra_vector_tags = 'constraint_res total_res'
    absolute_value_vector_tags = 'absolute_ref constraint_ref'
    []
  []
  [convection]
    type = ConvectiveHeatFluxBC
    variable = temp
    boundary = right
    T_infinity = 298
    heat_transfer_coefficient = 1e-1
    extra_vector_tags = 'constraint_res total_res'
    absolute_value_vector_tags = 'absolute_ref constraint_ref'
  []
  [top]
    type = ${AD}DirichletBC
    variable = temp
    boundary = top
    value = 298
    extra_vector_tags = 'constraint_res total_res'
    absolute_value_vector_tags = 'absolute_ref constraint_ref'
  []
[]

[Materials]
  [elasticity_tensor]
    type = ${AD}ComputeIsotropicElasticityTensor
    block = 'a c'
    poissons_ratio = 0.3
    youngs_modulus = 1e10
  []
  [thermal_expansion_a]
    type = ${AD}ComputeThermalExpansionEigenstrain
    thermal_expansion_coeff = 1e-5
    block = 'a'
    temperature = temp
    stress_free_temperature = 298.0
    eigenstrain_name = thermal_strain
  []
  [thermal_expansion_c]
    type = ${AD}ComputeThermalExpansionEigenstrain
    thermal_expansion_coeff = 1e-6
    block = 'c'
    temperature = temp
    stress_free_temperature = 298.0
    eigenstrain_name = thermal_strain
  []
  [stress]
    type = ${AD}ComputeFiniteStrainElasticStress
    block = 'a c'
  []
[]

[Convergence]
  [temp_ref_check]
    type = ReferenceResidualConvergence
    reference_vector = 'absolute_ref'
    converge_on = 'temp'
    nl_rel_tol = 5e-6
    nl_abs_tol = 5e-9
    nl_max_its = 20
    nl_div_tol = -1
    verbose = true
    unscale_the_residual = true
  []
  [disp_ref_check]
    type = ReferenceResidualConvergence
    reference_vector = 'absolute_ref'
    converge_on = 'disp_x disp_y'
    nl_rel_tol = 5e-6
    nl_abs_tol = 5e-9
    nl_max_its = 20
    nl_div_tol = -1
    verbose = true
    unscale_the_residual = true
  []
  [all_ref_conv]
    type = ParsedConvergence

    symbol_names = 'temp_ref_check disp_ref_check'
    symbol_values = 'temp_ref_check disp_ref_check'

    convergence_expression = 'temp_ref_check & disp_ref_check'
    divergence_expression = 'temp_ref_check | disp_ref_check'
  []
[]

[Executioner]
  type = Transient
  solve_type = 'NEWTON'
  nonlinear_convergence = all_ref_conv
  petsc_options = '-snes_ksp_ew -snes_converged_reason -ksp_converged_reason'
  petsc_options_iname = '-pc_type -pc_factor_shift_type -pc_factor_shift_amount'
  petsc_options_value = 'lu NONZERO               1e-25'
  line_search = 'none'
  verbose = true

  l_max_its = 60

  num_steps = 9
  dt = 0.1
[]

[Postprocessors]
  [temp_avg]
    type = ElementAverageValue
    variable = temp
    outputs = console
  []
  [constraint_res_temp]
    type = NodalL2Norm
    variable = constraint_res_temp
    outputs = console
  []
  [constraint_res_disp_x]
    type = NodalL2Norm
    variable = constraint_res_disp_x
    outputs = console
  []
  [constraint_res_disp_y]
    type = NodalL2Norm
    variable = constraint_res_disp_y
    outputs = console
  []
  [kernel_res_temp]
    type = NodalL2Norm
    variable = kernel_res_temp
    outputs = console
  []
  [kernel_res_disp_x]
    type = NodalL2Norm
    variable = kernel_res_disp_x
    outputs = console
  []
  [kernel_res_disp_y]
    type = NodalL2Norm
    variable = kernel_res_disp_y
    outputs = console
  []

  [constraint_ref_temp]
    type = NodalL2Norm
    variable = constraint_ref_temp
    outputs = console
  []
  [constraint_ref_disp_x]
    type = NodalL2Norm
    variable = constraint_ref_disp_x
    outputs = console
  []
  [constraint_ref_disp_y]
    type = NodalL2Norm
    variable = constraint_ref_disp_y
    outputs = console
  []
  [kernel_ref_temp]
    type = NodalL2Norm
    variable = kernel_ref_temp
    outputs = console
  []
  [kernel_ref_disp_x]
    type = NodalL2Norm
    variable = kernel_ref_disp_x
    outputs = console
  []
  [kernel_ref_disp_y]
    type = NodalL2Norm
    variable = kernel_ref_disp_y
    outputs = console
  []

  [absolute_ref_temp]
    type = NodalL2Norm
    variable = absolute_ref_temp
    outputs = console
  []
  [absolute_ref_disp_x]
    type = NodalL2Norm
    variable = absolute_ref_disp_x
    outputs = console
  []
  [absolute_ref_disp_y]
    type = NodalL2Norm
    variable = absolute_ref_disp_y
    outputs = console
  []
  [total_res_temp]
    type = NodalL2Norm
    variable = total_res_temp
    outputs = console
  []
  [total_res_disp_x]
    type = NodalL2Norm
    variable = total_res_disp_x
    outputs = console
  []
  [total_res_disp_y]
    type = NodalL2Norm
    variable = total_res_disp_y
    outputs = console
  []

  [scaled_res_temp]
    type = ParsedPostprocessor
    pp_names = 'total_res_temp'
    expression = 'total_res_temp / ${temp_scaling}'
  []
  [scaled_res_disp_x]
    type = ParsedPostprocessor
    pp_names = 'total_res_disp_x'
    expression = 'total_res_disp_x / ${disp_x_scaling}'
  []
  [total_num_nonlinear_its]
    type = NumNonlinearIterations
  []
[]

[Outputs]
  csv = true
  time_step_interval = 9
[]

[Debug]
  show_var_residual_norms = true
[]

(test/tests/convergence/reference_residual_convergence/formatting.i)

scaling = false

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 2
[]

[GlobalParams]
  absolute_value_vector_tags = 'ref'
[]

[Problem]
  extra_tag_vectors = 'ref'
[]

[Variables]
  [a]
  []
  [b]
  []
  [c]
  []
  [d]
  []
  [verylongvariable_e]
  []
  [variable_f]
  []
  [g]
  []
[]

[Kernels]
  [a_force]
    type = BodyForce
    variable = a
    value = 1e2
  []
  [b_force]
    type = BodyForce
    variable = b
    value = 1e3
  []
  [c_force]
    type = BodyForce
    variable = c
    value = 1e4
  []
  [d_force]
    type = BodyForce
    variable = d
    value = 1e5
  []
  [e_force]
    type = BodyForce
    variable = verylongvariable_e
    value = 1e6
  []
  [f_force]
    type = BodyForce
    variable = variable_f
    value = 1e7
  []
  [g_force]
    type = BodyForce
    variable = g
    value = 1e8
  []

  [a_dt]
    type = TimeDerivative
    variable = a
  []
  [b_dt]
    type = TimeDerivative
    variable = b
  []
  [c_dt]
    type = TimeDerivative
    variable = c
  []
  [d_dt]
    type = TimeDerivative
    variable = d
  []
  [e_dt]
    type = TimeDerivative
    variable = verylongvariable_e
  []
  [f_dt]
    type = TimeDerivative
    variable = variable_f
  []
  [g_dt]
    type = TimeDerivative
    variable = g
  []
[]

[BCs]
  [a_bc]
    type = DirichletBC
    variable = a
    boundary = 'left right'
    value = 1
  []
  [b_bc]
    type = DirichletBC
    variable = b
    boundary = 'left right'
    value = 1
  []
  [c_bc]
    type = DirichletBC
    variable = c
    boundary = 'left right'
    value = 1
  []
  [d_bc]
    type = DirichletBC
    variable = d
    boundary = 'left right'
    value = 1
  []
  [e_bc]
    type = DirichletBC
    variable = verylongvariable_e
    boundary = 'left right'
    value = 1
  []
  [f_bc]
    type = DirichletBC
    variable = variable_f
    boundary = 'left right'
    value = 1
  []
  [g_bc]
    type = DirichletBC
    variable = g
    boundary = 'left right'
    value = 1
  []
[]

[Convergence]
  [conv_one]
    type = ReferenceResidualConvergence
    reference_vector = 'ref'
    group_variables = 'a b variable_f; c d'
    converge_on = 'a b variable_f c d g'
    nl_rel_tol = 1e-9
    unscale_the_residual = ${scaling}
  []
  [conv_two]
    type = ReferenceResidualConvergence
    reference_vector = 'ref'
    converge_on = 'verylongvariable_e g'
    nl_rel_tol = 1e-9
    unscale_the_residual = ${scaling}
    normalization_type = LOCAL_L2
  []
  [combined]
    type = ParsedConvergence
    convergence_expression = 'conv_one & conv_two'
    symbol_names = 'conv_one conv_two'
    symbol_values = 'conv_one conv_two'
  []
[]

[Executioner]
  type = Transient
  num_steps = 1
  petsc_options_iname = '-pc_type'
  petsc_options_value = 'lu'
  line_search = none
  nonlinear_convergence = combined
  verbose = true
  automatic_scaling = ${scaling}
[]

[Outputs]
  exodus = true
[]

[Postprocessors]
  [a_avg]
    type = ElementAverageValue
    variable = a
  []
  [b_avg]
    type = ElementAverageValue
    variable = b
  []
  [c_avg]
    type = ElementAverageValue
    variable = c
  []
  [d_avg]
    type = ElementAverageValue
    variable = d
  []
  [e_avg]
    type = ElementAverageValue
    variable = verylongvariable_e
  []
  [f_avg]
    type = ElementAverageValue
    variable = variable_f
  []
[]

(test/tests/convergence/reference_residual_convergence/reference_residual.i)

coef=1

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 2
[]

[Problem]
  # type = ReferenceResidualProblem
  extra_tag_vectors = 'ref'
[]

[Variables]
  [u][]
  [v][]
[]

[Kernels]
  [u_diff]
    type = CoefDiffusion
    variable = u
    coef = ${coef}
  []
  [u_rxn]
    type = PReaction
    variable = u
    coefficient = ${coef}
    power = 2
  []
  [u_f]
    type = BodyForce
    variable = u
    value = ${coef}
  []
  [v_diff]
    type = Diffusion
    variable = v
  []
  [v_rxn]
    type = PReaction
    variable = v
    coefficient = 1
    power = 2
  []
  [v_f]
    type = BodyForce
    variable = v
    value = 1
  []
[]

[BCs]
  [u]
    type = RobinBC
    boundary = 'left right'
    coef = ${coef}
    variable = u
    extra_vector_tags = 'ref'
  []
  [v]
    type = RobinBC
    boundary = 'left right'
    coef = 1
    variable = v
    extra_vector_tags = 'ref'
  []
[]

[Convergence]
  [conv]
    type = ReferenceResidualConvergence
    reference_vector = 'ref'
  []
[]

[Executioner]
  type = Steady
  nonlinear_convergence = conv
[]

[Outputs]
  exodus = true
[]

(test/tests/convergence/reference_residual_convergence/no_ref.i)

[Mesh]
  type = GeneratedMesh
  dim = 1
  nx = 10
[]

[Variables]
  [u][]
  [v]
    scaling = 1e-6
  []
[]

[Functions]
  [ramp]
    type = ParsedFunction
    expression = 'if(t < 5, t - 5, 0) * x'
  []
[]

[Kernels]
  [u_dt]
    type = TimeDerivative
    variable = u
  []
  [u_coupled_rx]
    type = CoupledForce
    variable = u
    v = v
    coef = 1
  []

  [v_dt]
    type = TimeDerivative
    variable = v
  []
  [v_neg_force]
    type = BodyForce
    variable = v
    value = ${fparse -1 / 2}
    function = ramp
  []
  [v_force]
    type = BodyForce
    variable = v
    value = 1
    function = ramp
  []
[]

[Postprocessors]
  [u_avg]
    type = ElementAverageValue
    variable = u
    execute_on = 'TIMESTEP_END INITIAL'
  []
  [v_avg]
    type = ElementAverageValue
    variable = v
    execute_on = 'TIMESTEP_END INITIAL'
  []
  [timestep]
    type = TimePostprocessor
    outputs = 'none'
  []
  [v_old]
    type = ElementAverageValue
    variable = v
    execute_on = TIMESTEP_BEGIN
    outputs = none
  []
  [u_old]
    type = ElementAverageValue
    variable = u
    execute_on = TIMESTEP_BEGIN
    outputs = none
  []
  [v_exact]
    type = ParsedPostprocessor
    pp_names = 'timestep v_old'
    expression = 't := if(timestep > 5, 5, timestep); (t^2 - 9 * t) / 8'
  []
  [u_exact]
    type = ParsedPostprocessor
    pp_names = 'u_old v_exact'
    expression = 'u_old + v_exact'
  []
[]

[Convergence]
  [conv]
    type = ReferenceResidualConvergence
    nl_rel_tol = 1e-6
  []
[]

[Executioner]
  type = Transient
  petsc_options = '-snes_converged_reason'
  petsc_options_iname = '-pc_type'
  petsc_options_value = 'lu'
  line_search = none
  num_steps = 10
  nonlinear_convergence = conv
  verbose = true
[]

[Outputs]
  csv = true
  perf_graph = true
[]

Input Parameters
Input Files