imod.mf6.GeneralHeadBoundary.reallocate

GeneralHeadBoundary.reallocate(dis: StructuredDiscretization | VerticesDiscretization, npf: NodePropertyFlow | None = None, allocation_option: ALLOCATION_OPTION | None = None, distributing_option: DISTRIBUTING_OPTION | None = None) → Self

Reallocates topsystem data across layers and create new package with it. Aggregate data to planar data first, by taking either the mean for state variables (e.g. river stage), or the sum for fluxes and the conductance. Consequently allocate and distribute the planar data to the provided model layer schematization.

Parameters:

• dis (StructuredDiscretization | VerticesDiscretization) – The discretization of the model to which the data should be reallocated.

• npf (NodePropertyFlow, optional) – The node property flow package of the model to which the conductance should be distributed (if applicable). Required for packages with a conductance variable.

• allocation_option (ALLOCATION_OPTION, optional) – The allocation option to use for the reallocation. If None, the default allocation option is taken from imod.prepare.SimulationAllocationOptions.

• distributing_option (DISTRIBUTING_OPTION, optional) – The distributing option to use for the reallocation. Required for packages with a conductance variable. If None, the default is taken from imod.prepare.SimulationDistributingOptions.

Returns:

A new instance of the boundary condition class with the reallocated data. The original instance remains unchanged.

Return type:

BoundaryCondition