Configuration defaults¶
The following two yaml files contain default settings for MODFLOW-6 and MODFLOW-NWT. Settings not specified by the user in their configuration file are populated from these files when they are loaded into the MF6model
or MFnwtModel
model instances.
MODFLOW-6 configuration defaults¶
1# starting version number for the project
2# version reported by modflow-setup will then be
3# the start_version appended by the remaining information
4# in a pep440-post style version tag
5# (e.g. most recent git commit hash for the model repository
6# + "dirty" if the model repository has uncommited changes)
7# see https://github.com/warner/python-versioneer/blob/master/details.md
8metadata:
9 start_version: 0
10 longname:
11
12simulation:
13 options: {}
14 sim_name: 'mfsim'
15 version: 'mf6'
16 exe_name: 'mf6'
17 sim_ws: '.'
18
19model:
20 modelname: 'model'
21 version: 'mf6'
22 # list file format is relative to the model workspace
23 list_filename_fmt: '{}.list'
24 options:
25 print_input: True
26 print_flows: False
27 save_flows: True
28 newton: True
29 newton_under_relaxation: False
30 packages: []
31 hiKlakes_value: 1.e4
32 default_lake_depth: 2 # m; default depth to assume when setting up lak package or high-k lakes (layer 1 bottom is adjusted to achieve this thickness)
33 external_path: 'external/'
34 relative_external_filepaths: True
35
36parent:
37
38postprocessing:
39 output_folders:
40 pdfs: 'postproc/pdfs'
41 rasters: 'postproc/rasters'
42 shapefiles: 'postproc/shps'
43 tables: 'tables/'
44
45setup_grid:
46 structured: True
47 rotation: 0
48 variable_mappings:
49 xll: "xoff"
50 yll: "Yoff"
51 output_files:
52 grid_file: '{}_grid.json'
53 bbox_shapefile: '{}_bbox.shp'
54 snap_to_NHG: False
55 snap_to_parent: True
56
57dis:
58 remake_top: True
59 options:
60 length_units: 'meters'
61 dimensions: {}
62 griddata: {}
63 top_filename_fmt: "top.dat"
64 botm_filename_fmt: "botm_{:03d}.dat"
65 idomain_filename_fmt: "idomain_{:03d}.dat"
66 minimum_layer_thickness: 1 # in model units
67 drop_thin_cells: True
68
69tdis:
70 options:
71 time_units: 'days'
72 start_date_time: '1970-01-01'
73 end_date_time: None
74 dimensions: {}
75 perioddata: {}
76
77ic:
78 griddata:
79 strt:
80 source_data:
81 strt:
82 resample_method: 'linear'
83 strt_filename_fmt: "strt_{:03d}.dat"
84 write_fmt: '%.2f'
85
86npf:
87 options:
88 save_flows: True
89 griddata:
90 icelltype: 1
91 k_filename_fmt: "k_{:03d}.dat"
92 k33_filename_fmt: "k33_{:03d}.dat"
93
94sto:
95 options:
96 save_flows: True
97 griddata:
98 iconvert: 1
99 sy_filename_fmt: "sy_{:03d}.dat"
100 ss_filename_fmt: "ss_{:03d}.dat"
101
102rch:
103 options:
104 print_input: True
105 print_flows: True
106 save_flows: True
107 readasarrays: True
108 recharge_filename_fmt: "rch_{:03d}.dat"
109 irch_filename_fmt: "irch.dat"
110
111sfr:
112 options:
113 save_flows: True
114 mover: True
115 budget_fileout: 'sfr.out.bin'
116 stage_fileout: 'sfr.stage.bin'
117 obs6_filein_fmt: 'sfr.obs'
118 external_files: True # option to write packagedata to an external file
119
120# option to simulate lakes as zones of high hydraulic conductivity
121# (see Anderson and others (2002) in the references)
122high_k_lakes:
123 simulate_high_k_lakes: False
124 high_k_value: 1.e+4
125 sy: 1.0
126 ss: 5.e-10 # (approx. compressibility of water in Pa-1 or m2/N)
127
128lak:
129 options:
130 save_flows: True
131 budget_fileout: 'lake_out.bin'
132 stage_fileout: 'lake_stage.bin'
133 obs6_filein_fmt: '{}.sfr.obs6'
134 boundnames: True
135 lakarr_filename_fmt: 'lakarr_{:03d}.dat'
136 lakzones_filename_fmt: 'lakzones.dat' # file containing zones for lakebed leakance
137 external_files: True
138 horizontal_connections: False
139 connectiondata_filename_fmt: 'lake_connectiondata.dat' # external table for connectiondata block
140 source_data:
141 littoral_zone_buffer_width: 20
142 output_files:
143 lookup_file: '{}_lak_lookup.csv' # output file that maps lake ids to source polygon feature ids
144 lak_polygons_shapefile: '{}_lak_polygons.shp'
145 connections_lookup_file: '{}_lak_connections_lookup.csv' # output file that maps lake/gw connections to zones
146 connections_shapefile: '{}_lak_cells.shp'
147mvr:
148 options:
149 print_flows: True
150
151chd:
152 options:
153 print_input: False
154 print_flows: False
155 save_flows: True
156 boundnames: True
157 source_data:
158 shapefile:
159 all_touched: True
160 head:
161 stat: 'min'
162 mfsetup_options:
163 external_files: True # option to write stress_period_data to external files
164 external_filename_fmt: "chd_{:03d}.dat"
165
166drn:
167 options:
168 print_input: False
169 print_flows: False
170 save_flows: True
171 boundnames: True
172 source_data:
173 shapefile:
174 all_touched: True
175 elev:
176 stat: 'min'
177 cond:
178 stat: 'mean'
179 mfsetup_options:
180 external_files: True # option to write stress_period_data to external files
181 external_filename_fmt: "drn_{:03d}.dat"
182
183ghb:
184 options:
185 print_input: False
186 print_flows: False
187 save_flows: True
188 boundnames: True
189 source_data:
190 shapefile:
191 all_touched: True
192 bhead:
193 stat: 'min'
194 cond:
195 stat: 'mean'
196 mfsetup_options:
197 external_files: True # option to write stress_period_data to external files
198 external_filename_fmt: "ghb_{:03d}.dat"
199
200riv:
201 options:
202 print_input: True
203 print_flows: True
204 save_flows: True
205 boundnames: True
206 source_data:
207 shapefile:
208 all_touched: True
209 stage:
210 stat: 'min'
211 cond:
212 stat: 'mean'
213 output_files:
214 rivdata_file: '{}_rivdata.csv' # table with auxillary information on river reaches (routing, source hydrography IDs, etc.)
215 mfsetup_options:
216 default_rbot_thickness: 1.
217 external_files: True # option to write stress_period_data to external files
218 external_filename_fmt: "riv_{:03d}.dat"
219
220wel:
221 options:
222 print_input: True
223 print_flows: True
224 save_flows: True
225 boundnames: True
226 output_files:
227 lookup_file: '{}_wel_lookup.csv' # output file that maps wel package data to site numbers
228 dropped_wells_file: '{}_dropped_wells.csv' # output file that records wells that were dropped during model setup
229 mfsetup_options:
230 minimum_layer_thickness: 2.
231 external_files: True # option to write stress_period_data to external files
232 external_filename_fmt: "wel_{:03d}.dat"
233
234
235
236oc:
237 head_fileout_fmt: '{}.hds'
238 budget_fileout_fmt: '{}.cbc'
239 # example of using MODFLOW 6-style text input
240 period_options: {0: ['save head last',
241 'save budget last']
242 }
243
244obs:
245 options:
246 digits: 10
247 print_input: True
248 source_data:
249 column_mappings:
250 hydlbl: ['obsprefix', 'obsnme', 'common_name']
251 x_location_col: 'x' # x coordinates in wtm
252 y_location_col: 'y' # y coordinates in wtm
253 mfsetup_options:
254 allow_obs_in_bc_cells: False
255 obsname_character_limit: 40 # modflow 6 limit
256 filename_fmt: '{}.head.obs' # only head obs supported at this point
257
258ims:
259 options:
260 print_option: 'all'
261 csv_outer_output: 'solver_outer_out.csv'
262 nonlinear:
263 outer_dvclose: 1.e-1
264 outer_maximum: 200
265 under_relaxation: 'dbd'
266 under_relaxation_theta: 0.7
267 under_relaxation_kappa: 0.1
268 under_relaxation_gamma: 0.0
269 under_relaxation_momentum: 0.0
270 backtracking_number: 0
271 linear:
272 inner_maximum: 100
273 inner_dvclose: 1.e-2
274 rcloserecord: [0.0001, 'relative_rclose']
275 linear_acceleration: 'bicgstab'
276 relaxation_factor: 0.0 # either ILU(0) or ILUT preconditioning
277 preconditioner_levels: 7
278 preconditioner_drop_tolerance: 0.001
279 number_orthogonalizations: 0
280 scaling_method: None
281 reordering_method: None
282
283mfsetup_options:
284 keep_original_arrays: False
MODFLOW-NWT configuration defaults¶
1# starting version number for the project
2# version reported by modflow-setup will then be
3# the start_version appended by the remaining information
4# in a pep440-post style version tag
5# (e.g. most recent git commit hash for the model repository
6# + "dirty" if the model repository has uncommited changes)
7# see https://github.com/warner/python-versioneer/blob/master/details.md
8metadata:
9 start_version: 0
10 longname:
11
12model:
13 modelname: 'model'
14 model_ws: 'model/'
15 exe_name: 'mfnwt'
16 version: 'mfnwt'
17 external_path: 'external/'
18 # list file format is relative to the model workspace
19 list_filename_fmt: '{}.list'
20 relative_external_filepaths: True
21 hiKlakes_value: 1.e4
22 default_lake_depth: 2 # m; default depth to assume when setting up lak package or high-k lakes (layer 1 bottom is adjusted to achieve this thickness)
23 end_date_time:
24 packages: []
25
26setup_grid:
27 structured: True
28 rotation: 0
29 variable_mappings:
30 xll: "xoff"
31 yll: "Yoff"
32 output_files:
33 grid_file: '{}_grid.json'
34 bbox_shapefile: 'shps/{}_bbox.shp'
35 snap_to_NHG: False
36 snap_to_parent: True
37
38postprocessing:
39 output_folders:
40 pdfs: 'postproc/pdfs'
41 rasters: 'postproc/rasters'
42 shapefiles: 'postproc/shps'
43 tables: 'tables/'
44
45dis:
46 start_date_time: '1970-01-01'
47 top_filename_fmt: "top.dat"
48 botm_filename_fmt: "botm_{:03d}.dat"
49 minimum_layer_thickness: 1 # in model units
50 remake_top: True
51 lenuni: 2 # meters
52 itmuni: 4 # days
53 source_data:
54
55bas6:
56 hnoflo: -9999
57 ibound_filename_fmt: "ibound_{:03d}.dat"
58 strt_filename_fmt: "strt_{:03d}.dat"
59 strt_write_fmt: '%.2f'
60
61upw:
62 hk_filename_fmt: "hk_{:03d}.dat"
63 vka_filename_fmt: "vka_{:03d}.dat"
64 sy_filename_fmt: "sy_{:03d}.dat"
65 ss_filename_fmt: "ss_{:03d}.dat"
66 ipakcb: 53 # unit for writing cell budget output
67 hdry: -9999
68 laytyp: 1
69 layvka: 0
70
71rch:
72 remake_arrays: True
73 rech_mult: 1
74 rech_filename_fmt: "finf_{:03d}.dat"
75
76# option to simulate lakes as zones of high hydraulic conductivity
77# (see Anderson and others (2002) in the references)
78high_k_lakes:
79 simulate_high_k_lakes: False
80 high_k_value: 1.e+4
81 sy: 1.0
82 ss: 5.e-10 # (approx. compressibility of water in Pa-1 or m2/N)
83
84lak:
85 lakarr_filename_fmt: 'lakarr_{:03d}.dat'
86 bdlknc_filename_fmt: 'bdlknc_{:03d}.dat'
87 lakzones_filename_fmt: 'lakzones.dat' # file containing zones for lakebed leakance
88 theta: -0.7 # semi-implicit; negative value indicates that surfdep is read
89 nssitr: 800 # number of Newton iterations for solution of lake stage, for each MODFLOW iteration.
90 sscncr: 0.0000001 # lake stage convergence criterion
91 surfdep: 0.1 # undulations in lake bottom that affect GW discharge. Range in online instructions is 0.01-0.5. (Value from Trout Lake)
92 source_data:
93 littoral_zone_buffer_width: 20
94 output_files:
95 lookup_file: '{}_lak_lookup.csv' # output file that maps lake ids to source polygon feature ids
96 lak_polygons_shapefile: '{}_lak_polygons.shp'
97 connections_lookup_file: '{}_lak_connections_lookup.csv' # output file that maps lake/gw connections to zones
98 connections_shapefile: '{}_lak_cells.shp'
99
100sfr:
101
102chd:
103 options:
104 source_data:
105 shapefile:
106 all_touched: True
107 shead:
108 stat: 'min'
109 ehead:
110 stat: 'min'
111 mfsetup_options:
112 external_files: True # option to write stress_period_data to external files
113 external_filename_fmt: "chd_{:03d}.dat"
114
115drn:
116 options:
117 source_data:
118 shapefile:
119 all_touched: True
120 elev:
121 stat: 'min'
122 cond:
123 stat: 'mean'
124 mfsetup_options:
125 external_files: True # option to write stress_period_data to external files
126 external_filename_fmt: "drn_{:03d}.dat"
127
128ghb:
129 options:
130 source_data:
131 shapefile:
132 all_touched: True
133 bhead:
134 stat: 'min'
135 cond:
136 stat: 'mean'
137 mfsetup_options:
138 external_files: False # option to write stress_period_data to external files
139 external_filename_fmt: "ghb_{:03d}.dat"
140
141riv:
142 source_data:
143 shapefile:
144 all_touched: True
145 stage:
146 stat: 'min'
147 cond:
148 stat: 'mean'
149 output_files:
150 rivdata_file: '{}_rivdata.csv' # table with auxillary information on river reaches (routing, source hydrography IDs, etc.)
151 mfsetup_options:
152 default_rbot_thickness: 1.
153 external_files: True # option to write stress_period_data to external files
154 external_filename_fmt: "riv_{:03d}.dat"
155
156wel:
157 options: ['SPECIFY', '0.01']
158 output_files:
159 lookup_file: '{}_wel_lookup.csv' # output file that maps wel package data to site numbers
160 dropped_wells_file: '{}_dropped_wells.csv' # output file that records wells that were dropped during model setup
161 mfsetup_options:
162 minimum_layer_thickness: 2.
163 external_files: True # option to write stress_period_data to external files
164 external_filename_fmt: "wel_{:03d}.dat"
165
166mnw:
167 defaults: {losstype: 'skin',
168 pumploc: -1,
169 rw: 0.1, # well radius, m
170 rskin: 0.1524, # radius to outer limit of skin
171 kskin: 50 # m/day
172 }
173
174oc:
175 head_fileout_fmt: '{}.hds'
176 budget_fileout_fmt: '{}.cbc'
177 period_options: {0: ['save head last',
178 'save budget last']
179 }
180
181hyd:
182 hydnoh: -999
183 source_data:
184 column_mappings:
185 hydlbl: ['obsprefix', 'obsnme', 'common_name']
186 x_location_col: 'x' # x coordinates in wtm
187 y_location_col: 'y' # y coordinates in wtm
188 mfsetup_options:
189 allow_obs_in_bc_cells: False
190 obsname_character_limit: 14 # hydmod limit
191
192gag:
193 starting_unit_number: 250
194 lak_outtype: 1 # see gage package documentation for Data Set 2a outtype
195 sfr_outtype: 0 # see gage package documentation for Data Set 2b outtype
196 column_mappings:
197 x_location_col: ['x_utm', 'X']
198 y_location_col: ['y_utm', 'Y']
199
200nwt:
201 headtol: 1.e-6
202 fluxtol: 6000
203 maxiterout: 1000
204 thickfact: 0.00001
205 linmeth: 2
206 iprnwt: 1
207 ibotav: 1
208 options: 'SPECIFIED'
209 Continue: True
210 dbdtheta: 0.9
211 dbdkappa: 0.00001
212 dbdgamma: 0
213 momfact: 0
214 backflag: 0
215 iacl: 2
216 norder: 0
217 level: 7
218 north: 0
219 iredsys: 0
220 rrctols: 0
221 idroptol: 1
222 epsrn: 0.01
223 hclosexmd: 1.e-5
224 mxiterxmd: 85
225 use_existing_file:
226
227mfsetup_options:
228 keep_original_arrays: False