SetupResidualDebugAction

Adds the necessary objects for computing the residuals for individual variables.

Overview

This Action object acts whenever the [Debug] block exists in the input file and provides parameters, as listed below, for creating the necessary object for computing the residual for the variables listed in the "show_var_residual" parameter. Please refer to the Debug System for more details.

  • active__all__ If specified only the blocks named will be visited and made active

    Default:__all__

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

    Unit:(no unit assumed)

    Controllable:No

    Description:If specified only the blocks named will be visited and made active

  • inactiveIf specified blocks matching these identifiers will be skipped.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:If specified blocks matching these identifiers will be skipped.

  • show_var_residualVariables for which residuals will be sent to the output file.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Variables for which residuals will be sent to the output file.

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

Advanced Parameters