imod.mf6.regrid.DiscretizationRegridMethod

class imod.mf6.regrid.DiscretizationRegridMethod(top: Tuple[RegridderType, str] | Tuple[RegridderType] = (RegridderType.OVERLAP, 'mean'), bottom: Tuple[RegridderType, str] | Tuple[RegridderType] = (RegridderType.OVERLAP, 'mean'), idomain: Tuple[RegridderType, str] | Tuple[RegridderType] = (RegridderType.OVERLAP, 'mode'))

Object containing regridder methods for the imod.mf6.StructuredDiscretization and imod.mf6.VerticesDiscretization packages. This can be provided to the regrid_like method to regrid with custom settings.

Parameters:

• top (tuple, default (RegridderType.OVERLAP, "mean"))

• bottom (tuple, default (RegridderType.OVERLAP, "mean"))

• idomain (tuple, default (RegridderType.OVERLAP, "mode"))

Examples

Regrid with custom settings:

>>> regrid_method = DiscretizationRegridMethod(top=(RegridderType.BARYCENTRIC,))
>>> dis.regrid_like(target_grid, RegridderWeightsCache(), regrid_method)

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

>>> regrid_method = DiscretizationRegridMethod(top=(RegridderType.OVERLAP, "max",))

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

Methods

__init__(*args, **kwargs)

Attributes

bottom
idomain
top