imod.mf6.regrid.DispersionRegridMethod#

class imod.mf6.regrid.DispersionRegridMethod(diffusion_coefficient: Tuple[RegridderType, str] | Tuple[RegridderType] = (RegridderType.OVERLAP, 'mean'), longitudinal_horizontal: Tuple[RegridderType, str] | Tuple[RegridderType] = (RegridderType.OVERLAP, 'mean'), transversal_horizontal1: Tuple[RegridderType, str] | Tuple[RegridderType] = (RegridderType.OVERLAP, 'mean'), longitudinal_vertical: Tuple[RegridderType, str] | Tuple[RegridderType] = (RegridderType.OVERLAP, 'mean'), transversal_horizontal2: Tuple[RegridderType, str] | Tuple[RegridderType] = (RegridderType.OVERLAP, 'mean'), transversal_vertical: Tuple[RegridderType, str] | Tuple[RegridderType] = (RegridderType.OVERLAP, 'mean'))[source]#

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

Parameters:

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

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

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

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

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

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

Examples

Regrid with custom settings:

>>> regrid_method = DispersionRegridMethod(longitudinal_horizontal=(RegridderType.BARYCENTRIC,))
>>> dsp.regrid_like(target_grid, RegridderWeightsCache(), regrid_method)

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

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

Methods

__init__(*args, **kwargs)

asdict()

Attributes

diffusion_coefficient

longitudinal_horizontal

longitudinal_vertical

transversal_horizontal1

transversal_horizontal2

transversal_vertical