flopy.modflow.mffhb Module

mffhb module. Contains the ModflowFhb class. Note that the user can access the ModflowFhb class as flopy.modflow.ModflowFhb.

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

class flopy.modflow.mffhb.ModflowFhb(model, nbdtim=1, nflw=0, nhed=0, ifhbss=0, ipakcb=None, nfhbx1=0, nfhbx2=0, ifhbpt=0, bdtimecnstm=1.0, bdtime=[0.0], cnstm5=1.0, ds5=None, cnstm7=1.0, ds7=None, extension='fhb', unitnumber=None, filenames=None)

MODFLOW Evapotranspiration Package Class.

Parameters:

model : model object

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

nbdtim : int

The number of times at which flow and head will be specified for all selected cells. (default is 1)

nflw : int

Number of cells at which flows will be specified. (default is 0)

nhed: int

Number of cells at which heads will be specified. (default is 0)

ifhbss : int

FHB steady-state option flag. If the simulation includes any transient-state stress periods, the flag is read but not used; in this case, specified-flow, specified-head, and auxiliary-variable values will be interpolated for steady-state stress periods in the same way that values are interpolated for transient stress periods. If the simulation includes only steady-state stress periods, the flag controls how flow, head, and auxiliary-variable values will be computed for each steady-state solution. (default is 0)

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 None).

nfhbx1 : int

Number of auxiliary variables whose values will be computed for each time step for each specified-flow cell. Auxiliary variables are currently not supported. (default is 0)

nfhbx2 : int

Number of auxiliary variables whose values will be computed for each time step for each specified-head cell. Auxiliary variables are currently not supported. (default is 0)

ifhbpt : int

Flag for printing values of data list. Applies to datasets 4b, 5b, 6b, 7b, and 8b. If ifhbpt > 0, datasets read at the beginning of the simulation will be printed. Otherwise, the datasets will not be printed. (default is 0).

bdtimecnstm : float

A constant multiplier for data list bdtime. (default is 1.0)

bdtime : float or list of floats

Simulation time at which values of specified flow and (or) values of specified head will be read. nbdtim values are required. (default is 0.0)

cnstm5 : float

A constant multiplier for data list flwrat. (default is 1.0)

ds5 : list or numpy array or recarray

Each FHB flwrat cell (dataset 5) is defined through definition of layer(int), row(int), column(int), iaux(int), flwrat[nbdtime](float). There are nflw entries. (default is None) The simplest form is a list of lists with the FHB flow boundaries. This gives the form of:

ds5 =
[
    [lay, row, col, iaux, flwrat1, flwra2, ..., flwrat(nbdtime)],
    [lay, row, col, iaux, flwrat1, flwra2, ..., flwrat(nbdtime)],
    [lay, row, col, iaux, flwrat1, flwra2, ..., flwrat(nbdtime)],
    [lay, row, col, iaux, flwrat1, flwra2, ..., flwrat(nbdtime)]
]

Note there should be nflw rows in ds7.

cnstm7 : float

A constant multiplier for data list sbhedt. (default is 1.0)

ds7 : list or numpy array or recarray

Each FHB sbhed cell (dataset 7) is defined through definition of layer(int), row(int), column(int), iaux(int), sbhed[nbdtime](float). There are nflw entries. (default is None) The simplest form is a list of lists with the FHB flow boundaries. This gives the form of:

ds5 =
[
    [lay, row, col, iaux, sbhed1, sbhed2, ..., sbhed(nbdtime)],
    [lay, row, col, iaux, sbhed1, sbhed2, ..., sbhed(nbdtime)],
    [lay, row, col, iaux, sbhed1, sbhed2, ..., sbhed(nbdtime)],
    [lay, row, col, iaux, sbhed1, sbhed2, ..., sbhed(nbdtime)]
]

Note there should be nhed rows in ds7.

extension : string

Filename extension (default is ‘fhb’)

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
>>> m = flopy.modflow.Modflow()
>>> fhb = flopy.modflow.ModflowFhb(m)
check(f=None, verbose=True, level=1)

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 sting 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:

None

Examples

>>> import flopy
>>> m = flopy.modflow.Modflow.load('model.nam')
>>> m.dis.check()
static load(f, model, nper=None, ext_unit_dict=None)

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.

Returns:

fhb : ModflowFhb object

ModflowFhb object.

Examples

>>> import flopy
>>> m = flopy.modflow.Modflow()
>>> fhb = flopy.modflow.ModflowFhb.load('test.fhb', m)
plot(**kwargs)

Plot 2-D, 3-D, transient 2-D, and stress period list (MfList) package input data

Parameters:

**kwargs : dict

filename_base
: str

Base file name that will be used to automatically generate file names for output image files. Plots will be exported as image files if file_name_base is not None. (default is None)

file_extension
: str

Valid matplotlib.pyplot file extension for savefig(). Only used if filename_base is not None. (default is ‘png’)

mflay
: int

MODFLOW zero-based layer number to return. If None, then all all layers will be included. (default is None)

kper
: int

MODFLOW zero-based stress period number to return. (default is zero)

key
: str

MfList dictionary key. (default is None)

Returns:

axes : list

Empty list is returned if filename_base is not None. Otherwise a list of matplotlib.pyplot.axis are returned.

Examples

>>> import flopy
>>> ml = flopy.modflow.Modflow.load('test.nam')
>>> ml.dis.plot()
to_shapefile(filename, **kwargs)

Export 2-D, 3-D, and transient 2-D model data to shapefile (polygons). Adds an attribute for each layer in each data array

Parameters:

filename : str

Shapefile name to write

Returns:

None

Examples

>>> import flopy
>>> ml = flopy.modflow.Modflow.load('test.nam')
>>> ml.lpf.to_shapefile('test_hk.shp')
write_file()

Write the package file.

Returns:None