imod.mf6.SpecificStorage#

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

Storage Package with specific storage.

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

“The specific storage is the amount of water that a portion of an aquifer releases from storage, per unit mass or volume of aquifer, per unit change in hydraulic head, while remaining fully saturated.”

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:

  • specific_storage (array of floats (xr.DataArray)) – Is specific storage. Specific storage 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}), or a DataArray with a time coordinate and dtype Bool) – 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__(specific_storage, specific_yield, transient, convertible, save_flows: bool = False, validate: bool = True)[source]#

Methods

__init__(specific_storage, specific_yield, ...)

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_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[, 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