imod.mf6.ApiPackage.get_regrid_methods

classmethod ApiPackage.get_regrid_methods() → DataclassType

Returns the default regrid methods for this package. You can use modify to customize the regridding of the package.

Returns:

The regrid methods for this package, which is a dataclass with attributes that are tuples of (regridder type, method name). If no regrid methods are defined, returns an instance of EmptyRegridMethod.

Return type:

DataclassType

Examples

Get the regrid methods for the Drainage package:

>>> regrid_settings = Drainage.get_regrid_methods()

You can modify the regrid methods by changing the attributes of the returned dataclass instance. For example, to set the regridding method for elevation to minimum.

>>> regrid_settings.elevation = (imod.RegridderType.OVERLAP, "min")

These settings can then be used to regrid the package:

>>> drain.regrid_like(like, regridder_types=regrid_settings)