flopy.mf6.modflow.mfutlsfrtab module

class ModflowUtlsfrtab(model, loading_package=False, nrow=None, ncol=None, table=None, filename=None, pname=None, **kwargs)[source]

Bases: MFPackage

ModflowUtlsfrtab defines a SFRTAB package.

Parameters:

  • model – Model that this package is a part of. Package is automatically added to model when it is initialized.

  • loading_package (bool, default False) – Do not set this parameter. It is intended for debugging and internal processing purposes only.

  • nrow (integer) – integer value specifying the number of rows in the reach cross-section table. there must be nrow rows of data in the table block.

  • ncol (integer) – integer value specifying the number of columns in the reach cross-section table. there must be ncol columns of data in the table block. ncol must be equal to 2 if manfraction is not specified or 3 otherwise.

  • table ([(xfraction, height, manfraction)]) –

    • xfractiondouble precision

      real value that defines the station (x) data for the cross-section as a fraction of the width (RWID) of the reach. XFRACTION must be greater than or equal to zero but can be greater than one. XFRACTION values can be used to decrease or increase the width of a reach from the specified reach width (RWID).

    • heightdouble precision

      real value that is the height relative to the top of the lowest elevation of the streambed (RTP) and corresponding to the station data on the same line. HEIGHT must be greater than or equal to zero and at least one cross-section height must be equal to zero.

    • manfractiondouble precision

      real value that defines the Manning’s roughness coefficient data for the cross- section as a fraction of the Manning’s roughness coefficient for the reach (MAN) and corresponding to the station data on the same line. MANFRACTION must be greater than zero. MANFRACTION is applied from the XFRACTION value on the same line to the XFRACTION value on the next line. Although a MANFRACTION value is specified on the last line, any value greater than zero can be applied to MANFRACTION(NROW). MANFRACTION is only specified if NCOL is 3. If MANFRACTION is not specified, the Manning’s roughness coefficient for the reach (MAN) is applied to the entire cross-section.

filenamestr or PathLike, optional

Name or path of file where this package is stored.

pnamestr, optional

Package name.

**kwargs

Extra keywords for flopy.mf6.mfpackage.MFPackage.

dfn = [['header', 'multi-package'], ['block dimensions', 'name nrow', 'type integer', 'reader urword', 'optional false'], ['block dimensions', 'name ncol', 'type integer', 'reader urword', 'optional false'], ['block table', 'name table', 'type recarray xfraction height manfraction', 'shape (nrow)', 'reader urword'], ['block table', 'name xfraction', 'type double precision', 'shape', 'tagged false', 'in_record true', 'reader urword'], ['block table', 'name height', 'type double precision', 'shape', 'tagged false', 'in_record true', 'reader urword'], ['block table', 'name manfraction', 'type double precision', 'shape', 'tagged false', 'in_record true', 'reader urword', 'optional true']]
dfn_file_name = 'utl-sfrtab.dfn'
package_abbr = 'utlsfrtab'
table = <flopy.mf6.data.mfdatautil.ListTemplateGenerator object>