imod.mf6.MobileStorageTransfer#

class imod.mf6.MobileStorageTransfer(*_, **__)[source]#

Mobile Storage.

Parameters:

  • porosity (array of floats (xr.DataArray)) – volume of interconnected voids per volume of rock (percentage).

  • decay (array of floats (xr.DataArray, optional)) – is the rate coefficient for first or zero-order decay for the aqueous phase of the mobile domain. A negative value indicates solute production. The dimensions of decay for first-order decay is one over time. The dimensions of decay for zero-order decay is mass per length cubed per time. decay will have no effect on simulation results unless either first- or zero-order decay is specified in the options block.

  • decay_sorbed (array of floats (xr.DataArray, optional)) – is the rate coefficient for first or zero-order decay for the sorbed phase of the mobile domain. A negative value indicates solute production. The dimensions of decay_sorbed for first-order decay is one over time. The dimensions of decay_sorbed for zero-order decay is mass of solute per mass of aquifer per time. If decay_sorbed is not specified and both decay and sorption are active, then the program will terminate with an error. decay_sorbed will have no effect on simulation results unless the SORPTION keyword and either first- or zero-order decay are specified in the options block.

  • bulk_density (array of floats (xr.DataArray, optional)) – is the bulk density of the aquifer in mass per length cubed. bulk_density is not required unless the SORPTION keyword is specified.

  • distcoef (array of floats (xr.DataArray, optional)) – is the distribution coefficient for the equilibrium-controlled linear sorption isotherm in dimensions of length cubed per mass. distcoef is not required unless the SORPTION keyword is specified.

  • sp2 (array of floats (xr.DataArray, optional)) – is the exponent for the Freundlich isotherm and the sorption capacity for the Langmuir isotherm.

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

  • zero_order_decay (bool, optional) – Requires decay to be specified

  • first_order_decay (bool, optional) – Requires decay to be specified

  • sorption (({linear, freundlich, langmuir}, optional)) – Type of sorption, if any.

  • 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__(porosity, decay=None, decay_sorbed=None, bulk_density=None, distcoef=None, sp2=None, save_flows=False, zero_order_decay: bool = False, first_order_decay: bool = False, sorption=None, validate: bool = True)[source]#

Methods

__init__(porosity[, decay, decay_sorbed, ...])

cleanup(dis)

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_non_grid_data(grid_names)

This function copies the attributes of a dataset that are scalars, such as options.

get_regrid_methods()

is_clipping_supported()

is_empty()

Returns True if the package is empty- for example if it contains only no-data values.

is_grid_agnostic_package()

is_regridding_supported()

is_splitting_supported()

isel()

mask(mask)

Mask values outside of domain.

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

Creates a package of the same type as this package, based on another discretization.

render(directory, pkgname, globaltimes, binary)

sel()

to_netcdf(*args[, mdal_compliant, crs])

Write dataset contents to a netCDF file.

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

Write package to file

write_binary_griddata(outpath, da, dtype)

write_blockfile(pkgname, globaltimes, ...)

write_text_griddata(outpath, da, dtype)

Attributes

auxiliary_data_fields

dataset