lbmpy.lattice.SetEquilibrium

class SetEquilibrium(lattice, method, density, velocity, *, name=None)

Initialize a Lattice to equilibrium state.

SetEquilibrium is a pystencils.flow flowgraph. To use it, either convert it directly to an Operator, or embed it as a subgraph into a larger operator.

Parameters:

• lattice (Lattice) – Lattice that should be initialized

• method (AbstractLbMethod | Collide | LbmCollisionRule) – LB method object or collision rule

• density (Expr | TensorField) – expression or scalar field that provides the density

• velocity (tuple[Expr, ...] | TensorField) – tuple of expressions or vector field that defined the velocity

• name (str | None) – Optional, name of the SetEquilibrium graph