flopy.modflow.mfghb module

mfghb module. Contains the ModflowGhb class. Note that the user can access the ModflowGhb class as flopy.modflow.ModflowGhb.

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

class ModflowGhb(model, ipakcb=None, stress_period_data=None, dtype=None, no_print=False, options=None, extension='ghb', unitnumber=None, filenames=None)

Bases: flopy.pakbase.Package

MODFLOW General-Head Boundary 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, recarray of boundaries or,) –

  dictionary of boundaries.

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

  Note that if no values are specified for a certain stress period, then the list of boundaries for the previous stress period for which values were defined is used. Full details of all options to specify stress_period_data can be found in the flopy3boundaries Notebook in the basic subdirectory of the examples directory

• dtype (dtype definition) – if data type is different from default
• options (list of strings) – Package options. (default is None).
• extension (string) – Filename extension (default is ‘ghb’)
• 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.

Notes

Parameters are not supported in FloPy.

Examples

>>> import flopy
>>> ml = flopy.modflow.Modflow()
>>> lrcsc = {0:[2, 3, 4, 10., 100.]}  #this ghb will be applied to all
>>>                                   #stress periods
>>> ghb = flopy.modflow.ModflowGhb(ml, stress_period_data=lrcsc)

add_record(kper, index, values)

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:

ghb – ModflowGhb object.

Return type:

ModflowGhb object

Examples

>>> import flopy
>>> m = flopy.modflow.Modflow()
>>> ghb = flopy.modflow.ModflowGhb.load('test.ghb', m)

write_file(check=True)

Write the package file.

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