Coverage for C:\src\imod-python\imod\mf6\model_gwt.py: 100%
12 statements
« prev ^ index » next coverage.py v7.5.1, created at 2024-05-08 14:15 +0200
« prev ^ index » next coverage.py v7.5.1, created at 2024-05-08 14:15 +0200
1from __future__ import annotations
3from typing import Optional
5from imod.logging import init_log_decorator
6from imod.mf6.model import Modflow6Model
9class GroundwaterTransportModel(Modflow6Model):
10 """
11 The GroundwaterTransportModel (GWT) simulates transport of a single solute
12 species flowing in groundwater.
13 More information can be found here:
14 https://water.usgs.gov/water-resources/software/MODFLOW-6/mf6io_6.4.2.pdf#page=172
16 Parameters
17 ----------
19 listing_file: Optional[str] = None
20 name of the listing file to create for this GWT model. If not specified,
21 then the name of the list file will be the basename of the GWT model
22 name file and the 'lst' extension.
23 print_input: bool = False
24 if True, indicates that the list of exchange entries will be echoed to
25 the listing file immediately after it is read.
26 print_flows: bool = False
27 if True, indicates that the list of exchange flow rates will be printed
28 to the listing file for every stress period in which "SAVE BUDGET" is
29 specified in Output Control
30 save_flows: bool = False,
31 if True, indicates that all model package flow terms will be written to
32 the file specified with "BUDGET FILEOUT" in Output Control.
33 """
35 _mandatory_packages = ("mst", "dsp", "oc", "ic")
36 _model_id = "gwt6"
37 _template = Modflow6Model._initialize_template("gwt-nam.j2")
39 @init_log_decorator()
40 def __init__(
41 self,
42 listing_file: Optional[str] = None,
43 print_input: bool = False,
44 print_flows: bool = False,
45 save_flows: bool = False,
46 ):
47 super().__init__()
48 self._options = {
49 "listing_file": listing_file,
50 "print_input": print_input,
51 "print_flows": print_flows,
52 "save_flows": save_flows,
53 }