imod.mf6.WellDisVertices#

class imod.mf6.WellDisVertices(layer, cell2d, rate, concentration=None, concentration_boundary_type='aux', print_input=False, print_flows=False, save_flows=False, observations=None, validate: bool = True)[source]#

WEL package for discretization by vertices (DISV) models. Any number of WEL Packages can be specified for a single groundwater flow model. https://water.usgs.gov/water-resources/software/MODFLOW-6/mf6io_6.0.4.pdf#page=63

Parameters:

  • layer (list of int) – Modellayer in which the well is located.

  • cell2d (list of int) – Cell in which the well is located.

  • rate (float or list of floats) – is the volumetric well rate. A positive value indicates well (injection) and a negative value indicates discharge (extraction) (q).

  • concentration (array of floats (xr.DataArray, optional)) – if this flow package is used in simulations also involving transport, then this array is used as the concentration for inflow over this boundary.

  • concentration_boundary_type (({"AUX", "AUXMIXED"}, optional)) – if this flow package is used in simulations also involving transport, then this keyword specifies how outflow over this boundary is computed.

  • print_input (({True, False}, optional)) – keyword to indicate that the list of well information will be written to the listing file immediately after it is read. Default is False.

  • print_flows (({True, False}, optional)) – Indicates that the list of well flow rates will be printed to the listing file for every stress period time step in which “BUDGET PRINT” is specified in Output Control. If there is no Output Control option and PRINT FLOWS is specified, then flow rates are printed for the last time step of each stress period. Default is False.

  • save_flows (({True, False}, optional)) – Indicates that well flow terms will be written to the file specified with “BUDGET FILEOUT” in Output Control. Default is False.

  • observations ([Not yet supported.]) – Default is None.

  • validate ({True, False}) – Flag to indicate whether the package should be validated upon initialization. This raises a ValidationError if package input is provided in the wrong manner. Defaults to True.

__init__(layer, cell2d, rate, concentration=None, concentration_boundary_type='aux', print_input=False, print_flows=False, save_flows=False, observations=None, validate: bool = True)[source]#

Methods

__init__(layer, cell2d, rate[, ...])

add_periodic_auxiliary_variable()

assign_dims(arg)

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

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

copy()

from_file(path, **kwargs)

Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).

get_auxiliary_variable_names()

get_options(d[, not_options])

isel()

mask(domain)

Mask values outside of domain.

period_data()

period_paths(directory, pkgname, ...)

render(directory, pkgname, globaltimes, binary)

Render fills in the template only, doesn't write binary data

sel()

set_repeat_stress(times)

Set repeat stresses: re-use data of earlier periods.

to_sparse(arrdict, layer)

Convert from dense arrays to list based input

write(directory, pkgname, globaltimes, binary)

writes the blockfile and binary data

write_binary_griddata(outpath, da, dtype)

write_blockfile(directory, pkgname, ...)

write_datafile(outpath, ds, binary)

Writes a modflow6 binary data file

write_netcdf(directory, pkgname[, ...])

Write to netcdf.

write_perioddata(directory, pkgname, binary)

write_text_griddata(outpath, da, dtype)