imod.mf6.GroundwaterTransportModel#

class imod.mf6.GroundwaterTransportModel(listing_file: str | None = None, print_input: bool = False, print_flows: bool = False, save_flows: bool = False, validate: bool = True)[source]#

The GroundwaterTransportModel (GWT) simulates transport of a single solute species flowing in groundwater. More information can be found here: https://water.usgs.gov/water-resources/software/MODFLOW-6/mf6io_6.4.2.pdf#page=172

Parameters:

  • listing_file (Optional[str] = None) – name of the listing file to create for this GWT model. If not specified, then the name of the list file will be the basename of the GWT model name file and the ‘lst’ extension.

  • print_input (bool = False) – if True, indicates that the list of exchange entries will be echoed to the listing file immediately after it is read.

  • print_flows (bool = False) – if True, indicates that the list of exchange flow rates will be printed to the listing file for every stress period in which “SAVE BUDGET” is specified in Output Control

  • save_flows (bool = False,) – if True, indicates that all model package flow terms will be written to the file specified with “BUDGET FILEOUT” in Output Control.

__init__(listing_file: str | None = None, print_input: bool = False, print_flows: bool = False, save_flows: bool = False, validate: bool = True)[source]#

Methods

__init__([listing_file, print_input, ...])

clear()

clip_box([time_min, time_max, layer_min, ...])

Clip a model by a bounding box (time, layer, y, x).

copy()

dump(directory, modelname[, validate, ...])

Dump simulation to files.

from_file(toml_path)

fromkeys(iterable[, value])

get(k[,d])

get_diskey()

Get discretization key from the model.

has_key(k)

is_use_newton()

Returns whether the Newton-Raphson formulation is used for groundwater flow between connected, convertible groundwater cells.

items()

keys()

mask_all_packages(mask)

This function applies a mask to all packages in a model.

pop(k[,d])

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem()

as a 2-tuple; but raise KeyError if D is empty.

prepare_wel_for_mf6(pkgname[, validate, ...])

Prepare grid-agnostic well for MODFLOW6, using the models grid information and hydraulic conductivities.

purge_empty_packages([model_name, ignore_time])

This method removes empty packages from the model in place.

regrid_like(target_grid[, validate, ...])

Creates a model by regridding the packages of this model to another discretization.

setdefault(k[,d])

update([E, ]**F)

If E present and has a .keys() method, does: for k in E.keys(): D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

validate([model_name, validation_context])

Validate model.

values()

write(modelname, globaltimes, directory[, ...])

Write MODFLOW6 model to file.

Attributes

bottom

domain

model_id

options