[transport] TransportConfig

TOML section: [transport]

Pydantic model: TransportConfig defined in hydromodpy.physics.transport.transport_config.

Source on GitHub

Transport-process configuration.

Show fields: User User + Dev All

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.

cell_div

int default = 1 dev source

Number of particles per axis in each cell.

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.

sel_slice

int | None default = None dev source

Optional slicing step for 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

spc_name

str default = “NO3” dev source

Name of transported species.

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).

disp_long

float default = 0.0 dev source

Longitudinal dispersivity [L].

disp_transh

float default = 0.0 dev source

Horizontal transverse dispersivity ratio.

disp_transv

float default = 0.0 dev source

Vertical transverse dispersivity ratio.

diffu_coeff

float default = 0.0 dev source

Molecular diffusion coefficient [L2/T].

react_order

int | None default = None dev source

Reaction order for MT3DMS: None, 0, or 1.

rate_decay

float default = 0.0 dev source

Decay rate value (can be overridden at runtime).

plot_conc

bool default = True dev source

Enable concentration plotting outputs.

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

spc_name

str default = “NO3” dev source

Name of transported species.

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).

disp_long

float default = 0.0 dev source

Longitudinal dispersivity [L].

disp_transh

float default = 0.0 dev source

Horizontal transverse dispersivity ratio.

disp_transv

float default = 0.0 dev source

Vertical transverse dispersivity ratio.

diffu_coeff

float default = 0.0 dev source

Molecular diffusion coefficient [L2/T].

react_order

int | None default = None dev source

Reaction order for MT3DMS: None, 0, or 1.

rate_decay

float default = 0.0 dev source

Decay rate value (can be overridden at runtime).

plot_conc

bool default = True dev source

Enable concentration plotting outputs.

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

Optional uniform particle-tracking porosity. When omitted, the flow model specific yield is used where positive.

local_z

float default = 0.5 dev source

Local vertical release coordinate within the cell.

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 model time units. Existing MODFLOW 6 models in HydroModPy use days.

track_times_days

list[float] | None default = None dev source

Optional user tracking output times in model time units.

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_time_days

float | None default = None dev source

Optional absolute particle stop time in model time units.

stop_travel_time_days

float | None default = None dev source

Optional maximum particle travel time in model time units.

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-10 dev source

PRT generalized Pollock exit solve tolerance.

write_track_csv

bool default = True dev source

Write the PRT track CSV file used by the HydroModPy extractor.

write_track_binary

bool default = True dev source

Write the binary PRT track file.

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.