flopy.modflow.mfpval module

mfpval module. Contains the ModflowPval class. Note that the user can access the ModflowPval class as flopy.modflow.ModflowPval.

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

class ModflowPval(model, pval_dict=None, extension='pval', unitnumber=None, filenames=None)[source]

Bases: Package

MODFLOW Mult Package Class.

Parameters:

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

  • pval_dict (dict) – Dictionary with pval data for the model. pval_dict is typically instantiated using load method.

  • extension (string) – Filename extension (default is ‘pval’)

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

  • filenames (str or list of str) – Filenames to use for the package. If filenames=None the package name will be created using the model name and package extension. If a single string is passed the package will be set to the string. Default is None.

Notes

Parameters are supported in Flopy only when reading in existing models. Parameter values are converted to native values in Flopy and the connection to “parameters” is thus nonexistent.

Examples

>>> import flopy
>>> m = flopy.modflow.Modflow()
>>> pval_dict = flopy.modflow.ModflowZon(m, pval_dict=pval_dict)
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:

pval

Return type:

ModflowPval dict

Examples

>>> import flopy
>>> m = flopy.modflow.Modflow()
>>> mlt = flopy.modflow.ModflowPval.load('test.pval', m)
write_file()[source]

Write the package file.

Return type:

None

Notes

Not implemented because parameters are only supported on load