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  strt_filename_fmt: "strt_{:03d}.dat"
 81  write_fmt: '%.2f'
 82
 83npf:
 84  options:
 85    save_flows: True
 86  griddata:
 87    icelltype: 1
 88  k_filename_fmt: "k_{:03d}.dat"
 89  k33_filename_fmt: "k33_{:03d}.dat"
 90
 91sto:
 92  options:
 93    save_flows: True
 94  griddata:
 95    iconvert: 1
 96  sy_filename_fmt: "sy_{:03d}.dat"
 97  ss_filename_fmt: "ss_{:03d}.dat"
 98
 99rch:
100  options:
101    print_input: True
102    print_flows: True
103    save_flows: True
104    readasarrays: True
105  recharge_filename_fmt: "rch_{:03d}.dat"
106  irch_filename_fmt: "irch.dat"
107
108sfr:
109  options:
110    save_flows: True
111    mover: True
112  budget_fileout: 'sfr.out.bin'
113  stage_fileout: 'sfr.stage.bin'
114  obs6_filein_fmt: 'sfr.obs'
115  external_files: True  # option to write packagedata to an external file
116
117# option to simulate lakes as zones of high hydraulic conductivity
118# (see Anderson and others (2002) in the references)
119high_k_lakes:
120  simulate_high_k_lakes: False
121  high_k_value: 1.e+4
122  sy: 1.0
123  ss: 5.e-10  # (approx. compressibility of water in Pa-1 or m2/N)
124
125lak:
126  options:
127    save_flows: True
128    budget_fileout: 'lake_out.bin'
129    stage_fileout: 'lake_stage.bin'
130    obs6_filein_fmt: '{}.sfr.obs6'
131    boundnames: True
132  lakarr_filename_fmt: 'lakarr_{:03d}.dat'
133  lakzones_filename_fmt: 'lakzones.dat' # file containing zones for lakebed leakance
134  external_files: True
135  horizontal_connections: False
136  connectiondata_filename_fmt: 'lake_connectiondata.dat'  # external table for connectiondata block
137  source_data:
138    littoral_zone_buffer_width: 20
139  output_files:
140    lookup_file: '{}_lak_lookup.csv'  # output file that maps lake ids to source polygon feature ids
141    lak_polygons_shapefile: '{}_lak_polygons.shp'
142    connections_lookup_file: '{}_lak_connections_lookup.csv'  # output file that maps lake/gw connections to zones
143    connections_shapefile: '{}_lak_cells.shp'
144mvr:
145  options:
146    print_flows: True
147
148chd:
149  options:
150    print_input: False
151    print_flows: False
152    save_flows: True
153    boundnames: True
154  source_data:
155    shapefile:
156      all_touched: True
157    head:
158      stat: 'min'
159  mfsetup_options:
160    external_files: True  # option to write stress_period_data to external files
161    external_filename_fmt: "chd_{:03d}.dat"
162
163drn:
164  options:
165    print_input: False
166    print_flows: False
167    save_flows: True
168    boundnames: True
169  source_data:
170    shapefile:
171      all_touched: True
172    elev:
173      stat: 'min'
174    cond:
175      stat: 'mean'
176  mfsetup_options:
177    external_files: True  # option to write stress_period_data to external files
178    external_filename_fmt: "drn_{:03d}.dat"
179
180ghb:
181  options:
182    print_input: False
183    print_flows: False
184    save_flows: True
185    boundnames: True
186  source_data:
187    shapefile:
188      all_touched: True
189    bhead:
190      stat: 'min'
191    cond:
192      stat: 'mean'
193  mfsetup_options:
194    external_files: True  # option to write stress_period_data to external files
195    external_filename_fmt: "ghb_{:03d}.dat"
196
197riv:
198  options:
199    print_input: True
200    print_flows: True
201    save_flows: True
202    boundnames: True
203  source_data:
204    shapefile:
205      all_touched: True
206    stage:
207      stat: 'min'
208    cond:
209      stat: 'mean'
210  output_files:
211    rivdata_file: '{}_rivdata.csv' # table with auxillary information on river reaches (routing, source hydrography IDs, etc.)
212  mfsetup_options:
213    default_rbot_thickness: 1.
214    external_files: True  # option to write stress_period_data to external files
215    external_filename_fmt: "riv_{:03d}.dat"
216
217wel:
218  options:
219    print_input: True
220    print_flows: True
221    save_flows: True
222    boundnames: True
223  output_files:
224    lookup_file: '{}_wel_lookup.csv' # output file that maps wel package data to site numbers
225    dropped_wells_file: '{}_dropped_wells.csv' # output file that records wells that were dropped during model setup
226  mfsetup_options:
227    minimum_layer_thickness: 2.
228    external_files: True  # option to write stress_period_data to external files
229    external_filename_fmt: "wel_{:03d}.dat"
230
231
232
233oc:
234  head_fileout_fmt: '{}.hds'
235  budget_fileout_fmt: '{}.cbc'
236  # example of using MODFLOW 6-style text input
237  period_options: {0: ['save head last',
238                       'save budget last']
239  }
240
241obs:
242  options:
243    digits: 10
244    print_input: True
245  source_data:
246    column_mappings:
247      hydlbl: ['obsprefix', 'obsnme', 'common_name']
248    x_location_col: 'x' # x coordinates in wtm
249    y_location_col: 'y' # y coordinates in wtm
250  mfsetup_options:
251    allow_obs_in_bc_cells: False
252    obsname_character_limit: 40  # modflow 6 limit
253    filename_fmt: '{}.head.obs'  # only head obs supported at this point
254
255ims:
256  options:
257    print_option: 'all'
258    csv_outer_output: 'solver_outer_out.csv'
259  nonlinear:
260    outer_dvclose: 1.e-1
261    outer_maximum: 200
262    under_relaxation:  'dbd'
263    under_relaxation_theta: 0.7
264    under_relaxation_kappa: 0.1
265    under_relaxation_gamma: 0.0
266    under_relaxation_momentum: 0.0
267    backtracking_number: 0
268  linear:
269    inner_maximum: 100
270    inner_dvclose: 1.e-2
271    rcloserecord: [0.0001, 'relative_rclose']
272    linear_acceleration: 'bicgstab'
273    relaxation_factor: 0.0  # either ILU(0) or ILUT preconditioning
274    preconditioner_levels: 7
275    preconditioner_drop_tolerance: 0.001
276    number_orthogonalizations: 0
277    scaling_method: None
278    reordering_method: None
279
280mfsetup_options:
281  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