lbmpy.lattice.ExportMacroscopics

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

Export macroscopic observables from a lattice.

ExportMacroscopics 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 from which observables are exported

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

• density (TensorField) – scalar field to store the density

• velocity (TensorField) – vector field to store the velocity

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