imod.mf6.ConstantHead#

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

Constant-Head package. Any number of CHD Packages can be specified for a single groundwater flow model; however, an error will occur if a CHD Package attempts to make a GWF cell a constant-head cell when that cell has already been designated as a constant-head cell either within the present CHD Package or within another CHD Package. In previous MODFLOW versions, it was not possible to convert a constant-head cell to an active cell. Once a cell was designated as a constant-head cell, it remained a constant-head cell until the end of the end of the simulation. In MODFLOW 6 a constant-head cell will become active again if it is not included as a constant-head cell in subsequent stress periods. Previous MODFLOW versions allowed specification of SHEAD and EHEAD, which were the starting and ending prescribed heads for a stress period. Linear interpolation was used to calculate a value for each time step. In MODFLOW 6 only a single head value can be specified for any constant-head cell in any stress period. The time-series functionality must be used in order to interpolate values to individual time steps.

Parameters:

  • head (array of floats (xr.DataArray)) – Is the head at the boundary.

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

  • 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_flows (({True, False}, optional)) – Indicates that the list of constant head 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 constant head 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.

  • repeat_stress (Optional[xr.DataArray] of datetimes) – Used to repeat data for e.g. repeating stress periods such as seasonality without duplicating the values. The DataArray should have dimensions ("repeat", "repeat_items"). The repeat_items dimension should have size 2: the first value is the “key”, the second value is the “value”. For the “key” datetime, the data of the “value” datetime will be used. Can also be set with a dictionary using the set_repeat_stress method.

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

Methods

__init__(head[, 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).

from_imod5_data(key, imod5_data, target_dis)

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

from_imod5_shd_data(imod5_data, target_dis)

Construct a ConstantHead-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_period_varnames()

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)

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