imod.mf6.StorageCoefficient#

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

Storage Package with a storage coefficient. Be careful, this is not the same as the specific storage.

From wikipedia (https://en.wikipedia.org/wiki/Specific_storage):

“Storativity or the storage coefficient is the volume of water released from storage per unit decline in hydraulic head in the aquifer, per unit area of the aquifer. Storativity is a dimensionless quantity, and is always greater than 0.

Under confined conditions:

S = Ss * b, where S is the storage coefficient, Ss the specific storage, and b the aquifer thickness.

Under unconfined conditions:

S = Sy, where Sy is the specific yield”

If the STO Package is not included for a model, then storage changes will not be calculated, and thus, the model will be steady state. Only one STO Package can be specified for a GWF model.

Parameters:

  • storage_coefficient (array of floats (xr.DataArray)) – Is storage coefficient. Storage coefficient values must be greater than or equal to 0. (ss)

  • specific_yield (array of floats (xr.DataArray)) – Is specific yield. Specific yield values must be greater than or equal to 0. Specific yield does not have to be specified if there are no convertible cells (convertible=0 in every cell). (sy)

  • transient (({True, False})) – Boolean to indicate if the model is transient or steady-state.

  • convertible (array of int (xr.DataArray)) – Is a flag for each cell that specifies whether or not a cell is convertible for the storage calculation. 0 indicates confined storage is used. >0 indicates confined storage is used when head is above cell top and a mixed formulation of unconfined and confined storage is used when head is below cell top. (iconvert)

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

  • 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__(storage_coefficient, specific_yield, transient, convertible, save_flows: bool = False, validate: bool = True)[source]#

Methods

__init__(storage_coefficient, ...[, ...])

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

from_imod5_data(imod5_data, target_grid[, ...])

Construct a StorageCoefficient-package from iMOD5 data, loaded with the imod.formats.prj.open_projectfile_data() function.

get_non_grid_data(grid_names)

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

get_options(d)

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, **kwargs)

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