imod.prepare.ALLOCATION_OPTION#

class imod.prepare.ALLOCATION_OPTION(*values)[source]#

Enumerator for settings to allocate planar grid with RIV, DRN, GHB, or RCH cells over the vertical layer dimensions. Numbers match the IDEFLAYER options in iMOD 5.6.

  • stage_to_riv_bot: RIV. Allocate cells spanning from the river stage up to the river bottom elevation. This matches the iMOD 5.6 IDEFLAYER = 0 option.

  • first_active_to_elevation: RIV, DRN, GHB. Allocate cells spanning from first upper active cell up to the river bottom elevation. This matches the iMOD 5.6 IDEFLAYER = -1 option.

  • stage_to_riv_bot_drn_above: RIV. Allocate cells spanning from first upper active cell up to the river bottom elevation. Method returns both allocated cells for a river package as well as a drain package. Cells above river stage are allocated as drain cells, cells below are as river cells. This matches the iMOD 5.6 IDEFLAYER = 1 option.

  • at_elevation: RIV, DRN, GHB. Allocate cells containing the river bottom elevation, drain elevation, or head respectively for river, drain and general head boundary. This matches the iMOD 5.6 IDEFLAYER = 2 option.

  • at_first_active: RIV, DRN, GHB, RCH. Allocate cells at the upper active cells. This has no equivalent option in iMOD 5.6.

Examples

>>> from imod.prepare.topsystem import ALLOCATION_OPTION
>>> setting = ALLOCATION_OPTION.at_first_active
>>> allocated = allocate_rch_cells(setting, active, rate)
__init__(*args, **kwds)#

Attributes

stage_to_riv_bot

first_active_to_elevation

stage_to_riv_bot_drn_above

at_elevation

at_first_active