flopy.mfusg.mfusgbct module

Mfusgbct module.

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

class MfUsgBct(model, itrnsp=1, ipakcb=0, mcomp=1, icbndflg=1, itvd=1, iadsorb=0, ict=0, cinact=-999.0, ciclose=1e-06, idisp=1, ixdisp=0, diffnc=0.0, izod=0, ifod=0, ifmbc=0, iheat=0, imcomp=0, idispcln=0, nseqitr=0, icbund=1, prsity=0.15, bulkd=1.0, anglex=0.0, dl=1.0, dt=0.1, dlx=1.0, dly=1.0, dlz=0.1, dtxy=0.1, dtyz=0.1, dtxz=0.1, conc=0.0, extension=['bct', 'cbt', 'mbegwf', 'mbegwt', 'mbeclnf', 'mbeclnt'], unitnumber=None, filenames=None, add_package=True, **kwargs)[source]

Bases: Package

Block Centered Transport (BCT) Package Class for MODFLOW-USG Transport.

Parameters:

model (model object) – The model object (of type flopy.modflow.Modflow) to which this package will be added.
itrnsp (int (0,1,2,3,4,5,-1), (default is 1)) – transport simulation flag
ipakcb (int (0,1,-1), (default is 0)) – a flag and a unit number >0 .
mcomp (int (default is 1)) – number of mobile component species simulated
icbndflg (int (default is 1)) – a flag that determines if active domain for transport the same as for flow
itvd (int (default is 3)) – 0 : upstream weighted scheme is used for simulating the advective term >0 : number of TVD correction iterations used for simulating the advective term
iadsorb (int (default is 0)) – adsorption flag (0: no adsorption, 1: linear isotherm, 2: Freundlich isotherm, 3: Langmuir isotherm)
ict (int (default is 0)) – transport solution scheme (0:water phase concentration, 1:total concentration)
cinact (float (default is -1.0)) – concentration value that will be output at inactive nodes
ciclose (float (default is 1e-6)) – concentration tolerance for convergence of the matrix solver
idisp (int (default is 1)) – flag of dispersion (0: no dispersion, 1: isotropic, 2: anisotropic)
ixdisp (int (default is 0)) – flag of cross-dispersion (0: no cross-dispersion, 1: cross-dispersion)
diffnc (float (default is 0.57024)) – molecular diffusion coefficient
izod (int (default is 0)) – flag of zero-order decay (0: no zero-order decay, 1: in water 2: on soil, 3: on water and soil, 4: on air-water interface)
ifod (int (default is 0)) – flag of first-order decay (0: no first-order decay, 1: in water 2: on soil, 3: on water and soil, 4: on air-water interface)
ifmbc (int (default is 0)) – flag of flux mass balance errors (0: not considered, 1: computed and reported)
iheat (int (default is 0)) – flag of energy balance equation (0: not considered, 1: computed)
imcomp (int (default is 0)) – number of immobile component species simulated
idispcln (int (default is 0)) – index connection between GWF and CLN cells (0: finite difference approximation 1: Thiem solution, 2: Thiem solution with local borehole thermal resistance)
nseqitr (int (default is 0)) – an index or count for performing sequential iterations (0/1: no iterations >1: number of iterations of the transport and reaction modules)
icbund (int or array of ints (nlay, nrow, ncol)) – is the cell-by-cell flag for the transport simulation
prsity (float or array of floats (nlay, nrow, ncol), default is 0.15) – is the porosity of the porous medium
bulkd (float or array of floats (nlay, nrow, ncol), default is 157.0) – is the bulk density of the porous medium
anglex (float or array of floats (njag)) – is the angle (in radians) between the horizontal x-axis and the outward normal to the face between a node and its connecting nodes. The angle varies between zero and 6.283185 (two pi being 360 degrees).
dl (float or array of floats (nlay, nrow, ncol), default is 1.0) – longitudinal dispersivity
dt (float or array of floats (nlay, nrow, ncol), default is 0.1) – transverse dispersivity
dlx (float or array of floats (nlay-1, nrow, ncol), default is 1.0) – x-direction longitudinal dispersivity
dly (float or array of floats (nlay, nrow, ncol), default is 1.0) – y-direction longitudinal dispersivity
dlz (float or array of floats (nlay, nrow, ncol), default is 0.1) – z-direction longitudinal dispersivity
dtxy (float or array of floats (nlay, nrow, ncol), default is 0.1) – xy-direction transverse dispersivity
dtyz (float or array of floats (nlay, nrow, ncol), default is 0.1) – yz-direction transverse dispersivity
dtxz (float or array of floats (nlay, nrow, ncol), default is 0.1) – xz-direction transverse dispersivity
adsorb (float or array of floats (nlay, nrow, ncol), default is none) – adsorption coefficient of a contaminant species
flich (float or array of floats (nlay, nrow, ncol), default is none) – Freundlich adsorption isotherm exponent
zodrw (float or array of floats (nlay, nrow, ncol), default is none) – zero-order decay coefficient in water
zodrs (float or array of floats (nlay, nrow, ncol),default is none) – zero-order decay coefficient on soil
zodraw (float or array of floats (nlay, nrow, ncol), default is none) – zero-order decay coefficient on air-water interface
fodrw (float or array of floats (nlay, nrow, ncol), default is none) – first-order decay coefficient in water
fodrs (float or array of floats (nlay, nrow, ncol), default is none) – first-order decay coefficient on soil
fodraw (float or array of floats (nlay, nrow, ncol), default is none) – first-order decay coefficient on air-water interface
conc (float or array of floats (nlay, nrow, ncol), default is 0.0) – initial concentration of each contaminant species
extension (string) – mbegwunf : flow imbalance information mbegwunt : transport mass imbalance information mbeclnunf : flow imbalance information for CLN domain mbeclnunt : transport mass imbalance information for the CLN domain (default is [‘bct’,’mbegwunf’,’mbegwunt’,’mbeclnunf’,’mbeclnunt’]).
unitnumber (int) – File unit number and the output files. (default is [59, 0, 0, 0, 0, 0, 0] ).
filenames (str or list of str) – Filenames to use for the package and the output files.
add_package (bool, default is True) – Flag to add the initialised package object to the parent model object.

Notes

Examples

>>> import flopy
>>> ml = flopy.mfusg.MfUsg(exe_name='USGs_1.exe')
>>> disu = flopy.mfusg.MfUsgDisU(model=ml, nlay=1, nodes=1,
             iac=[1], njag=1,ja=np.array([0]), fahl=[1.0], cl12=[1.0])
>>> bct = flopy.mfusg.MfUsgBct(ml)

check(f=None, verbose=True, level=1, checktype=None)[source]

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.

Return type:

None

Notes

Unstructured models not checked for extreme recharge transmissivity ratios.

Examples

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

classmethod load(f, model, ext_unit_dict=None, check=False)[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.

Returns:

bct

Return type:

MfUsgBct object

Examples

>>> import flopy
>>> ml = flopy.mfusg.MfUsg()
>>> dis = flopy.modflow.ModflowDis.load('Test1.dis', ml)
>>> bct = flopy.mfusg.MfUsgBct.load('Test1.BTN', ml)

static mcomp_Util3d(model, shape, dtype, value, name, mcomp)[source]

write_file(f=None)[source]

Write the BCT package file.

Parameters:: f (open file object.) – Default is None, which will result in MfUsg.fn_path being opened for writing.