[modflow6] Modflow6Config

TOML section: [modflow6]

Pydantic model: Modflow6Config defined in hydromodpy.solver.modflow6.modflow6_config.

Source on GitHub

Expert-level MODFLOW 6 configuration organized by concern.

Show fields: User User + Dev All

Fields

runtime in TOML: [modflow6.runtime]

Modflow6RuntimeConfig factory expert source

MODFLOW 6 runtime options.

Fields of Modflow6RuntimeConfig

mf6_executable_name

str default = “mf6” expert source

MODFLOW 6 executable name or absolute path.

mf6_ims_complexity

str default = “COMPLEX” expert source

IMS complexity keyword for MODFLOW 6 (e.g. SIMPLE, MODERATE, COMPLEX).

mf_verbose

bool default = False expert source

Enable verbose FloPy logging for MODFLOW 6 setup and execution.

mf6_outer_dvclose

float default = 0.0001 expert source

IMS outer-iteration head-change convergence criterion.

mf6_inner_dvclose

float default = 0.0001 expert source

IMS inner-iteration head-change convergence criterion.

mf6_outer_maximum

int default = 500 expert source

Maximum number of IMS outer iterations.

mf6_inner_maximum

int default = 500 expert source

Maximum number of IMS inner iterations.

mf6_enable_rewet

bool | None default = None expert source

Enable NPF cell rewetting. When left to None, HydroModPy keeps rewetting disabled unless explicitly enabled.

mf6_newton

bool default = False expert source

Enable the MODFLOW 6 Newton-Raphson formulation for convertible groundwater cells.

mf6_newton_under_relaxation

bool default = True expert source

Enable MODFLOW 6 Newton under-relaxation when mf6_newton is true.

mf6_enable_xt3d

bool | None default = None expert source

Enable MF6 NPF XT3D terms. When left to None, HydroModPy auto-enables XT3D on unstructured solver meshes. This increases computational cost but can improve accuracy on unstructured or non-orthogonal grids.

mf6_rewet_wetfct

float default = 0.1 expert source

MF6 NPF rewet WETFCT factor.

mf6_rewet_iwetit

int default = 1 expert source

MF6 NPF rewet IWETIT interval.

mf6_rewet_ihdwet

int default = 0 expert source

MF6 NPF rewet IHDWET flag.

mf6_rewet_wetdry

float default = 0.1 expert source

MF6 NPF WETDRY threshold used when rewetting is active.

process_specific in TOML: [modflow6.process_specific]

Modflow6ProcessSpecificConfig factory expert source

Process-specific controls for MODFLOW 6 flow packages.

Fields of Modflow6ProcessSpecificConfig

vka

float default = 1.0 expert source

Vertical anisotropy factor used to derive k33 from k.

evt_extinction_depth

float default = 1.0 expert source

MF6 EVT extinction depth in meters when recharge negatives are routed to EVT.

sgrid in TOML: [modflow6.sgrid]

SolverSGridConfig factory user source

Solver-grid payload split into planar and vertical sections.

Fields of SolverSGridConfig

planar in TOML: [modflow6.sgrid.planar]

PlanarGridConfig factory user source

Planar discretization of the solver grid.

Fields of PlanarGridConfig

mode

Literal[‘keep_native’, ‘resample_to_shape’] default = “keep_native” user source

Planar solver-grid mode: keep the native domain support or resample to an explicit (ny, nx) target shape.

nx

Optional[int] default = None user source

Target number of columns when planar mode is ‘resample_to_shape’.

ny

Optional[int] default = None user source

Target number of rows when planar mode is ‘resample_to_shape’.

resampling

Literal[‘bilinear’, ‘average’, ‘nearest’] default = “bilinear” dev source

Resampling rule applied when planar mode is ‘resample_to_shape’.

vertical in TOML: [modflow6.sgrid.vertical]

VerticalGridConfig factory user source

Vertical layering of the solver grid.

Fields of VerticalGridConfig

genmtd_lay

Literal[‘constant’, ‘decay’, ‘list’] default = “constant” user source

Vertical-layering strategy.

nlay

int | None default = 1 user source

Number of layers (required for constant/decay, ignored for list).

lay_decay

float | None default = None dev source

Decay exponent (>1) for decay layering.

lay_proportions

list[float] | None default = None dev source

Explicit layer fractions when genmtd_lay=’list’ (must sum to 1).

nodata

float default = -9999.0 dev source

No-data sentinel value.

tgrid in TOML: [modflow6.tgrid]

TMeshConfig | None default = None user source

Optional temporal discretization payload as TMeshConfig. In launcher mode, stress periods are driven by [simulation.time]; steady/transient policy is driven by [flow].flow_regime and [flow].first_period_steady.

Fields of TMeshConfig

itmuni

str default = “d” dev source

Time unit used to interpret lenper values. In launcher mode stress periods come from [simulation.time], so this field is mirrored only for compatibility.

genmtd

Literal[‘synthetic_regular’, ‘from_chron’] default = “synthetic_regular” user source

Temporal generation method. In launcher mode stress periods come from [simulation.time], so this field is mirrored only for compatibility.

nper

int default = 1 user source

Stress-period count. In launcher mode this is mirrored from [simulation.time] and is not the authoritative source.

lenper

float | int | list[int] | list[float] | None default = 1 user source

Stress-period length(s) interpreted with itmuni. Scalar means one regular step length repeated nper times; list means one explicit value per stress period. In launcher mode this is mirrored from [simulation.time] and is not the authoritative source.

chron_path

str | None default = None user source

Chronicle file path used when genmtd=’from_chron’. In launcher mode this field is generally not used.

chron_dateformat

str default = “%Y-%m-%d %H:%M:%S” dev source

Date format string used to parse the chronicle file.

chron_colsep

str default = “ “ dev source

Column separator used in the chronicle file.

chron_time_col

str default = “Date” dev source

Name of the time/date column in the chronicle file.

start_datetime

Any | None default = None user source

Lower datetime bound used by the temporal mesh. In launcher mode this field is mirrored from [simulation.time] and is not the authoritative source.

end_datetime

Any | None default = None user source

Upper datetime bound used by the temporal mesh. In launcher mode this field is mirrored from [simulation.time] and is not the authoritative source.

tsmult

int | float | list[int] | list[float] default = 1 dev source

Time-step multiplier per stress period (scalar or list). In launcher mode this field is currently forced to 1.0 and generally not intended for manual editing.

ntsp

int | list[int] default = 1 dev source

Number of time steps per stress period (scalar or list). In launcher mode this field is currently forced to 1 and generally not intended for manual editing.

temporal_nodata

float default = -9999.0 dev source

No-data sentinel value for temporal data.

Starter TOML snippet

Click to expand a copy-pasteable [modflow6] 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.

[modflow6]

[modflow6.sgrid]
# planar = ...  # factory default
# vertical = ...  # factory default

[modflow6.tgrid]
# genmtd = "synthetic_regular"
# nper = 1
# lenper = 1
# chron_path = ...  # default = None
# start_datetime = ...  # default = None
# end_datetime = ...  # default = None

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.