imod.flow.MetaSwap#

class imod.flow.MetaSwap(boundary, landuse, rootzone_thickness, soil_physical_unit, meteo_station_number, surface_elevation, sprinkling_type, sprinkling_layer, sprinkling_capacity, wetted_area, urban_area, ponding_depth_urban, ponding_depth_rural, runoff_resistance_urban, runoff_resistance_rural, runon_resistance_urban, runon_resistance_rural, infiltration_capacity_urban, infiltration_capacity_rural, perched_water_table, lookup_and_forcing_files, soil_moisture_factor=1.0, conductivity_factor=1.0)[source]#

The MetaSWAP package (CAP), provides the input to be converted to a MetaSWAP model, which is an external model code used to simulate the unsaturated zone.

Note that only two-dimensional DataArrays with dimensions ("y", "x") should be supplied to this package. In the current implementation time-related files are provided as external files (“extra files”). Similar to the iMODFLOW implementation of the projectfile. For now these need to be provided as a path.

MetaSWAP is developed by Alterra, Wageningen as part of the SIMGRO model code. The SIMGRO framework is intended for regions with an undulating topography and unconsolidated sediments in the (shallow) subsoil. Both shallow and deep groundwater levels can be modelled by MetaSWAP. This model is based on a simplification of ‘straight Richards’, meaning that no special processes like hysteresis, preferential flow and bypass flow are modelled. Snow is not modelled, and neither the influence of frost on the soil water conductivity. A perched watertable can be present in the SVAT column model, but interflow is not modelled. Processes that are typical for steep slopes are not included. The code contains several parameterized water management schemes, including irrigation and water level management.

References:

  • Van Walsum, P. E. V., 2017a. SIMGRO V7.3.3.2, Input and Output reference manual. Tech. Rep. Alterra-Report 913.3, Alterra, Wageningen. 98 pp.

  • Van Walsum, P. E. V., 2017b. SIMGRO V7.3.3.2, Users Guide. Tech. Rep. Alterra-Report 913.2, Alterra, Wageningen. 111 pp.

  • Van Walsum, P. E. V. and P. Groenendijk, 2008. “Quasi Steady-State Simulation on of the Unsaturated Zone in Groundwater Modeling of Lowland Regions.” Vadose Zone Journal 7: 769-778.

  • Van Walsum, P. E. V., A. A. Veldhuizen and P. Groenendijk, 2016. SIMGRO V7.2.27, Theory and model implementation. Tech. Rep. Alterra-Report 913.1, Alterra, Wageningen. 93 pp 491.

Parameters
  • boundary (int or xr.DataArray of ints) – 2D boundary, used to specify active MetaSWAP elements, similar to ibound in the Boundary package

  • landuse (int or xr.DataArray of ints) – Landuse codes, referred to in the lookup table file luse_mswp.inp

  • rootzone_thickness (float or xr.DataArray of floats) – Rootzone thickness in cm (min. value is 10 centimeter).

  • soil_physical_unit (int or xr.DataArray of ints) – Soil Physical Unit, referred to in the lookup table file fact_mswp.inp.

  • meteo_station_number (float or xr.DataArray of ints) – Meteo station number, referred to by mete_mswp.inp.

  • surface_elevation (float or xr.DataArray of floats) – Surface Elevation (m+MSL)

  • sprinkling_type (int or xr.DataArray of ints) –

    Sprinkling type (“Artificial Recharge Type” in iMOD manual):

    • 0 = no occurrence

    • 1 = from groundwater

    • 2 = from surface water

  • sprinkling_layer (int or xr.DataArray of ints) –

    Number of modellayer from which water is extracted (“Artificial

    Recharge Location” in iMOD manual)

  • sprinkling_capacity (float or xr.DataArray of floats) – Sprinkling capacity (mm/d) sets the maximum amount extracted for sprinkling (“Artificial Recharge Capacity” in iMOD manual)

  • wetted_area (float or xr.DataArray of floats) – Total area (m2) occupied by surface water elements. Values will be truncated by maximum cellsize.

  • urban_area (float or xr.DataArray of floats) – Total area (m2) occupied by urban area. Values will be truncated by maximum cellsize.

  • ponding_depth_urban (float or xr.DataArray of floats) – Ponding Depth Urban Area (m), specifying the acceptable depth of the ponding of water on the surface in the urban area before surface runoff occurs.

  • ponding_depth_rural (float or xr.DataArray of floats) – Ponding Depth Rural Area (m), specifying the acceptable depth of the ponding of water on the surface in the rural area before surface runoff occurs.

  • runoff_resistance_urban (float or xr.DataArray of floats) – Runoff Resistance Urban Area (day), specifying the resistance surface flow encounters in the urban area. The minimum value is equal to the model time period.

  • runoff_resistance_rural (float or xr.DataArray of floats) – Runoff Resistance Rural Area (day), specifying the resistance surface flow encounters in the rural area. The minimum value is equal to the model time period.

  • runon_resistance_urban (float or xr.DataArray of floats) – Runon Resistance Urban Area (day), specifying the resistance surface flow encounters to a model cell from an adjacent cell in the urban area. The minimum value is equal to the model time period.

  • runon_resistance_rural (float or xr.DataArray of floats) – Runon Resistance Rural Area (day), specifying the resistance surface flow encounters to a model cell from an adjacent cell in the rural area. The minimum value is equal to the model time period.

  • infiltration_capacity_urban (float or xr.DataArray of floats) – the infiltration capacity (m/d) of the soil surface in the urban area. The range is 0-1000 m/d. The NoDataValue -9999 indicates unlimited infiltration is possible.

  • infiltration_capacity_rural (float or xr.DataArray of floats) – the infiltration capacity (m/d) of the soil surface in the urban area. The range is 0-1000 m/d. The NoDataValue -9999 indicates unlimited infiltration is possible.

  • perched_water_table (float or xr.DataArray of floats) – Depth of the perched water table level (m)

  • soil_moisture_factor (float) – Soil Moisture Factor to adjust the soil moisture coefficient. This factor may be used during calibration. Default value is 1.0.

  • conductivity_factor (float) – Conductivity Factor to adjust the vertical conductivity. This factor may be used during calibration. Default value is 1.0.

  • lookup_and_forcing_files (list of pathlib.Path or str) – List of paths to files required by MetaSWAP. This a list of lookup tables and meteorological information that is required by MetaSwap. Note that MetaSwap looks for files with a specific name, so calling “luse_svat.inp” something else will result in errors. To view the files required, you can call: print(MetaSwap()._required_extra)

__init__(boundary, landuse, rootzone_thickness, soil_physical_unit, meteo_station_number, surface_elevation, sprinkling_type, sprinkling_layer, sprinkling_capacity, wetted_area, urban_area, ponding_depth_urban, ponding_depth_rural, runoff_resistance_urban, runoff_resistance_rural, runon_resistance_urban, runon_resistance_rural, infiltration_capacity_urban, infiltration_capacity_rural, perched_water_table, lookup_and_forcing_files, soil_moisture_factor=1.0, conductivity_factor=1.0)[source]#

Methods

__init__(boundary, landuse, ...[, ...])

check_lookup_and_forcing_files()

Check for presence of required MetaSWAP input files.

compose(directory, globaltimes, nlayer[, ...])

Composes package, not useful for boundary conditions

from_file(path, **kwargs)

Loads an imod-flow package from a file (currently only netcdf and zarr are supported).

isel()

save(directory)

sel()