flopy.mfusg.mfusgdpt module

Mfusgdpt module.

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

class MfUsgDpt(model, ipakcb=0, idptcon=0, icbndimflg=1, iadsorbim=0, idispim=0, izodim=0, ifodim=0, frahk=False, mobilesat=False, inputsat=False, icbundim=1, phif=0.4, prsityim=0.4, bulkdim=1.6, dlim=0.5, ddtr=0.5, sim=0.5, htcapsim=0.0, htcondsim=0.0, adsorbim=0.0, flichim=0.0, zodrwim=0.0, zodrsim=0.0, fodrwim=0.0, fodrsim=0.0, concim=0.0, extension='dpt', unitnumber=None, filenames=None, add_package=True)[source]

Bases: Package

Dual Porosity Transport (dpt) 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.

  • ipakcb (int (0,1,-1), (default is 0)) – a flag and a unit number >0 for cell-by-cell mass flux terms.

  • idptcon (int (0,1), (default is 0)) – a flag and a unit number >0 for immobile domain concentrations

  • icbndimflg (int (0,1), (default is 1)) – a flag active domain for the immobile (matrix) domain the same as that for the mobile (fracture) domain

  • iadsorbim (int (0,1,2,3), (default is 0)) – a flag for adsorption in the immobile domain(0: no adsorption, 1: linear isotherm, 2: Freundlich isotherm, 3: Langmuir isotherm)

  • idispim (int (0,1), (default is 0)) – a flag for dispersion in the immobile domain (0: no dispersion, 1: dispersion)

  • izodim (int (0,1), (default is 0)) – a flag for zero-order decay in the immobile domain (0: no zero-order decay, 1: in water, 2: on soil, 3: on water and soil,4: on air-water interface)

  • ifodim (int (0,1), (default is 0)) – a flag for first-order decay in the immobile domain (0: no first-order decay 1: in water, 2: on soil, 3: on water and soil,4: on air-water interface)

  • frahk (bool, (default is False)) – a flag for fractional hydraulic conductivity in the immobile domain

  • mobilesat (bool, (default is False)) – immobile domain saturation equal to initial mobile domain saturation

  • inputsat (bool, (default is False)) – a flag of immobile domain saturation input

  • icbundim (int or array of ints (nlay, nrow, ncol)) – is cell-by-cell flag for transport simulation in immobile domain

  • phif (float or array of floats (nlay, nrow, ncol)) – fraction of the total space that is occupied by the mobile domain

  • prsityim (float or array of floats (nlay, nrow, ncol)) – effective transport porosity in the immobile domain

  • bulkdim (float or array of floats (nlay, nrow, ncol)) – bulk density in the immobile domain

  • dlim (float or array of floats (nlay, nrow, ncol)) – longitudinal dispersivity coefficient between mobile and immobile domains

  • ddtr (float or array of floats (nlay, nrow, ncol)) – mass transfer coefficient between mobile and immobile domains

  • sim (float or array of floats (nlay, nrow, ncol)) – saturation in the immobile domain

  • htcapsim (float or array of floats (nlay, nrow, ncol)) – heat capacity in the immobile domain

  • htcondsim (float or array of floats (nlay, nrow, ncol)) – heat conductivity in the immobile domain

  • adsorbim (float or array of floats (nlay, nrow, ncol)) – adsorption coefficient in the immobile domain

  • flichim (float or array of floats (nlay, nrow, ncol)) – Freundlich coefficient in the immobile domain

  • zodrwim (float or array of floats (nlay, nrow, ncol)) – zero-order decay rate in water in the immobile domain

  • zodrsim (float or array of floats (nlay, nrow, ncol)) – zero-order decay rate on soil in the immobile domain

  • fodrwim (float or array of floats (nlay, nrow, ncol)) – first-order decay rate in water in the immobile domain

  • fodrsim (float or array of floats (nlay, nrow, ncol)) – first-order decay rate on soil in the immobile domain

  • concim (float or array of floats (nlay, nrow, ncol)) – initial concentration in the immobile domain

  • extension (string, (default is 'dpt').) –

  • unitnumber (int, default is 58.) – File unit number.

  • 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()
>>> disu = flopy.mfusg.MfUsgDisU(model=ml, nlay=1, nodes=1,
             iac=[1], njag=1,ja=np.array([0]), fahl=[1.0], cl12=[1.0])
>>> dpt = flopy.mfusg.MfUsgdpt(ml)
classmethod load(f, model, ext_unit_dict=None)[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:

dpt

Return type:

MfUsgdpt object

Examples

>>> import flopy
>>> ml = flopy.mfusg.MfUsg()
>>> dis = flopy.mfusg.MfUsgDisU.load('SeqDegEg.dis', ml)
>>> dpt = flopy.mfusg.MfUsgdpt.load('SeqDegEg.dpt', ml)
write_file(f=None)[source]

Write the dpt package file.

Parameters:

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

Examples