tud_lbm.operators.initialise

Initialisation operators — implementations of InitialiserOperator protocol.

Public API: build_initialise_fn()

Implementation modules (_standard.py, _multiphase_bubble.py, …) are internal; use the factory to access.

Example

from operators.initialise import build_initialise_fn

init = build_initialise_fn(“standard”) f = init((64, 64, 1), lattice, density=1.0) # grid_shape

Functions

build_initialise_fn(...)

Return an initialisation operator satisfying InitialiserOperator protocol.

Package Contents

tud_lbm.operators.initialise.build_initialise_fn(scheme: str = 'standard') → tud_lbm.operators.protocols.InitialiserOperator

Return an initialisation operator satisfying InitialiserOperator protocol.

Parameters:

scheme – Initialisation type name (“standard”, “multiphase_bubble”, …). Defaults to “standard”.

Returns:

A callable satisfying the InitialiserOperator protocol. Call form: operator(grid_shape, lattice, **kwargs) -> f.

Raises:

ValueError – If scheme is not registered.

Examples

>>> from operators.initialise import build_initialise_fn
>>> init = build_initialise_fn("standard")
>>> f = init((64, 64, 1), lattice, density=1.0)