LBMTensorBuffer

Tensor wrapper form LBM tensors

This object provides common tensor buffers for Lattice Boltzmann simulations. df type buffer adds distribution functions with extra dimension of size Q which corresponds to the choice of stencil. mv type buffer adds macroscopic vectorial buffers such as velocity and force. ms type buffer adds macroscopic scalar buffers such as density and speed.

Overview

Holds lattice quantities for LBM simulations: distribution functions (df), macroscopic scalars (ms) and vectors (mv). Use "buffer_type" to choose the storage type. Users have the option to read tensors from HDF5 file by supplying "file". To create compatible HDF5, please take a look at examples in !listing examples/lbm/Karman-vortex/cylinder.ipynb

Example Input File Syntax

[TensorBuffers<<<{"href": "../../syntax/TensorBuffers/index.html"}>>>]
  [velocity]
    type = LBMTensorBuffer<<<{"description": "Tensor wrapper form LBM tensors", "href": "LBMTensorBuffer.html"}>>>
    buffer_type<<<{"description": "The buffer type can be either distribution function (df), macroscopic scalar (ms) or macroscopic vectorial (mv)"}>>> = mv
  []
[]
(test/tests/lbm/channel2D.i)

Input Parameters

  • buffer_typeThe buffer type can be either distribution function (df), macroscopic scalar (ms) or macroscopic vectorial (mv)

    C++ Type:std::string

    Controllable:No

    Description:The buffer type can be either distribution function (df), macroscopic scalar (ms) or macroscopic vectorial (mv)

Required Parameters

  • fileOptional path of the file to read tensor form.

    C++ Type:FileName

    Controllable:No

    Description:Optional path of the file to read tensor form.

  • is_integerFalseWhether to specify integer dtype

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether to specify integer dtype

  • map_from_aux_variableSync the given AuxVariable to the buffer contents

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Sync the given AuxVariable to the buffer contents

  • map_to_aux_variableSync the given AuxVariable to the buffer contents

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Sync the given AuxVariable to the buffer contents

  • reciprocalFalseIs this a reciprocal space tensor?

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Is this a reciprocal space tensor?

  • value_dimensionsOptional value dimensions

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

    Controllable:No

    Description:Optional value dimensions

Optional 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