imod.mf6.HorizontalFlowBarrierHydraulicCharacteristic#

class imod.mf6.HorizontalFlowBarrierHydraulicCharacteristic(hydraulic_characteristic, idomain, print_input=False, validate: bool = True)[source]#

Horizontal Flow Barrier (HFB) package

Input to the Horizontal Flow Barrier (HFB) Package is read from the file that has type “HFB6” in the Name File. Only one HFB Package can be specified for a GWF model. https://water.usgs.gov/water-resources/software/MODFLOW-6/mf6io_6.2.2.pdf

We recommend using either the HorizontalFlowBarrierResistance or HorizontalFlowBarrierMultiplier over this class.

Parameters:

  • hydraulic_characteristic (xugrid.UgridDataArray) – hydraulic characteristic of the barrier: the inverse of the hydraulic resistance. Negative values are interpreted as a multiplier of the cell to cell conductance.

  • idomain (xugrid.UgridDataArray or xr.DataArray) –

Examples

The easiest way to create a horizontal flow barrier is by using xugrid.snap_to_grid, which snaps to the line geometry of a geopandas.GeoDataFrame to a xugrid.Ugrid2d topology. Note that a layer coordinate is required.

>> snapped, snapped_gdf = xugrid.snap_to_grid(gdf, grid=idomain) >> characteristic = snapped[“characteristic”].assign_coords(layer=1) >> hfb = imod.mf6.HorizontalFlowBarrier(characteristic, idomain=idomain)

__init__(hydraulic_characteristic, idomain, print_input=False, validate: bool = True)[source]#

Methods

__init__(hydraulic_characteristic, idomain)

add_periodic_auxiliary_variable()

assign_dims(arg)

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_auxiliary_variable_names()

get_options(d[, not_options])

isel()

mask(domain)

Mask values outside of domain.

period_data()

period_paths(directory, pkgname, ...)

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_sparse(arrdict, layer)

Convert from dense arrays to list based input

write(directory, pkgname, globaltimes, binary)

writes the blockfile and binary data

write_binary_griddata(outpath, da, dtype)

write_blockfile(directory, pkgname, ...)

write_datafile(outpath, ds, binary)

Writes a modflow6 binary data file

write_netcdf(directory, pkgname[, ...])

Write to netcdf.

write_perioddata(directory, pkgname, binary)

write_text_griddata(outpath, da, dtype)