imod.mf6.VerticesDiscretization#

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

Discretization by Vertices (DISV).

Parameters:

  • top (array of floats (xu.UgridDataArray)) – is the top elevation for each cell in the top model layer.

  • bottom (array of floats (xu.UgridDataArray)) – is the bottom elevation for each cell.

  • idomain (array of integers (xu.UgridDataArray)) –

    Indicates the existence status of a cell.

    • If 0, the cell does not exist in the simulation. Input and output values will be read and written for the cell, but internal to the program, the cell is excluded from the solution.

    • If >0, the cell exists in the simulation.

    • If <0, the cell does not exist in the simulation. Furthermore, the first existing cell above will be connected to the first existing cell below. This type of cell is referred to as a “vertical pass through” cell.

    This UgridDataArray needs to contain a "layer" coordinate and a face dimension. Horizontal discretization information will be derived from its face dimension.

  • validate ({True, False}) – Flag to indicate whether the package should be validated upon initialization. This raises a ValidationError if package input is provided in the wrong manner. Defaults to True.

__init__(top, bottom, idomain, validate: bool = True)[source]#

Methods

__init__(top, bottom, idomain[, validate])

cleanup(dis)

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

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

copy()

from_file(path, **kwargs)

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

get_non_grid_data(grid_names)

This function copies the attributes of a dataset that are scalars, such as options.

get_regrid_methods()

is_clipping_supported()

is_empty()

Returns True if the package is empty- for example if it contains only no-data values.

is_grid_agnostic_package()

is_regridding_supported()

is_splitting_supported()

isel()

mask(mask)

Mask values outside of domain.

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

Creates a package of the same type as this package, based on another discretization.

render(directory, pkgname, globaltimes, binary)

sel()

to_netcdf(*args[, mdal_compliant, crs])

Write dataset contents to a netCDF file.

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

Write package to file

write_binary_griddata(outpath, da, dtype)

write_blockfile(pkgname, globaltimes, ...)

write_text_griddata(outpath, da, dtype)

Attributes

auxiliary_data_fields

dataset

skip_variables