tud_lbm.operators.wetting.hysteresis
====================================

.. py:module:: tud_lbm.operators.wetting.hysteresis

.. autoapi-nested-parse::

   Wetting and hysteresis operators — implementations of wetting protocols.

   Public API: build_wetting_fn()

   Implementation modules (_contact_angle.py, _contact_line.py, hysteresis.py)
   are internal; use the factory to access.

   Utility helpers (build_wetting_applicator) and the
   WettingParams data class are re-exported for convenience.

   .. rubric:: Example

   from operators.wetting import build_wetting_fn

   contact_angle_fn = build_wetting_fn("contact_angle")
   ca_left, ca_right = contact_angle_fn(rho, rho_mean)



Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/tud_lbm/operators/wetting/hysteresis/hysteresis/index


Functions
---------

.. autoapisummary::

   tud_lbm.operators.wetting.hysteresis.build_wetting_fn


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

.. py:function:: build_wetting_fn(scheme: str = 'contact_angle') -> tud_lbm.operators.protocols.HysteresisOperator

   Return a wetting operator looked up from the registry.

   :param scheme: Wetting operator name ("contact_angle",
                  "contact_line_location", "hysteresis", or others).
                  Defaults to "contact_angle".

   :returns: A callable satisfying the HysteresisOperator protocol,
             registered under the "wetting" kind.

   :raises ValueError: If scheme is not registered.

   .. rubric:: Examples

   >>> from tud_lbm.operators.wetting import build_wetting_fn
   >>> ca_fn = build_wetting_fn("contact_angle")
   >>> ca_left, ca_right = ca_fn(rho, rho_mean)