imod.couplers.metamod.MetaMod#

class imod.couplers.metamod.MetaMod(msw_model: imod.msw.model.MetaSwapModel, mf6_simulation: imod.mf6.simulation.Modflow6Simulation, mf6_rch_pkgkey: str, mf6_wel_pkgkey: Optional[str] = None)[source]#

The MetaMod class creates the necessary input files for coupling MetaSWAP to MODFLOW 6.

Parameters
  • msw_model (MetaSwapModel) – The MetaSWAP model that should be coupled.

  • mf6_simulation (Modflow6Simulation) – The Modflow6 simulation that should be coupled.

  • mf6_rch_pkgkey (str) – Key of Modflow 6 recharge package to which MetaSWAP is coupled.

  • mf6_wel_pkgkey (str or None) – Optional key of Modflow 6 well package to which MetaSWAP sprinkling is coupled.

__init__(msw_model: imod.msw.model.MetaSwapModel, mf6_simulation: imod.mf6.simulation.Modflow6Simulation, mf6_rch_pkgkey: str, mf6_wel_pkgkey: Optional[str] = None)[source]#

Methods

__init__(msw_model, mf6_simulation, ...[, ...])

write(directory, modflow6_dll, metaswap_dll, ...)

Write MetaSWAP and Modflow 6 model with exchange files, as well as a .toml file which configures the imod coupler run.

write_exchanges(directory, mf6_rch_pkgkey, ...)

Write exchange files (.dxc) which map MetaSWAP's svats to Modflow 6 node numbers, recharge ids, and well ids.

write_toml(directory, modflow6_dll, ...)

Write .toml file which configures the imod coupler run.