imod.mf6.SingleLayerHorizontalFlowBarrierMultiplier#

class imod.mf6.SingleLayerHorizontalFlowBarrierMultiplier(*_, **__)[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

Parameters:

  • geometry (gpd.GeoDataFrame) –

    Dataframe that describes:

    • geometry: the geometries of the barriers,

    • multiplier: the multiplier of the barriers

    • layer: model layer for the barrier, only 1 single layer can be entered.

  • print_input (bool)

Examples

>>> barrier_x = [-1000.0, 0.0, 1000.0]
>>> barrier_y = [500.0, 250.0, 500.0]
>>> barrier_gdf = gpd.GeoDataFrame(
>>>     geometry=[shapely.linestrings(barrier_x, barrier_y),],
>>>     data={
>>>         "multiplier": [1.5,],
>>>         "layer": [1,],
>>>     },
>>> )
>>> hfb = imod.mf6.SingleLayerHorizontalFlowBarrierMultiplier(barrier_gdf)
__init__(geometry: GeoDataFrame, print_input=False)[source]#

Methods

__init__(geometry[, print_input])

cleanup(dis)

Cleanup the package inplace by removing barriers that fall outside of the active model domain.

clip_box([time_min, time_max, layer_min, ...])

Clip a barrier by a bounding box (y, x).

copy()

Copy package into a new package of the same type.

from_file(path, **kwargs)

Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).

get_regrid_methods()

Returns the default regrid methods for this package.

is_empty([ignore_time])

Returns True if the package is empty, that is if it contains only no-data values.

mask(_)

The mask method is irrelevant for this package as it is grid-agnostic, instead this method retuns a copy of itself.

regrid_like(target_grid, regrid_cache[, ...])

Creates a package of the same type as this package, based on another discretization.

snap_to_grid(dis)

Snap the barriers to the grid edges of the discretization.

to_mf6_pkg(idomain, top, bottom, k[, ...])

Write package to Modflow 6 package.

to_netcdf(*args[, mdal_compliant, crs])

Write dataset contents to a netCDF file.

write(pkgname, globaltimes, directory[, ...])

Write package to file

Attributes

auxiliary_data_fields

dataset

line_data