imod.mf6.AdvectionUpstream#

class imod.mf6.AdvectionUpstream(*_, **__)[source]#

The upstream weighting (first order upwind) scheme sets the concentration at the cellface between two adjacent cells equal to the concentration in the cell where the flow comes from. It surpresses oscillations.

Parameters:

  • ats_percel (float, optional) – Fractional cell distance submitted by the ADV Package to the imod.mf6.AdaptiveTimeStepping (ATS) package. If ats_percel is specified and the ATS Package is active, a time step calculation will be made for each cell based on flow through the cell and cell properties. The largest time step will be calculated such that the advective fractional cell distance (ats_percel) is not exceeded for any active cell in the grid. This time-step constraint will be submitted to the ATS Package, perhaps with constraints submitted by other packages, in the calculation of the time step. ats_percel must be greater than zero. If a value of zero is specified for ats_percel the program will automatically reset it to an internal no data value to indicate that time steps should not be subject to this constraint. Requires MODFLOW 6.6.0 or higher.

  • validate (bool, optional) – Validate the package upon initialization. Defaults to True.

__init__(ats_percel: float | None = None, validate: bool = True)#

Methods

__init__([ats_percel, validate])

clip_box([time_min, time_max, layer_min, ...])

Clip a package by a bounding box (time, layer, y, x).

copy()

Copy package into a new package of the same type.

from_file(path, **kwargs)

Loads an imod mf6 package from a file (currently only netcdf and zarr are supported).

get_regrid_methods()

Returns the default regrid methods for this package.

is_empty([ignore_time])

Returns True if the package is empty, that is if it contains only no-data values.

mask(_)

The mask method is irrelevant for this package, instead this method retuns a copy of itself.

regrid_like(target_grid, regrid_cache[, ...])

The regrid_like method is irrelevant for this package, instead this method retuns a copy of itself.

to_netcdf(*args[, mdal_compliant, crs])

Write dataset contents to a netCDF file.

write(pkgname, globaltimes, directory[, ...])

Write package to file

Attributes

auxiliary_data_fields

dataset