flopy.mfusg.mfusgwel module

Mfusgwel module.

Contains the MfUsgWel class. Note that the user can access the MfUsgWel class as flopy.mfusg.MfUsgWel.

Additional information for this MODFLOW package can be found at the Online MODFLOW Guide.

class MfUsgWel(model, ipakcb=None, stress_period_data=None, cln_stress_period_data=None, dtype=None, cln_dtype=None, extension='wel', options=None, binary=False, unitnumber=None, filenames=None, add_package=True)

Bases: ModflowWel

MODFLOW-USG Well Package Class.

Parameters:

• model (model object) – The model object (of type flopy.modflow.mf.Modflow) to which this package will be added.

• ipakcb (int, optional) – Toggles whether cell-by-cell budget data should be saved. If None or zero, budget data will not be saved (default is None).

• stress_period_data (list of boundaries, or recarray of boundaries, or) –

  dictionary of boundaries For structured grid, each well is defined through definition of layer (int), row (int), column (int), flux (float). The simplest form is a dictionary with a lists of boundaries for each stress period, where each list of boundaries itself is a list of boundaries. Indices of the dictionary are the numbers of the stress period. This gives the form of:

  stress_period_data = {0: [

  [lay, row, col, flux], [lay, row, col, flux], [lay, row, col, flux] ],

  1: [

  [lay, row, col, flux], [lay, row, col, flux], [lay, row, col, flux] ], …

  kper:

  [ [lay, row, col, flux], [lay, row, col, flux], [lay, row, col, flux] ]

  }

  For unstructured grid,

  stress_period_data = {0: [

  [node, flux], [node, flux], [node, flux] ],

  1: [

  [node, flux], [node, flux], [node, flux] ], …

  kper:

  [ [node, flux], [node, flux], [node, flux] ]

  }

  Note that if the number of lists is smaller than the number of stress periods, then the last list of wells will apply until the end of the simulation. Full details of all options to specify stress_period_data can be found in the flopy3 boundaries Notebook in the basic subdirectory of the examples directory

• cln_stress_period_data (list of boundaries, or recarray of boundaries, or) –

  dictionary of boundaries Stress period data of wells simulated as Connected Linear Network (CLN) The simplest form is a dictionary with a lists of boundaries for each stress period, where each list of boundaries itself is a list of boundaries. Indices of the dictionary are the numbers of the stress period. This gives the form of:

  cln_stress_period_data = {0: [

  [iclnnode, flux], [iclnnode, flux], [iclnnode, flux] ],

  1: [

  [iclnnode, flux], [iclnnode, flux], [iclnnode, flux] ], …

  kper:

  [ [iclnnode, flux], [iclnnode, flux], [iclnnode, flux] ]

  }

• dtype (custom datatype of stress_period_data.) – If None the default well datatype will be applied (default is None).

• cln_dtype (custom datatype of cln_stress_period_data.) – If None the default well datatype will be applied (default is None).

• extension (string) – Filename extension (default is ‘wel’)

• options (list of strings) – Package options (default is None).

• unitnumber (int) – File unit number (default is None).

• filenames (str or list of str) – Filenames to use for the package and the output files. If filenames=None the package name will be created using the model name and package extension and the cbc output name will be created using the model name and .cbc extension (for example, modflowtest.cbc), if ipakcb is a number greater than zero. If a single string is passed the package will be set to the string and cbc output names will be created using the model name and .cbc extension, if ipakcb is a number greater than zero. To define the names for all package files (input and output) the length of the list of strings should be 2. Default is None.

• add_package (bool) – Flag to add the initialised package object to the parent model object. Default is True.

mxactw

Maximum number of wells for a stress period. This is calculated automatically by FloPy based on the information in stress_period_data.

Type:

int

Notes

Parameters are not supported in FloPy.

Examples

>>> import flopy
>>> m = flopy.mfusg.MfUsg()
>>> lrcq = {0:[[2, 3, 4, -100.]], 1:[[2, 3, 4, -100.]]}
>>> wel = flopy.mfusg.MfUsgWel(m, stress_period_data=lrcq)

write_file(f=None)

Write the package file.

Parameters:

f: (str) optional file name

rtype:

None