hydromodpy.solver.modflow_common.property_mapping#

Property mapping helpers shared by MODFLOW solver backends (NWT and MF6).

This module translates process-level hydraulic properties carried by Flow/Domain objects into solver-ready arrays on a structured grid.

In practice, this covers the canonical mapping: 1. K -> hk (+ hk_value surface snapshot) 2. Sy -> sy (+ sy_value surface snapshot) 3. Ss -> ss (+ ss_value surface snapshot)

Design goals#

  • Keep mapping logic isolated from solver package assembly.

  • Fail fast on inconsistent contracts (missing parameters/zones).

  • Expose one explicit high-level entry point for canonical K/Sy/Ss mapping.

Functions

resolve_flow_property_arrays(*, flow, ...[, ...])

Resolve canonical K/Sy/Ss arrays for solver consumption.

resolve_required_flow_properties(*, flow_regime)

Return the minimal hydraulic-property set required for one flow regime.