imod.mf6.TimeDiscretization#

class imod.mf6.TimeDiscretization(timestep_duration, n_timesteps=1, timestep_multiplier=1.0, validate: bool = True)[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.

__init__(timestep_duration, n_timesteps=1, timestep_multiplier=1.0, validate: bool = True)[source]#

Methods

__init__(timestep_duration[, n_timesteps, ...])

add_periodic_auxiliary_variable()

clip_domain([layer, x, y])

Clip a variable along the specified dimensions.

copy()

from_file(path, **kwargs)

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

get_auxiliary_variable_names()

isel()

mask(domain)

Mask values outside of domain.

period_data()

render()

sel()

to_sparse(arrdict, layer)

Convert from dense arrays to list based input

write(directory, name)

write_binary_griddata(outpath, da, dtype)

write_blockfile(directory, pkgname, ...)

write_netcdf(directory, pkgname[, ...])

Write to netcdf.

write_text_griddata(outpath, da, dtype)