flopy.modflow.mfriv module

mfriv module. Contains the ModflowRiv class. Note that the user can access the ModflowRiv class as flopy.modflow.ModflowRiv.

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

class ModflowRiv(model, ipakcb=None, stress_period_data=None, dtype=None, extension='riv', options=None, unitnumber=None, filenames=None, **kwargs)

Bases: flopy.pakbase.Package

MODFLOW River Package Class.

Parameters:

• model (model object) – The model object (of type flopy.modflow.mf.Modflow) to which this package will be added.
• ipakcb (int) – A flag that is used to determine if cell-by-cell budget data should be saved. If ipakcb is non-zero cell-by-cell budget data will be saved. (default is 0).
• stress_period_data (list of boundaries, or recarray of boundaries, or) –

  dictionary of boundaries. Each river cell is defined through definition of layer (int), row (int), column (int), stage (float), cond (float), rbot (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, stage, cond, rbot],
      [lay, row, col, stage, cond, rbot],
      [lay, row, col, stage, cond, rbot]
      ],
  1:  [
      [lay, row, col, stage, cond, rbot],
      [lay, row, col, stage, cond, rbot],
      [lay, row, col, stage, cond, rbot]
      ], ...
  kper:
      [
      [lay, row, col, stage, cond, rbot],
      [lay, row, col, stage, cond, rbot],
      [lay, row, col, stage, cond, rbot]
      ]
  }
  

  Note that if the number of lists is smaller than the number of stress periods, then the last list of rivers 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.

• dtype (custom datatype of stress_period_data.) – (default is None) If None the default river datatype will be applied.
• naux (int) – number of auxiliary variables
• extension (string) – Filename extension (default is ‘riv’)
• 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 ipakcbc 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 ipakcbc 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.

mxactr

Maximum number of river cells for a stress period. This is calculated automatically by FloPy based on the information in layer_row_column_data.

Type:int

Notes

Parameters are not supported in FloPy.

Examples

>>> import flopy
>>> m = flopy.modflow.Modflow()
>>> lrcd = {}
>>> lrcd[0] = [[2, 3, 4, 15.6, 1050., -4]]  #this river boundary will be
>>>                                         #applied to all stress periods
>>> riv = flopy.modflow.ModflowRiv(m, stress_period_data=lrcd)

add_record(kper, index, values)

check(f=None, verbose=True, level=1, checktype=None)

Check package data for common errors.

Parameters:

• f (str or file handle) – String defining file name or file handle for summary file of check method output. If a string is passed a file handle is created. If f is None, check method does not write results to a summary file. (default is None)
• verbose (bool) – Boolean flag used to determine if check method results are written to the screen.
• level (int) – Check method analysis level. If level=0, summary checks are performed. If level=1, full checks are performed.

Returns:

Return type:

None

Examples

>>> import flopy
>>> m = flopy.modflow.Modflow.load('model.nam')
>>> m.riv.check()

static get_default_dtype(structured=True)

static get_empty(ncells=0, aux_names=None, structured=True)

classmethod load(f, model, nper=None, ext_unit_dict=None, check=True)

Load an existing package.

Parameters:

• f (filename or file handle) – File to load.
• model (model object) – The model object (of type flopy.modflow.mf.Modflow) to which this package will be added.
• nper (int) – The number of stress periods. If nper is None, then nper will be obtained from the model object. (default is None).
• ext_unit_dict (dictionary, optional) – If the arrays in the file are specified using EXTERNAL, or older style array control records, then f should be a file handle. In this case ext_unit_dict is required, which can be constructed using the function flopy.utils.mfreadnam.parsenamefile.
• check (boolean) – Check package data for common errors. (default True)

Returns:

rch – ModflowRiv object.

Return type:

ModflowRiv object

Examples

>>> import flopy
>>> m = flopy.modflow.Modflow()
>>> riv = flopy.modflow.ModflowRiv.load('test.riv', m)

write_file(check=True)

Write the package file.

Parameters:check (boolean) – Check package data for common errors. (default True) Returns: Return type:None