imod.prepare.SimulationDistributingOptions#

class imod.prepare.SimulationDistributingOptions(drn: DISTRIBUTING_OPTION = DISTRIBUTING_OPTION.by_corrected_transmissivity, riv: DISTRIBUTING_OPTION = DISTRIBUTING_OPTION.by_corrected_transmissivity, ghb: DISTRIBUTING_OPTION = DISTRIBUTING_OPTION.by_layer_transmissivity)[source]#

Object containing conductance distribution methods, specified per packages type. Can be used to set defaults when importing a simulation or a GroundwaterFlowModel from imod5.

Parameters:

  • drn (DISTRIBUTING_OPTION) – distribution option to be used for drainage packages, defaults to by_corrected_transmissivity.

  • riv (DISTRIBUTING_OPTION) – distribution option to be used for river packages, defaults to by_corrected_transmissivity.

  • ghb (DISTRIBUTING_OPTION) – distribution option to be used for general head boundary packages, defaults to by_layer_transmissivity.

Examples

Initiate default distributing options

>>> dist_options = SimulationDistributingOptions()

You can set different options as follows:

>>> from imod.prepare.topsystem import DISTRIBUTING_OPTION
>>> dist_options.riv = DISTRIBUTING_OPTION.by_layer_transmissivity
__init__(drn: DISTRIBUTING_OPTION = DISTRIBUTING_OPTION.by_corrected_transmissivity, riv: DISTRIBUTING_OPTION = DISTRIBUTING_OPTION.by_corrected_transmissivity, ghb: DISTRIBUTING_OPTION = DISTRIBUTING_OPTION.by_layer_transmissivity) → None#

Methods

__init__([drn, riv, ghb])

Attributes

drn

ghb

riv