imod.mf6.regrid.SpecificStorageRegridMethod#

class imod.mf6.regrid.SpecificStorageRegridMethod(convertible: Tuple[RegridderType, str] | Tuple[RegridderType] = (RegridderType.OVERLAP, 'mode'), specific_storage: Tuple[RegridderType, str] | Tuple[RegridderType] = (RegridderType.OVERLAP, 'mean'), specific_yield: Tuple[RegridderType, str] | Tuple[RegridderType] = (RegridderType.OVERLAP, 'mean'))[source]#

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

Parameters:

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

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

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

Examples

Regrid with custom settings:

>>> regrid_method = SpecificStorageRegridMethod(specific_storage=(RegridderType.BARYCENTRIC,))
>>> sto.regrid_like(target_grid, RegridderWeightsCache(), regrid_method)

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

>>> regrid_method = SpecificStorageRegridMethod(specific_storage=(RegridderType.OVERLAP, "max",))
__init__(*args: Any, **kwargs: Any) → None#

Methods

__init__(*args, **kwargs)

asdict()

Attributes

convertible

specific_storage

specific_yield