imod.prepare.SimulationAllocationOptions#

class imod.prepare.SimulationAllocationOptions(drn: ALLOCATION_OPTION = ALLOCATION_OPTION.at_elevation, riv: ALLOCATION_OPTION = ALLOCATION_OPTION.stage_to_riv_bot, ghb: ALLOCATION_OPTION = ALLOCATION_OPTION.at_elevation, rch: ALLOCATION_OPTION = ALLOCATION_OPTION.at_first_active)[source]#

Object containing default allocation options, specified per packages type on importing from imod5. Can be used to set defaults when importing a simulation or a GroundwaterFlowModel from imod5.

Parameters:

  • drn (ALLOCATION_OPTION) – allocation option to be used for drainage packages, defaults to at_elevation.

  • riv (ALLOCATION_OPTION) – allocation option to be used for river packages, defaults to stage_to_riv_bot.

  • ghb (ALLOCATION_OPTION) – allocation option to be used for general head boundary packages, defaults to at_elevation.

  • rch (ALLOCATION_OPTION) – allocation option to be used for recharge packages, defaults to at_first_active.

Examples

Initiate allocation default options

>>> alloc_options = SimulationAllocationOptions()

You can set different options as follows:

>>> from imod.prepare.topsystem import ALLOCATION_OPTION
>>> alloc_options.riv = ALLOCATION_OPTION.at_elevation
__init__(drn: ALLOCATION_OPTION = ALLOCATION_OPTION.at_elevation, riv: ALLOCATION_OPTION = ALLOCATION_OPTION.stage_to_riv_bot, ghb: ALLOCATION_OPTION = ALLOCATION_OPTION.at_elevation, rch: ALLOCATION_OPTION = ALLOCATION_OPTION.at_first_active) → None#

Methods

__init__([drn, riv, ghb, rch])

Attributes

drn

ghb

rch

riv