imod.mf6.ConstantConcentration#
- class imod.mf6.ConstantConcentration(*_, **__)[source]#
Constant Concentration package.
- Parameters:
concentration (array of floats (xr.DataArray)) – Concentration of the boundary.
print_input (({True, False}, optional)) – keyword to indicate that the list of constant head information will be written to the listing file immediately after it is read. Default is False.
print_flows (({True, False}, optional)) – Indicates that the list of constant head flow rates will be printed to the listing file for every stress period time step in which “BUDGET PRINT” is specified in Output Control. If there is no Output Control option and PRINT FLOWS is specified, then flow rates are printed for the last time step of each stress period. Default is False.
save_flows (({True, False}, optional)) – Indicates that constant head flow terms will be written to the file specified with “BUDGET FILEOUT” in Output Control. Default is False.
observations ([Not yet supported.]) – Default is None.
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__(concentration, print_input=False, print_flows=False, save_flows=False, observations=None, validate: bool = True)[source]#
Methods
__init__
(concentration[, print_input, ...])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).
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
(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.
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