hydromodpy.solver.boussinesq

Pedagogical entry points for the standalone Boussinesq backend.

Importing from this package gives access to the three public objects that matter most to callers:

• Boussinesq, the high-level solver driver;

• BoussinesqMesh, the compact mesh view consumed by the solver;

• BoussinesqState, the normalized in-memory flow state.

The detailed implementation is intentionally split across several modules:

• mesh.py: geometry and material properties;

• assembly/: residual assembly and boundary-flux reconstruction;

• jacobian/: finite-difference and semianalytic Jacobian builders;

• drivers/: steady/transient orchestration helpers;

• core/, discretization/, formulations/, methods/ and engines/: explicit taxonomy for state, schemes, formulations and execution engines;

• runtimes/: shared runtime utilities and supported execution backends;

• boussinesq.py: orchestration around the HydroModPy launcher contract.

Modules

adapters	Simulation-runner adapters for the Boussinesq backend.
assembly	Finite-volume assembly helpers shared by all current Boussinesq runtimes.
boussinesq	High-level driver for the standalone Boussinesq flow backend.
calibration_extractors	Lightweight readers for Boussinesq calibration trials.
core	Core solver-owned state objects for the Boussinesq package.
discretization	Explicit discretization descriptors for the Boussinesq solver.
drivers	Runtime orchestration helpers for steady and transient Boussinesq solves.
engines	Execution-engine descriptors for the Boussinesq solver.
export_payload	Export helpers for the Boussinesq solver.
extractors	Boussinesq output adapters: solver files → SimulationCatalog.
flow_to_boussinesq_adapter	Helpers for the BoussinesqFlowAdapter.
forcing	Specialized forcing-resolution mixins for the Boussinesq solver.
forcing_resolution	Forcing and boundary-resolution helpers for the Boussinesq solver.
formulations	Explicit algebraic formulations available in the Boussinesq solver.
jacobian	Jacobian builders and sparse operator helpers for the Boussinesq solver.
mesh	Solver-owned mesh view for the gmsh catchment bundle contract.
methods	Method catalog for the Boussinesq solver.
property_mapping	Hydraulic-property mapping helpers for the planar Boussinesq backend.
runtime_contract	Common runtime contracts for Boussinesq nonlinear solvers.
runtime_selection	Runtime-backend selection for the Boussinesq solver.
runtime_summary	Helpers that keep Boussinesq runtime summary bookkeeping out of the driver.
runtimes	Execution backends and shared runtime utilities for the Boussinesq solver.
smoothing	Smooth C¹ approximations of the piecewise operators used in Boussinesq.
solver_contract	Process-to-runtime contract helpers for the Boussinesq solver.