imod.mf6.TimeDiscretization#
- class imod.mf6.TimeDiscretization(*_, **__)[source]#
Timing for all models of the simulation is controlled by the Temporal Discretization (TDIS) Package. https://water.usgs.gov/water-resources/software/MODFLOW-6/mf6io_6.0.4.pdf#page=17
- Parameters:
timestep_duration (float) – is the length of a stress period. (PERLEN)
n_timesteps (int, optional) – is the number of time steps in a stress period (nstp). Default value: 1
timestep_multiplier (float, optional) – is the multiplier for the length of successive time steps. The length of a time step is calculated by multiplying the length of the previous time step by timestep_multiplier (TSMULT). Default value: 1.0
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.
Methods
__init__
(timestep_duration[, n_timesteps, ...])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, **kwargs)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