flopy.modflow.mfflwob module

class ModflowFlwob(model, nqfb=0, nqcfb=0, nqtfb=0, iufbobsv=0, tomultfb=1.0, nqobfb=None, nqclfb=None, obsnam=None, irefsp=None, toffset=None, flwobs=None, layer=None, row=None, column=None, factor=None, flowtype=None, extension=None, no_print=False, options=None, filenames=None, unitnumber=None)[source]

Bases: flopy.pakbase.Package

Head-dependent flow boundary Observation package class. Minimal working example that will be refactored in a future version.

Parameters:
  • nqfb (int) – Number of cell groups for the head-dependent flow boundary observations
  • nqcfb (int) – Greater than or equal to the total number of cells in all cell groups
  • nqtfb (int) – Total number of head-dependent flow boundary observations for all cell groups
  • iufbobsv (int) – unit number where output is saved
  • tomultfb (float) – Time-offset multiplier for head-dependent flow boundary observations. The product of tomultfb and toffset must produce a time value in units consistent with other model input. tomultfb can be dimensionless or can be used to convert the units of toffset to the time unit used in the simulation.
  • nqobfb (int list of length nqfb) – The number of times at which flows are observed for the group of cells
  • nqclfb (int list of length nqfb) – Is a flag, and the absolute value of nqclfb is the number of cells in the group. If nqclfb is less than zero, factor = 1.0 for all cells in the group.
  • obsnam (string list of length nqtfb) – Observation name
  • irefsp (int of length nqtfb) – The zero-based stress period to which the observation time is referenced. The reference point is the beginning of the specified stress period.
  • toffset (float list of length nqtfb) – Is the time from the beginning of the stress period irefsp to the time of the observation. toffset must be in units such that the product of toffset and tomultfb are consistent with other model input. For steady state observations, specify irefsp as the steady state stress period and toffset less than or equal to perlen of the stress period. If perlen is zero, set toffset to zero. If the observation falls within a time step, linearly interpolation is used between values at the beginning and end of the time step.
  • flwobs (float list of length nqtfb) – Observed flow value from the head-dependent flow boundary into the aquifer (+) or the flow from the aquifer into the boundary (-)
  • layer (int list of length(nqfb, nqclfb)) – The zero-based layer index for the cell included in the cell group.
  • row (int list of length(nqfb, nqclfb)) – The zero-based row index for the cell included in the cell group.
  • column (int list of length(nqfb, nqclfb)) – The zero-based column index of the cell included in the cell group.
  • factor (float list of length(nqfb, nqclfb)) – Is the portion of the simulated gain or loss in the cell that is included in the total gain or loss for this cell group (fn of eq. 5).
  • flowtype (string) – String that corresponds to the head-dependent flow boundary condition type (CHD, GHB, DRN, RIV)
  • extension (list of string) – Filename extension. If extension is None, extension is set to [‘chob’,’obc’,’gbob’,’obg’,’drob’,’obd’, ‘rvob’,’obr’] (default is None).
  • no_print (boolean) – When True or 1, a list of flow observations will not be written to the Listing File (default is False)
  • options (list of strings) – Package options (default is None).
  • unitnumber (list of int) – File unit number. If unitnumber is None, unitnumber is set to [40, 140, 41, 141, 42, 142, 43, 143] (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 flwob output name will be created using the model name and .out extension (for example, modflowtest.out), if iufbobsv is a number greater than zero. If a single string is passed the package will be set to the string and flwob output name will be created using the model name and .out extension, if iufbobsv 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

This represents a minimal working example that will be refactored in a future version.

ftype()[source]
classmethod load(f, model, ext_unit_dict=None, check=True)[source]

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.
  • 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:

flwob – ModflowFlwob package object.
Return type:

ModflowFlwob package object

Examples

>>> import flopy
>>> m = flopy.modflow.Modflow()
>>> hobs = flopy.modflow.ModflowFlwob.load('test.drob', m)
write_file()[source]

Write the package file

Returns:
Return type:None