imod.mf6.Modflow6Simulation.split

Modflow6Simulation.split(submodel_labels: DataArray | UgridDataArray, ignore_time_purge_empty: bool | None = None) → Modflow6Simulation

Split a simulation in different partitions using a submodel_labels array.

Parameters:

• submodel_labels (xr.DataArray or xu.UgridDataArray) – A grid that defines how the simulation will be split. The array should have the same topology as the domain being split, i.e. similar shape as a layer in the domain. The values in the array indicate to which partition a cell belongs. The values should be zero or greater.

• ignore_time_purge_empty (optional, bool, default None) – Whether to ignore the time dimension when purging empty packages. Can improve performance when splitting models with many time steps. Splitting models can cause package data with all nans. These packages are considered empty and need to be removed. However, checking all timesteps for each package is a costly operation. Therefore, this option can be set to True to only check the first timestep. If None, the value of the validation settings of the simulation are used.

Returns:

A new simulation containing all the split models and packages

Return type:

Modflow6Simulation

Examples

>>> submodel_labels = mf6_sim.create_partition_labels(n_partitions=4)
>>> m6_splitted = mf6_sim.split(submodel_labels)