imod.mf6.regrid.MobileStorageTransferRegridMethod#

class imod.mf6.regrid.MobileStorageTransferRegridMethod(porosity: Tuple[RegridderType, str] | Tuple[RegridderType] = (RegridderType.OVERLAP, 'mean'), decay: Tuple[RegridderType, str] | Tuple[RegridderType] = (RegridderType.OVERLAP, 'mean'), decay_sorbed: Tuple[RegridderType, str] | Tuple[RegridderType] = (RegridderType.OVERLAP, 'mean'), bulk_density: Tuple[RegridderType, str] | Tuple[RegridderType] = (RegridderType.OVERLAP, 'mean'), distcoef: Tuple[RegridderType, str] | Tuple[RegridderType] = (RegridderType.OVERLAP, 'mean'), sp2: Tuple[RegridderType, str] | Tuple[RegridderType] = (RegridderType.OVERLAP, 'mean'))[source]#

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

Parameters:

porosity (tuple, default (RegridderType.OVERLAP, "mean"))
decay (tuple, default (RegridderType.OVERLAP, "mean"))
decay_sorbed (tuple, default (RegridderType.OVERLAP, "mean"))
bulk_density (tuple, default (RegridderType.OVERLAP, "mean"))
distcoef (tuple, default (RegridderType.OVERLAP, "mean"))
sp2 (tuple, default (RegridderType.OVERLAP, "mean"))

Examples

Regrid with custom settings:

>>> regrid_method = MobileStorageTransferRegridMethod(porosity=(RegridderType.BARYCENTRIC,))
>>> mst.regrid_like(target_grid, RegridderWeightsCache(), regrid_method)

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

>>> regrid_method = MobileStorageTransferRegridMethod(porosity=(RegridderType.OVERLAP, "max",))

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

Methods

__init__(*args, **kwargs)

Attributes

`bulk_density`
`decay`
`decay_sorbed`
`distcoef`
`porosity`
`sp2`