tud_lbm.operators.initialise
============================

.. py:module:: tud_lbm.operators.initialise

.. autoapi-nested-parse::

   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.

   .. rubric:: 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
---------

.. autoapisummary::

   tud_lbm.operators.initialise.build_initialise_fn


Package Contents
----------------

.. py:function:: build_initialise_fn(scheme: str = 'standard') -> tud_lbm.operators.protocols.InitialiserOperator

   Return an initialisation operator satisfying InitialiserOperator protocol.

   :param 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.

   .. rubric:: Examples

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