imod.mf6.HorizontalFlowBarrierMultiplier#

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

If parts of the barrier overlap a layer the multiplier is applied to the entire layer.

Parameters:

  • geometry (gpd.GeoDataFrame) –

    Dataframe that describes:

    • geometry: the geometries of the barriers,

    • multiplier: the multiplier of the barriers

    • ztop: the top z-value of the barriers

    • zbottom: the bottom z-value of the barriers

  • 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,],
>>>         "ztop": [10.0,],
>>>         "zbottom": [0.0,],
>>>     },
>>> )
>>> hfb = imod.mf6.HorizontalFlowBarrierMultiplier(barrier_gdf)
__init__(geometry: GeoDataFrame, print_input=False)[source]#

Methods

__init__(geometry[, print_input])

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

get_regrid_methods()

is_grid_agnostic_package()

is_regridding_supported()

returns true if package supports regridding.

isel()

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

The regrid_like method is irrelevant for this package as it is grid-agnostic, instead this method clips the package based on the grid exterior.

render(directory, pkgname, globaltimes, binary)

Render fills in the template only, doesn't write binary data

sel()

skip_masking_dataarray(array_name)

to_mf6_pkg(idomain, top, bottom, k)

Write package to Modflow 6 package.

to_netcdf(*args, **kwargs)

Write dataset contents to a netCDF file.

write(pkgname, globaltimes, write_context)

writes the blockfile and binary data

write_binary_griddata(outpath, da, dtype)

write_blockfile(pkgname, globaltimes, ...)

write_text_griddata(outpath, da, dtype)

Attributes

dataset

geometry