LBMComputeResidual

Compute object for LBM residual.

This object simply computes the L1 difference between current and old timestep scalar vectors. This difference is used as a residual in LBM simulations to tell how far the simulaion is from stead-state.

Overview

Computes a simple residual measure from a supplied buffer, e.g., for convergence monitoring. Use "buffer" to select the destination and "speed" or another input for the source.

Example Input File Syntax

[TensorComputes<<<{"href": "../../syntax/TensorComputes/index.html"}>>>]
  [Solve<<<{"href": "../../syntax/TensorComputes/Solve/index.html"}>>>]
    [residual]
      type = LBMComputeResidual<<<{"description": "Compute object for LBM residual.", "href": "LBMComputeResidual.html"}>>>
      buffer<<<{"description": "The buffer this compute is writing to"}>>> = speed
      speed<<<{"description": "LB speed"}>>> = speed
    []
  []
[]
(test/tests/lbm/channel2D.i)

Input Parameters

  • bufferThe buffer this compute is writing to

    C++ Type:std::string

    Controllable:No

    Description:The buffer this compute is writing to

  • speedLB speed

    C++ Type:std::string

    Controllable:No

    Description:LB speed

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

Advanced Parameters

Input Files