tud_lbm.operators.collision
===========================

.. py:module:: tud_lbm.operators.collision

.. autoapi-nested-parse::

   Collision operators — implementations of CollisionOperator protocol.

   Public API: build_collision_fn()

   Implementation modules (_bgk.py, _mrt.py) are internal; use the factory to access.

   .. rubric:: Example

   from operators.collision import build_collision_fn

   collision_fn = build_collision_fn("bgk")
   f_col = collision_fn(f, feq, tau)



Functions
---------

.. autoapisummary::

   tud_lbm.operators.collision.build_collision_fn


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

.. py:function:: build_collision_fn(scheme: str) -> tud_lbm.operators.protocols.CollisionOperator

   Return a collision operator satisfying CollisionOperator protocol.

   :param scheme: Collision model name ("bgk" or "mrt").

   :returns: A callable satisfying the CollisionOperator protocol.
             Can be called as: operator(f, feq, tau, source=None) → f_col

             Type-checkers see this as a CollisionOperator, so:
                 op: CollisionOperator = build_collision_fn("bgk")

             Type-checkers will verify any use of op matches the protocol.

   :raises ValueError: If scheme is not registered.

   .. rubric:: Examples

   >>> from operators.collision import build_collision_fn
   >>> bgk = build_collision_fn("bgk")
   >>> f_col = bgk(f, feq, tau)