[transport] TransportConfig#
TOML section: [transport]
Pydantic model: TransportConfig defined in hydromodpy.physics.transport.transport_config.
Transport-process configuration.
Fields#
active_sinks_sources
list[str] factory user source
Ordered list of sink/source identifiers that are explicitly activated for this process. An empty list means no sink/source is active. Concrete process configs (e.g. FlowConfig) validate the allowed values.
active_bc
list[str] factory user source
Ordered list of boundary-condition identifiers that are explicitly activated for this process. An empty list means no boundary-condition package is assembled. Concrete process configs (e.g. FlowConfig) validate the allowed values.
modpath
in TOML:
[transport.modpath]
TransportModpathConfig factory user source
Modpath solver configuration block.
Fields of TransportModpathConfig
parameters
in TOML:
[transport.modpath.parameters]
ModpathParametersConfig factory user source
Solver parameter block used by Modpath.
Fields of ModpathParametersConfig
zone_partic
str default = “domain” dev source
Particle injection zone selector: ‘domain’, ‘seepage_clip’, or a raster path.
track_dir
Literal[‘forward’, ‘backward’, ‘custom’] default = “forward” dev source
Particle tracking direction.
bore_depth
list[float] | None default = None dev source
Optional bore depth list used for vertical particle injection.
zloc_div
bool default = False dev source
If true, apply vertical subdivision for particle injection.
sel_random
int | None default = None dev source
Optional random downsampling count of injected particles.
mt3dms
in TOML:
[transport.mt3dms]
TransportMt3dmsConfig factory user source
MT3DMS solver configuration block.
Fields of TransportMt3dmsConfig
parameters
in TOML:
[transport.mt3dms.parameters]
ConcentrationTransportParametersConfig factory user source
Solver parameter block used by Mt3dms.
Fields of ConcentrationTransportParametersConfig
sconc_init
float default = 0.0 dev source
Initial concentration value (can be overridden at runtime).
sconc_input
float default = 0.0 dev source
Recharge concentration input value (can be overridden at runtime).
diffu_coeff
float default = 0.0 dev source
Molecular diffusion coefficient in m2/s. The MODFLOW 6 GWT backend runs on the SI SECONDS clock, so this value is consumed per second (a per-day value is ~86400x too large).
react_order
Literal[None, 0, 1] default = None dev source
Reaction order for MODFLOW 6 GWT and MT3DMS: None (no decay), 0 (zero-order, constant rate in mass per volume per second), or 1 (first-order, proportional to concentration, in 1/s). Rates are on the SI SECONDS clock used by the GWT backend.
scheme
Literal[‘upstream’, ‘central’, ‘TVD’] default = “upstream” dev source
Advection scheme for MODFLOW 6 GWT. upstream: robust but diffusive (default). central: least diffusive, may oscillate. TVD: accurate sharp fronts (Ogata-Banks).
rate_decay
float default = 0.0 dev source
Decay rate on the SI SECONDS clock used by the MODFLOW 6 GWT backend: 1/s for first-order (react_order=1), mass per volume per second for zero-order (react_order=0). A per-day value is ~86400x too large and annihilates the solute. Can be overridden at runtime.
porosity
float | None default = None dev source
Effective (total) porosity [-], the dimensionless volume of interconnected pores per bulk volume. Drives MST pore volume and pore velocity. When omitted, the flow model specific yield is used, which underestimates pore volume and biases transit times low.
modflow6gwt
in TOML:
[transport.modflow6gwt]
TransportModflow6GwtConfig factory user source
MODFLOW 6 GWT solver configuration block.
Fields of TransportModflow6GwtConfig
parameters
in TOML:
[transport.modflow6gwt.parameters]
ConcentrationTransportParametersConfig factory user source
Solver parameter block used by Modflow6Transport.
Fields of ConcentrationTransportParametersConfig
sconc_init
float default = 0.0 dev source
Initial concentration value (can be overridden at runtime).
sconc_input
float default = 0.0 dev source
Recharge concentration input value (can be overridden at runtime).
diffu_coeff
float default = 0.0 dev source
Molecular diffusion coefficient in m2/s. The MODFLOW 6 GWT backend runs on the SI SECONDS clock, so this value is consumed per second (a per-day value is ~86400x too large).
react_order
Literal[None, 0, 1] default = None dev source
Reaction order for MODFLOW 6 GWT and MT3DMS: None (no decay), 0 (zero-order, constant rate in mass per volume per second), or 1 (first-order, proportional to concentration, in 1/s). Rates are on the SI SECONDS clock used by the GWT backend.
scheme
Literal[‘upstream’, ‘central’, ‘TVD’] default = “upstream” dev source
Advection scheme for MODFLOW 6 GWT. upstream: robust but diffusive (default). central: least diffusive, may oscillate. TVD: accurate sharp fronts (Ogata-Banks).
rate_decay
float default = 0.0 dev source
Decay rate on the SI SECONDS clock used by the MODFLOW 6 GWT backend: 1/s for first-order (react_order=1), mass per volume per second for zero-order (react_order=0). A per-day value is ~86400x too large and annihilates the solute. Can be overridden at runtime.
porosity
float | None default = None dev source
Effective (total) porosity [-], the dimensionless volume of interconnected pores per bulk volume. Drives MST pore volume and pore velocity. When omitted, the flow model specific yield is used, which underestimates pore volume and biases transit times low.
modflow6prt
in TOML:
[transport.modflow6prt]
TransportModflow6PrtConfig factory user source
MODFLOW 6 PRT particle-tracking solver configuration block.
Fields of TransportModflow6PrtConfig
parameters
in TOML:
[transport.modflow6prt.parameters]
Modflow6PrtParametersConfig factory user source
Solver parameter block used by Modflow6Prt.
Fields of Modflow6PrtParametersConfig
release_zone
str default = “domain” dev source
Particle release selector: ‘domain’, ‘domain_nonriver’, ‘upstream’, ‘upstream_nonriver’, ‘river’, ‘outlet’, or ‘custom’.
upstream_top_quantile
float default = 0.9 dev source
Top-elevation quantile used by upstream release zones. A value of 0.90 selects cells in the highest 10 percent of active cell-top elevations.
outlet_bottom_quantile
float default = 0.1 dev source
Bottom-elevation quantile used by the ‘outlet’ release zone. A value of 0.10 selects cells in the lowest 10 percent of active cell-top elevations.
track_dir
Literal[‘forward’] default = “forward” dev source
Particle tracking direction. MF6 PRT support is currently forward only.
porosity
float | None default = None dev source
Effective (total) porosity [-] for particle tracking (v = q / porosity). When omitted, the flow model specific yield is used where positive, with a warning, since specific yield underestimates pore volume.
particle_cell_ids
list[int] | None default = None dev source
Optional zero-based DISV cell2d ids for explicit particle release. Used when release_zone is ‘custom’.
max_particles
int | None default = None dev source
Optional maximum number of release cells after zone selection.
sel_slice
int | None default = None dev source
Optional deterministic slicing step for selected release cells.
release_times_days
list[float] | None default = None dev source
Optional particle release times in days.
track_times_days
list[float] | None default = None dev source
Optional user tracking output times in days.
track_time_step_days
float | None default = None dev source
Optional regular spacing, in days, for generated PRT tracking output times. Used only when track_times_days is omitted.
stop_travel_time_days
float | None default = None dev source
Optional maximum particle travel time in days.
extend_tracking
bool default = True dev source
Track particles beyond the final flow time step when MF6 permits it.
dry_tracking_method
Literal[‘drop’, ‘stop’, ‘stay’] default = “drop” dev source
MF6 PRT behavior for dry-but-active cells.
exit_solve_tolerance
float default = 1e-05 dev source
PRT generalized Pollock exit solve tolerance. Matches the MF6 prt-prp.dfn default (1e-5), which works well for many problems.
write_track_csv
bool default = True dev source
Write the PRT track CSV file used by the HydroModPy extractor.
Starter TOML snippet#
Click to expand a copy-pasteable [transport] 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.
[transport]
# active_sinks_sources = ... # uses factory default
# active_bc = ... # uses factory default
[transport.modpath]
# parameters = ... # factory default
[transport.mt3dms]
# parameters = ... # factory default
[transport.modflow6gwt]
# parameters = ... # factory default
[transport.modflow6prt]
# parameters = ... # factory default
Entity-relationship diagram#
Click to zoom and pan. Press Esc or click outside to close.