Residual

This post-processor computes the nonlinear residual norm. The parameter "residual_type" may have one of the following values:

  • FINAL: The final norm, obtained by NonlinearSystemBase::finalNonlinearResidual()

  • INITIAL: The post-SMO initial residual norm, obtained by NonlinearSystemBase::preSMOResidual(). For the definition of pre- vs. post-SMO residual, see NonlinearSystem.

  • PRE_SMO: The pre-SMO initial residual norm, obtained by NonlinearSystemBase::initialResidual()

  • CURRENT: The current norm, obtained directly from the PETSc SNES object. Note that the norm obtained from PETSc does not always provide the latest value; for example, executing on NONLINEAR yields 0.

  • COMPUTE: The norm is actually computed at the time of execution.

A common use of this post-processor is to assess the convergence of iterative solve loops using PostprocessorConvergence or MultiPostprocessorConvergence, for example. For this to work as expected, the execute_on parameter of the post-processor must include values that trigger execution before the desired check. The following table lists general recommendations for which execute_on flags to include for each type of convergence check. See SetupInterface for details on different execution points.

Convergence CheckRecommended residual_typeRecommended execute_on
NonlinearCURRENTNONLINEAR_CONVERGENCE
MultiApp fixed point, executing MultiApps only on TIMESTEP_BEGINCOMPUTETIMESTEP_BEGIN
MultiApp fixed point, executing MultiApps only on TIMESTEP_ENDCOMPUTEMULTIAPP_FIXED_POINT_CONVERGENCE
MultiApp fixed point, executing MultiApps only on both TIMESTEP_BEGIN and TIMESTEP_ENDCOMPUTEUse two Residual objects, one with execute_on = MULTIAPP_FIXED_POINT_CONVERGENCE for the TIMESTEP_END MultiApps and one with execute_on = TIMESTEP_BEGIN for the TIMESTEP_BEGIN MultiApps. Then combine both with the & operator in ParsedConvergence
Multi-system fixed pointCOMPUTEMULTISYSTEM_FIXED_POINT_CONVERGENCE

More information about residuals and their use in Newton's method may be found in NonlinearSystem.

The residual may be split by variables using the VariableResidual postprocessor.

Example input syntax

In this example, u is the solution of a diffusion problem. A predictor time integrating scheme is used and the Residual postprocessor reports the residual.

[Postprocessors<<<{"href": "../../syntax/Postprocessors/index.html"}>>>]
  [final_residual]
    type = Residual<<<{"description": "Report the non-linear residual.", "href": "Residual.html"}>>>
    residual_type<<<{"description": "Type of residual to be reported."}>>> = FINAL
  []
  [initial_residual]
    type = Residual<<<{"description": "Report the non-linear residual.", "href": "Residual.html"}>>>
    residual_type<<<{"description": "Type of residual to be reported."}>>> = INITIAL
  []
[]
(test/tests/predictors/simple/predictor_test.i)

Input Parameters

  • residual_typeFINALType of residual to be reported.

    Default:FINAL

    C++ Type:MooseEnum

    Options:FINAL, INITIAL_BEFORE_PRESET, INITIAL_AFTER_PRESET, PRE_SMO, INITIAL, CURRENT, COMPUTE

    Controllable:No

    Description:Type of residual to be reported.

Optional Parameters

  • allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

    Default:False

    C++ Type:bool

    Controllable:No

    Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).

  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:XFEM_MARK, FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, MULTISYSTEM_FIXED_POINT_CONVERGENCE, FINAL, CUSTOM, TRANSFER

    Controllable:No

    Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

  • execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

    Default:0

    C++ Type:int

    Controllable:No

    Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.

  • force_postauxFalseForces the UserObject to be executed in POSTAUX

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Forces the UserObject to be executed in POSTAUX

  • force_preauxFalseForces the UserObject to be executed in PREAUX

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Forces the UserObject to be executed in PREAUX

  • force_preicFalseForces the UserObject to be executed in PREIC during initial setup

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Forces the UserObject to be executed in PREIC during initial setup

Execution Scheduling 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:Yes

    Description:Set the enabled status of the MooseObject.

  • outputsVector of output names where you would like to restrict the output of variables(s) associated with this object

    C++ Type:std::vector<OutputName>

    Controllable:No

    Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

  • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Unit:(no unit assumed)

    Controllable:No

    Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

  • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

Material Property Retrieval Parameters

Input Files