flopy.mfusg.mfusgdpf module

Mfusgdpf module.

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

class MfUsgDpf(model, ipakcb=0, idpfhd=0, idpfdd=0, iboundim=0, hnewim=0.0, phif=0.0, ddftr=0.0, sc1im=0.0, sc2im=0.0, extension='dpf', unitnumber=None, filenames=None, add_package=True)[source]

Bases: Package

Dual Porosity Flow (dpf) 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.

  • idpfhd (int, (default is 0)) – a flag and a unit number >0 for immobile domain heads.

  • idpfdd (int, (default is 0)) – a flag and a unit number >0 for immobile domain drawdown.

  • iuzontabim (int or array of ints, (default is 0)) – soil type index for all groundwater flow nodes in the immobile domain

  • iboundim (int, (default is 0)) – boundary variable for the immobile domain (<0 constant head, =0 no flow)

  • hnewim (float or array of floats) – initial (starting) head in the immobile domain

  • phif (float or array of floats) – porosity of the mobile domain.

  • ddftr (float or array of floats) – dual domain flow transfer rate

  • sc1im (float or array of floats) – specific storage of the immobile domain

  • sc2im (float or array of floats) – specific yield or porosity of the immobile domain

  • alphaim (float or array of floats) – van Genuchten alpha coefficient of the immobile domain

  • betaim (float or array of floats) – van Genuchten beta coefficient of the immobile domain

  • srim (float or array of floats) – van Genuchten sr coefficient of the immobile domain

  • brookim (float or array of floats) – Brooks-Corey exponent for the relative permeability of the immobile domain

  • bpim (float or array of floats) – Bubble point or air entry pressure head of the immobile domain

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

  • unitnumber (int, default is 57.) – 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])
>>> dpf = flopy.mfusg.MfUsgdpf(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:

dpf

Return type:

MfUsgdpf object

Examples

>>> import flopy
>>> ml = flopy.mfusg.MfUsg()
>>> dis = flopy.modflow.ModflowDis.load('Test1.dis', ml)
>>> dpf = flopy.mfusg.MfUsgdpf.load('Test1.BTN', ml)
write_file(f=None)[source]

Write the dpf package file.

Parameters:

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