Module Expr Str Import alias Import alias identifier ImportFrom alias ImportFrom alias ImportFrom alias identifier ImportFrom alias ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam NameParam defaults Num Num Num NameLoad Num NameLoad NameLoad Str Num body Expr Call AttributeLoad NameLoad attr NameLoad NameLoad NameLoad Str NameLoad Assign AttributeStore NameLoad attr Str Assign AttributeStore NameLoad attr Str Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr NameLoad Assign AttributeStore NameLoad attr Num If CompareIs NameLoad NameLoad body Assign NameStore ListLoad If AttributeLoad NameLoad attr body Expr Call AttributeLoad NameLoad attr Str Assign AttributeStore NameLoad attr NameLoad Assign NameStore ListLoad Assign NameStore Num While CompareLt NameLoad Call NameLoad NameLoad body Print TupleLoad NameLoad SubscriptLoad NameLoad Index NameLoad If CompareIn Str Call AttributeLoad SubscriptLoad NameLoad Index NameLoad attr body Expr Call AttributeLoad NameLoad attr Call AttributeLoad SubscriptLoad NameLoad Index BinOpAdd NameLoad Num attr AugAssignAdd NameStore Num AugAssignAdd NameStore Num If CompareIs NameLoad NameLoad body Raise Call NameLoad Str Assign AttributeStore NameLoad attr Call NameLoad NameLoad Assign AttributeStore NameLoad attr Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr For TupleStore NameStore NameStore Call NameLoad NameLoad body Assign SubscriptStore AttributeLoad NameLoad attr Index NameLoad Call NameLoad NameLoad Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam defaults body Expr Str Assign NameStore Call NameLoad AttributeLoad NameLoad attr Str Expr Call AttributeLoad NameLoad attr Call AttributeLoad Str attr AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr Call AttributeLoad Str attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr For NameStore AttributeLoad NameLoad attr body Expr Call AttributeLoad NameLoad attr Call AttributeLoad Str attr NameLoad Expr Call AttributeLoad NameLoad attr Str For NameStore AttributeLoad NameLoad attr body Expr Call AttributeLoad NameLoad attr Call AttributeLoad Str attr BinOpAdd SubscriptLoad NameLoad Index Num Num BinOpAdd SubscriptLoad NameLoad Index Num Num BinOpAdd SubscriptLoad NameLoad Index Num Num BinOpAdd SubscriptLoad NameLoad Index Num Num BinOpAdd SubscriptLoad NameLoad Index Num Num SubscriptLoad NameLoad Index Num Expr Call AttributeLoad NameLoad attr Call AttributeLoad Str attr AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults Num NameLoad NameLoad body Expr Str Assign NameStore Call AttributeLoad NameLoad attr keyword NameLoad If CompareIsNot NameLoad NameLoad body Assign NameStore Call AttributeLoad NameLoad attr NameLoad NameLoad AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr TupleLoad NameLoad Call NameLoad NameLoad keyword NameLoad Assign SubscriptStore NameLoad ExtSlice Slice Slice Num Return Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr Call AttributeLoad NameLoad attr keyword NameLoad decorator_list NameLoad FunctionDef arguments args NameParam defaults NameLoad body Expr Str If NameLoad body Assign NameStore Call AttributeLoad NameLoad attr ListLoad TupleLoad Str AttributeLoad NameLoad attr TupleLoad Str AttributeLoad NameLoad attr TupleLoad Str AttributeLoad NameLoad attr TupleLoad Str AttributeLoad NameLoad attr TupleLoad Str AttributeLoad NameLoad attr TupleLoad Str AttributeLoad NameLoad attr orelse Assert UnaryOpNot NameLoad Str Return NameLoad decorator_list NameLoad FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad body Expr Str If AttributeLoad NameLoad attr body Expr Call AttributeLoad AttributeLoad NameLoad attr attr Str If UnaryOpNot Call NameLoad NameLoad Str body Assign NameStore NameLoad Assign NameStore Call NameLoad NameLoad Str While NameLoad body Assign NameStore Call AttributeLoad NameLoad attr If CompareNotEq SubscriptLoad NameLoad Index Num Str body Break Assign NameStore Call AttributeLoad Call AttributeLoad NameLoad attr attr Assign NameStore Call NameLoad SubscriptLoad NameLoad Index Num Assign NameStore Call NameLoad SubscriptLoad NameLoad Index Num Assign NameStore Call NameLoad SubscriptLoad NameLoad Index Num Assign NameStore ListLoad Assign NameStore ListLoad If CompareGt Call NameLoad NameLoad Num body Assign NameStore Num While CompareLt NameLoad Call NameLoad NameLoad body Assign NameStore SubscriptLoad NameLoad Index NameLoad If CompareIs Call AttributeLoad NameLoad attr Str body Expr Call AttributeLoad NameLoad attr NameLoad orelse If CompareIn Str Call AttributeLoad NameLoad attr body Expr Call AttributeLoad NameLoad attr Call AttributeLoad Str attr SubscriptLoad NameLoad Slice NameLoad BinOpAdd NameLoad Num Expr Call AttributeLoad NameLoad attr Call AttributeLoad SubscriptLoad NameLoad Index BinOpAdd NameLoad Num attr AugAssignAdd NameStore Num AugAssignAdd NameStore Num If CompareGt NameLoad Num body Assign NameStore AttributeLoad Call AttributeLoad NameLoad attr Num attr Assign NameStore Call AttributeLoad NameLoad attr NameLoad NameLoad NameLoad AttributeLoad NameLoad attr Assign NameStore NameLoad If CompareGt NameLoad Num body Assign NameStore Call AttributeLoad NameLoad attr NameLoad For NameStore Call NameLoad NameLoad body Assign NameStore Call AttributeLoad NameLoad attr If CompareIn Str Call AttributeLoad NameLoad attr body Raise Call NameLoad Str Assign NameStore Call AttributeLoad Call AttributeLoad NameLoad attr attr Assign SubscriptStore NameLoad Index NameLoad Call NameLoad SubscriptLoad NameLoad Slice Call NameLoad AttributeLoad AttributeLoad NameLoad attr attr AugAssignSub SubscriptStore NameLoad Index Str Num AugAssignSub SubscriptStore NameLoad Index Str Num AugAssignSub SubscriptStore NameLoad Index Str Num AugAssignSub SubscriptStore NameLoad Index Str Num AugAssignSub SubscriptStore NameLoad Index Str Num Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad If CompareGt NameLoad Num body Assign NameStore ListLoad Str Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad Call AttributeLoad NameLoad attr attr Assign NameStore Call NameLoad SubscriptLoad NameLoad Index Num For NameStore Call NameLoad NameLoad body Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad Call AttributeLoad NameLoad attr attr Assign NameStore Call AttributeLoad SubscriptLoad NameLoad Index Num attr Assign NameStore Str Assign TupleStore NameStore NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore SubscriptLoad NameLoad Index NameLoad Assign NameStore Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Str If CompareIs AttributeLoad AttributeLoad NameLoad attr attr NameLoad body Assign NameStore Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Str orelse TryExcept body Assign NameStore Call AttributeLoad NameLoad attr SubscriptLoad AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr Index NameLoad handlers ExceptHandler body Assign NameStore Call AttributeLoad NameLoad attr SubscriptLoad NameLoad Index Str For TupleStore NameStore NameStore Call NameLoad NameLoad body Assign SubscriptStore NameLoad Index NameLoad Call NameLoad SubscriptLoad NameLoad Slice Call NameLoad AttributeLoad AttributeLoad NameLoad attr attr AugAssignSub SubscriptStore NameLoad Index Str Num AugAssignSub SubscriptStore NameLoad Index Str Num AugAssignSub SubscriptStore NameLoad Index Str Num AugAssignSub SubscriptStore NameLoad Index Str Num AugAssignSub SubscriptStore NameLoad Index Str Num For NameStore NameLoad body AugAssignMult SubscriptStore NameLoad Index NameLoad NameLoad If CompareIs NameLoad NameLoad body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad orelse Assign NameStore Call NameLoad TupleLoad NameLoad NameLoad keyword NameLoad keyword NameLoad Assign NameStore Call NameLoad NameLoad keyword Num keyword Num keyword Call NameLoad NameLoad keyword NameLoad keyword Num keyword NameLoad Return NameLoad decorator_list NameLoad decorator_list
N/A N/A 
mfhfb module.  Contains the ModflowHfb class. Note that the user can access
the ModflowHfb class as `flopy.modflow.ModflowHfb`.

Additional information for this MODFLOW package can be found at the `Online
MODFLOW Guide
<http://water.usgs.gov/ogw/modflow/MODFLOW-2005-Guide/index.html?hfb6.htm>`_.

 N/A sys N/A numpy np pakbase Package numpy atleast_2d flopy.modflow.mfparbc ModflowParBc mfparbc numpy.lib.recfunctions stack_arrays ModflowHfb N/A Package N/A N/A 
    MODFLOW HFB6 - Horizontal Flow Barrier Package
    
    Parameters
    ----------
    model : model object
        The model object (of type: class:`flopy.modflow.mf.Modflow`) to 
        which this package will be added.
    nphfb : int
        Number of horizontal-flow barrier parameters. Note that for an HFB 
        parameter to have an effect in the simulation, it must be defined 
        and made active using NACTHFB to have an effect in the simulation 
        (default is 0).
    mxfb : int
        Maximum number of horizontal-flow barrier barriers that will be 
        defined using parameters (default is 0).
    nhfbnp: int
        Number of horizontal-flow barriers not defined by parameters. This 
        is calculated automatically by FloPy based on the information in
        layer_row_column_data (default is 0).
    hfb_data : list of records

        In its most general form, this is a list of horizontal-flow
        barrier records. A barrier is conceptualized as being located on 
        the boundary between two adjacent finite difference cells in the 
        same layer. The innermost list is the layer, row1, column1, row2, 
        column2, and hydrologic characteristics for a single hfb between
        the cells. The hydraulic characteristic is the barrier hydraulic 
        conductivity divided by the width of the horizontal-flow barrier.
        (default is None).
        This gives the form of::

            hfb_data = [
                        [lay, row1, col1, row2, col2, hydchr],
                        [lay, row1, col1, row2, col2, hydchr],
                        [lay, row1, col1, row2, col2, hydchr],
                       ].

    nacthfb : int
        The number of active horizontal-flow barrier parameters 
        (default is 0).
    no_print : boolean
        When True or 1, a list of horizontal flow barriers will not be 
        written to the Listing File (default is False)
    options : list of strings
        Package options (default is None).
    extension : string
        Filename extension (default is 'hfb').
    unitnumber : int
        File unit number (default is 17).


    Attributes
    ----------

    Methods
    -------

    See Also
    --------

    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()
    >>> hfb_data = [[0, 10, 4, 10, 5, 0.01],[1, 10, 4, 10, 5, 0.01]]
    >>> hfb = flopy.modflow.ModflowHfb(m, hfb_data=hfb_data)

     __init__ N/A N/A self model nphfb mxfb nhfbnp hfb_data nacthfb no_print options extension unitnumber N/A 0 0 0 None 0 False None hfb 29 N/A N/A N/A N/A Package __init__ self model extension HFB6 unitnumber N/A N/A self heading # HFB for MODFLOW, generated by Flopy. N/A N/A self url hfb6.htm N/A N/A self nphfb nphfb N/A N/A self mxfb mxfb N/A N/A self nacthfb nacthfb N/A N/A self no_print no_print N/A N/A self np 0 N/A N/A options None N/A N/A options N/A N/A N/A self no_print N/A N/A N/A N/A options append NOPRINT N/A N/A self options options N/A aux_names N/A N/A it 0 N/A N/A it N/A len options N/A N/A N/A it N/A options N/A it N/A N/A aux N/A N/A N/A options N/A it lower N/A N/A N/A N/A aux_names append N/A N/A N/A options N/A N/A it 1 lower N/A it 1 N/A it 1 N/A N/A hfb_data None N/A N/A N/A Exception Failed to specify hfb_data. N/A N/A self nhfbnp N/A len hfb_data N/A N/A self hfb_data N/A N/A ModflowHfb get_empty N/A self nhfbnp N/A N/A ibnd t N/A enumerate hfb_data N/A N/A N/A N/A self hfb_data N/A ibnd N/A tuple t N/A N/A N/A N/A self parent add_package self N/A ncells N/A N/A self N/A N/A N/A 
        Returns the maximum number of cell pairs that have horizontal
        flow barriers (developed for MT3DMS SSM package)

         N/A N/A self nhfbnp N/A write_file N/A N/A self N/A N/A N/A 
        Write the package file.

        Returns
        -------
        None

         N/A f_hfb N/A open N/A self fn_path w N/A N/A N/A f_hfb write N/A N/A {}
 format N/A self heading N/A N/A N/A f_hfb write N/A N/A {:10d}{:10d}{:10d} format N/A self nphfb N/A self mxfb N/A self nhfbnp N/A option N/A self options N/A N/A N/A N/A f_hfb write N/A N/A   {} format option N/A N/A N/A f_hfb write N/A a N/A self hfb_data N/A N/A N/A N/A f_hfb write N/A N/A {:10d}{:10d}{:10d}{:10d}{:10d}{:13.6g}
 format N/A N/A a N/A 0 1 N/A N/A a N/A 1 1 N/A N/A a N/A 2 1 N/A N/A a N/A 3 1 N/A N/A a N/A 4 1 N/A a N/A 5 N/A N/A N/A f_hfb write N/A N/A {:10d} format N/A self nacthfb N/A N/A N/A f_hfb close N/A get_empty N/A N/A ncells aux_names structured N/A 0 None True N/A N/A 
        Get an empty recarray that correponds to hfb dtype and has
        been extended to include aux variables and associated
        aux names.

         N/A dtype N/A N/A ModflowHfb get_default_dtype structured structured N/A N/A aux_names None N/A N/A dtype N/A N/A Package add_to_dtype dtype aux_names N/A np float32 N/A d N/A N/A np zeros N/A ncells N/A len dtype dtype dtype N/A N/A d N/A N/A N/A -10000000000.0 N/A N/A N/A N/A N/A np core records fromarrays N/A N/A d transpose dtype dtype N/A staticmethod get_default_dtype N/A N/A structured N/A True N/A N/A 
        Get the default dtype for hfb data

         N/A structured N/A N/A dtype N/A N/A np dtype N/A N/A k N/A np int N/A irow1 N/A np int N/A icol1 N/A np int N/A irow2 N/A np int N/A icol2 N/A np int N/A hydchr N/A np float32 N/A N/A N/A structured is there an unstructured HFB??? N/A dtype N/A staticmethod load N/A N/A f model ext_unit_dict N/A None N/A N/A 
        Load an existing package.

        Parameters
        ----------
        f : filename or file handle
            File to load.
        model : model object
            The model object (of type: class:`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
            :class:`flopy.utils.mfreadnam.parsenamefile`.

        Returns
        -------
        hfb : ModflowHfb object
            ModflowHfb object (of type :class:`flopy.modflow.mfbas.ModflowHfb`)

        Examples
        --------

        >>> import flopy
        >>> m = flopy.modflow.Modflow()
        >>> hfb = flopy.modflow.ModflowHfb.load('test.hfb', m)

         N/A N/A model verbose N/A N/A N/A N/A N/A sys stdout write loading hfb6 package file...
 N/A N/A N/A hasattr f read N/A N/A filename f N/A f N/A open filename r N/A True N/A N/A line N/A N/A f readline N/A N/A N/A line N/A 0 # N/A N/A N/A t N/A N/A N/A N/A line strip split N/A nphfb N/A int N/A t N/A 0 N/A mxfb N/A int N/A t N/A 1 N/A nhfbnp N/A int N/A t N/A 2 N/A options N/A N/A aux_names N/A N/A N/A N/A len t 2 N/A N/A it 2 N/A N/A it N/A len t N/A N/A toption N/A t N/A it N/A N/A N/A N/A toption lower noprint N/A N/A N/A N/A options append toption N/A N/A N/A aux N/A N/A toption lower N/A N/A N/A N/A options append N/A N/A join N/A t N/A it N/A it 2 N/A N/A N/A aux_names append N/A N/A N/A t N/A N/A it 1 lower N/A it 1 N/A it 1 N/A N/A nphfb 0 N/A N/A dt N/A N/A N/A ModflowHfb get_empty 1 dtype N/A pak_parms N/A N/A mfparbc load f nphfb dt N/A model verbose N/A bnd_output None N/A N/A nhfbnp 0 N/A N/A specified N/A N/A ModflowHfb get_empty nhfbnp N/A ibnd N/A range nhfbnp N/A N/A line N/A N/A f readline N/A N/A open/close N/A N/A line lower N/A N/A N/A NotImplementedError load() method does not support 'open/close' N/A t N/A N/A N/A N/A line strip split N/A N/A specified N/A ibnd N/A tuple N/A t N/A N/A len N/A N/A specified dtype names N/A N/A specified N/A k 1 N/A N/A specified N/A irow1 1 N/A N/A specified N/A icol1 1 N/A N/A specified N/A irow2 1 N/A N/A specified N/A icol2 1 N/A bnd_output N/A N/A N/A np recarray copy specified N/A N/A nphfb 0 N/A N/A partype N/A hydchr N/A line N/A N/A f readline N/A t N/A N/A N/A N/A line strip split N/A nacthfb N/A int N/A t N/A 0 N/A iparm N/A range nacthfb N/A N/A line N/A N/A f readline N/A t N/A N/A N/A N/A line strip split N/A pname N/A N/A N/A t N/A 0 lower N/A iname static N/A N/A par_dict current_dict N/A N/A pak_parms get pname N/A data_dict N/A current_dict N/A iname N/A par_current N/A N/A ModflowHfb get_empty N/A par_dict N/A nlst N/A N/A N/A N/A model mfpar pval None N/A N/A parval N/A N/A np float N/A par_dict N/A parval N/A N/A N/A N/A parval N/A N/A np float N/A N/A N/A N/A model mfpar pval pval_dict N/A pname N/A N/A N/A N/A parval N/A N/A np float N/A par_dict N/A parval N/A N/A ibnd t N/A enumerate data_dict N/A N/A N/A par_current N/A ibnd N/A tuple N/A t N/A N/A len N/A N/A par_current dtype names N/A N/A par_current N/A k 1 N/A N/A par_current N/A irow1 1 N/A N/A par_current N/A icol1 1 N/A N/A par_current N/A irow2 1 N/A N/A par_current N/A icol2 1 N/A ptype partype N/A N/A N/A par_current N/A ptype parval N/A N/A bnd_output None N/A N/A bnd_output N/A N/A N/A np recarray copy par_current N/A N/A bnd_output N/A stack_arrays N/A bnd_output par_current asrecarray True usemask False N/A hfb N/A ModflowHfb model nphfb 0 mxfb 0 nhfbnp N/A len bnd_output hfb_data bnd_output nacthfb 0 options options N/A hfb N/A staticmethod N/A