imod.mf6.ImmobileStorageTransfer#

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

The Immobile Storage and Transfer (IST) package represents an immobile fraction of groundwater. Any number of IST Packages can be specified for a single GWT model. This allows the user to specify triple porosity systems, or systems with as many immobile domains as necessary.

Parameters:

  • initial_immmobile_concentration (array of floats (xr.DataArray)) – initial concentration of the immobile domain in mass per length cubed (cim).

  • immobile_porosity (array of floats (xr.DataArray)) – porosity of the immobile domain specified as the volume of immobile pore space per total volume (dimensionless) (thetaim).

  • mobile_immobile_mass_transfer_rate (array of floats (xr.DataArray)) – mass transfer rate coefficient between the mobile and immobile domains, in dimensions of per time (zetaim).

  • decay (array of floats (xr.DataArray).) – is the rate coefficient for first or zero-order decay for the aqueous phase of the immobile 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)) – is the rate coefficient for first or zero-order decay for the sorbed phase of the immobile 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)) – is the bulk density of the aquifer in mass per length cubed. bulk_density will have no effect on simulation results unless the SORPTION keyword is specified in the options block.

  • distribution_coefficient (array of floats (xr.DataArray)) – is the distribution coefficient for the equilibrium-controlled linear sorption isotherm in dimensions of length cubed per mass. distcoef will have no effect on simulation results unless the SORPTION keyword is specified in the options block.

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

  • budgetbinfile – name of the binary output file to write budget information.

  • budgetcsvfile – name of the comma-separated value (CSV) output file to write budget summary information. A budget summary record will be written to this file for each time step of the simulation.

  • sorption (({True, False}, optional)) – is a text keyword to indicate that sorption will be activated. Use of this keyword requires that BULK_DENSITY and DISTCOEF are specified in the GRIDDATA block. The linear sorption isotherm is the only isotherm presently supported in the IST Package.

  • first_order_decay (({True, False}, optional)) – is a text keyword to indicate that first-order decay will occur. Use of this keyword requires that DECAY and DECAY_SORBED (if sorption is active) are specified in the GRIDDATA block.

  • zero_order_decay (({True, False}, optional)) – is a text keyword to indicate that zero-order decay will occur. Use of this keyword requires that DECAY and DECAY_SORBED (if sorption is active) are specified in the GRIDDATA block.

  • cimfile ((str)) – name of the output file to write immobile concentrations. This file is a binary file that has the same format and structure as a binary head and concentration file. The value for the text variable written to the file is CIM. Immobile domain concentrations will be written to this file at the same interval as mobile domain concentrations are saved, as specified in the GWT Model Output Control file.

  • columns ((int, optional), default is 10) – number of columns for writing data.

  • width ((int, optional), default is 10) – width for writing each number.

  • digits ((int, optional), default is 7) – number of digits to use for writing a number.

  • format ((str, optional) default exponential) – One of {“exponential”, “fixed”, “general”, “scientific”}.

  • 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__(initial_immobile_concentration, immobile_porosity, mobile_immobile_mass_transfer_rate, decay=None, decay_sorbed=None, bulk_density: DataArray | None = None, distribution_coefficient=None, save_flows: bool | None = None, budgetbinfile: str | None = None, budgetcsvfile: str | None = None, sorption: bool = False, first_order_decay: bool = False, zero_order_decay: bool = False, cimfile: str = 'cim.dat', columns: int = 7, width: int = 10, digits: int = 7, format: str = 'EXPONENTIAL', validate: bool = True)[source]#

Methods

__init__(initial_immobile_concentration, ...)

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