tud_lbm.operators.wetting.hysteresis

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.

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

• tud_lbm.operators.wetting.hysteresis.hysteresis

Functions

build_wetting_fn(...)

Return a wetting operator looked up from the registry.

Package Contents

tud_lbm.operators.wetting.hysteresis.build_wetting_fn(scheme: str = 'contact_angle') → tud_lbm.operators.protocols.HysteresisOperator

Return a wetting operator looked up from the registry.

Parameters:

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.

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)