imod.mf6.regrid.GeneralHeadBoundaryRegridMethod#

class imod.mf6.regrid.GeneralHeadBoundaryRegridMethod(head: Tuple[RegridderType, str] | Tuple[RegridderType] = (RegridderType.OVERLAP, 'mean'), conductance: Tuple[RegridderType, str] | Tuple[RegridderType] = (RegridderType.RELATIVEOVERLAP, 'conductance'), concentration: Tuple[RegridderType, str] | Tuple[RegridderType] = (RegridderType.OVERLAP, 'mean'))[source]#

Object containing regridder methods for the imod.mf6.GeneralHeadBoundary package. This can be provided to the regrid_like method to regrid with custom settings.

Parameters:

head (tuple, default (RegridderType.OVERLAP, "mean"))
conductance (tuple, default (RegridderType.RELATIVEOVERLAP,"conductance"))
concentration (tuple, default (RegridderType.OVERLAP, "mean"))

Examples

Regrid with custom settings:

>>> regrid_method = GeneralHeadBoundaryRegridMethod(head=(RegridderType.BARYCENTRIC,))
>>> ghb.regrid_like(target_grid, RegridderWeightsCache(), regrid_method)

The RegridderType.OVERLAP and RegridderType.RELATIVEOVERLAP require an extra method as string.

>>> regrid_method = GeneralHeadBoundaryRegridMethod(head=(RegridderType.OVERLAP, "max",))

__init__(*args: Any, **kwargs: Any) → None#

Methods

__init__(*args, **kwargs)

Attributes

`concentration`
`conductance`
`head`