[domain] DomainConfig

TOML section: [domain]

Pydantic model: DomainConfig defined in hydromodpy.spatial.domain.domain_config.

Source on GitHub

Domain configuration.

Controls which zone providers are loaded in Domain.

Show fields: User User + Dev All

Fields

zone_ids

list[str] factory user source

Ordered list of zone identifiers loaded in the domain registry. Keep this list for actual runtime zones (for example ‘catchment’, ‘geology’, or custom zonations). Spatial-support declarations live under domain.supports.

supports in TOML: [domain.supports.<id>]

dict[str, GeneratedBandsSupportConfig | GeneratedRingsSupportConfig | CatchmentZonesSupportConfig | GeologySupportConfig] factory user source

Named spatial supports available to heterogeneous parameters. Each key is a support identifier referenced by field_spatial_id.

Fields of GeneratedBandsSupportConfig

kind

Literal[‘generated_bands’] required user source

axis

Literal[‘x’, ‘y’] default = “x” user source

coordinate_mode

Literal[‘relative’, ‘absolute’] default = “relative” dev source

breaks

list[float | str] factory user source

Ordered break coordinates delimiting consecutive bands. With coordinate_mode=’relative’, values are fractions in ]0,1[. With coordinate_mode=’absolute’, values are converted to metres.

labels

list[str] factory user source

Ordered band labels. Length must be len(breaks)+1.

default_cell_samples_per_axis

int default = 8 dev source

Sub-sampling resolution per cell axis used when rasterizing band masks.

Fields of GeneratedRingsSupportConfig

kind

Literal[‘generated_rings’] required user source

coordinate_mode

Literal[‘relative’, ‘absolute’] default = “relative” dev source

radii

list[float | str] factory user source

Ordered ring radii delimiting consecutive concentric zones. With coordinate_mode=’relative’, values are fractions in ]0,1[ of the largest inscribed circle around the chosen center. With coordinate_mode=’absolute’, values are converted to metres.

labels

list[str] factory user source

Ordered ring labels. Length must be len(radii)+1.

center_x

Optional[float] default = None dev source

Optional x coordinate of the ring center (projected metres). Defaults to the domain midpoint. Accepts inline units, e.g. ‘500 m’.

center_y

Optional[float] default = None dev source

Optional y coordinate of the ring center (projected metres). Defaults to the domain midpoint. Accepts inline units.

default_cell_samples_per_axis

int default = 8 dev source

Sub-sampling resolution per cell axis used when rasterizing ring masks.

Fields of CatchmentZonesSupportConfig

kind

Literal[‘catchment_zones’] required user source

source_zone_id

str default = “catchment” user source

Domain zone id providing the source catchment zonation.

default_cell_samples_per_axis

int default = 8 dev source

Sub-sampling resolution per cell axis used when rasterizing zone masks.

Fields of GeologySupportConfig

kind

Literal[‘geology’] required user source

depth_model in TOML: [domain.depth_model]

kind = “constant_thickness” | “flat_substratum” factory user source

Vertical domain model configuration. Use ‘constant_thickness’ or ‘flat_substratum’.

Pick a tab below: setting kind selects the matching schema.

constant_thickness

TOML: [domain.depth_model.constant_thickness] – model ConstantThicknessDepthModel (set kind = "constant_thickness").

thickness

float default = 50.0 user source

Constant aquifer thickness applied below topography (canonical metres). Accepts inline units, e.g. ‘0.2 km’.

flat_substratum

TOML: [domain.depth_model.flat_substratum] – model FlatSubstratumDepthModel (set kind = "flat_substratum").

substratum_elevation

float default = 0.0 user source

Flat substratum elevation (m) applied over the full domain.

Starter TOML snippet

Click to expand a copy-pasteable [domain] TOML skeleton

Copy this block into your project.toml and uncomment the lines you want to set. Sub-tables ([parent.subfield]) appear in the order Pydantic expects them.

[domain]
# zone_ids = ...  # uses factory default
# [domain.supports.<id>]

[domain.depth_model]
# kind = "constant_thickness"
# thickness = 50.0

Cases using this section

Validation gallery cases that reference fields from this section:

• Boussinesq Circular-Island Piecewise-K 2D

• Boussinesq Divide-Fixed-Head Piecewise-K 1D

• Boussinesq Fixed-Head Piecewise-K 1D

• Boussinesq Sloping-Substratum Constant-Thickness 1D

• Boussinesq Sloping-Substratum Fixed-Head 1D

• Boussinesq Sloping-Substratum Uniform-Recharge 1D

• Boussinesq Uniform-Recharge Piecewise-K 1D

• Brutsaert Recession Validation: Thin Nonlinear Aquifer

• Brutsaert Recession Validation: Deep Linearized Aquifer

• Dupuit Circular-Island Ocean 2D

• Dupuit Divide-River 1D

• Dupuit Fixed-Head 1D

• Dupuit Uniform Recharge 1D

• Late-Time Unconfined Pumping 2D

• Linearized Unconfined Boundary Piecewise 1D

• Linearized Unconfined 1D Boundary Step

• Linearized Unconfined Drainage 1D

• Linearized Unconfined Hillslope Drainage 1D

• Linearized Unconfined 1D Periodic Recharge

• Linearized Unconfined 1D Recharge Step

• Linearized Unconfined 1D Recharge Step (Deep Aquifer)

Entity-relationship diagram

Click to zoom and pan. Press Esc or click outside to close.