Module Expr Str ImportFrom alias alias ImportFrom alias ImportFrom alias Import alias Import alias identifier Assign NameStore Call AttributeLoad NameLoad attr NameLoad ClassDef bases AttributeLoad AttributeLoad NameLoad attr attr body Expr Str FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad ListLoad ListLoad kwarg body Expr Call AttributeLoad Call NameLoad attr NameLoad Assign AttributeStore NameLoad attr AttributeLoad NameLoad attr If CompareIs NameLoad NameLoad body Assign NameStore Call NameLoad Expr Call AttributeLoad AttributeLoad NameLoad attr attr Dict AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr Dict AttributeLoad NameLoad attr NameLoad If CompareIs NameLoad NameLoad body Assign NameStore Call NameLoad keyword AttributeLoad NameLoad attr Expr Call AttributeLoad AttributeLoad NameLoad attr attr Dict AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad AttributeLoad NameLoad attr attr Dict AttributeLoad NameLoad attr NameLoad If CompareIsNot NameLoad NameLoad body If BoolOpOr CompareGt Call AttributeLoad NameLoad attr NameLoad Num CompareGt Call AttributeLoad NameLoad attr NameLoad Num body Raise Call NameLoad Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr SubscriptLoad AttributeLoad NameLoad attr Index BinOpAdd Str AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr SubscriptLoad AttributeLoad NameLoad attr Index BinOpAdd Str AttributeLoad NameLoad attr Assign SubscriptStore SubscriptLoad AttributeLoad NameLoad attr Index Num Index BinOpAdd Str AttributeLoad NameLoad attr NameLoad Assign SubscriptStore SubscriptLoad AttributeLoad NameLoad attr Index Num Index BinOpAdd Str AttributeLoad NameLoad attr NameLoad Assign SubscriptStore AttributeLoad NameLoad attr Index BinOpAdd Str AttributeLoad NameLoad attr NameLoad Assign SubscriptStore AttributeLoad NameLoad attr Index BinOpAdd Str AttributeLoad NameLoad attr NameLoad TryExcept body Expr Call AttributeLoad NameLoad attr keyword NameLoad keyword NameLoad handlers ExceptHandler body Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Raise Call NameLoad Str decorator_list FunctionDef arguments args NameParam NameParam defaults body Assign NameStore SubscriptLoad Call AttributeLoad NameLoad attr Str Index Num If CompareEq SubscriptLoad Call AttributeLoad NameLoad attr Str Index Num AttributeLoad NameLoad attr body Assign NameStore BinOpAdd NameLoad Str If CompareIn NameLoad Call AttributeLoad NameLoad attr body Return Call AttributeLoad Call NameLoad NameLoad NameLoad attr NameLoad orelse Return SubscriptLoad SubscriptLoad SubscriptLoad AttributeLoad NameLoad attr Index Num Index NameLoad Index SubscriptLoad SubscriptLoad AttributeLoad NameLoad attr Index Num Index BinOpAdd BinOpAdd NameLoad Str AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam defaults body Assign NameStore SubscriptLoad AttributeLoad NameLoad attr Index Num Assign NameStore Call AttributeLoad NameLoad attr BinOpAdd Str AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr BinOpAdd Str AttributeLoad NameLoad attr Assign SubscriptStore NameLoad Index BinOpAdd Str AttributeLoad NameLoad attr NameLoad Assign SubscriptStore NameLoad Index BinOpAdd Str AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad AttributeLoad NameLoad attr attr Expr Call AttributeLoad AttributeLoad NameLoad attr attr Dict AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad AttributeLoad NameLoad attr attr AttributeLoad NameLoad attr Expr Call AttributeLoad AttributeLoad NameLoad attr attr Dict AttributeLoad NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Return SubscriptLoad AttributeLoad NameLoad attr Index Num decorator_list Assign NameStore Call NameLoad keyword NameLoad keyword NameLoad FunctionDef arguments args NameParam NameParam NameParam NameParam defaults ListLoad ListLoad Str body Expr Str If CompareEq NameLoad Str body For NameStore Call AttributeLoad NameLoad attr body If BoolOpOr CompareNotIn NameLoad Call AttributeLoad AttributeLoad NameLoad attr attr CompareEq SubscriptLoad SubscriptLoad AttributeLoad NameLoad attr Index NameLoad Index Str Str body Raise Call NameLoad BinOpAdd Str Str If CompareGt Call AttributeLoad NameLoad attr NameLoad Num body Expr Call AttributeLoad AttributeLoad NameLoad attr attr keyword NameLoad keyword Str keyword NameLoad If CompareGt Call AttributeLoad NameLoad attr NameLoad Num body Expr Call AttributeLoad AttributeLoad NameLoad attr attr keyword NameLoad keyword Str keyword NameLoad If CompareEq NameLoad Str body If CompareGt Call AttributeLoad NameLoad attr NameLoad Num body Expr Call AttributeLoad AttributeLoad NameLoad attr attr keyword NameLoad keyword Str keyword NameLoad If CompareIsNot NameLoad NameLoad body Expr Call AttributeLoad AttributeLoad NameLoad attr attr keyword NameLoad keyword Str keyword NameLoad Expr Call AttributeLoad AttributeLoad NameLoad attr attr decorator_list decorator_list
N/A N/A 
===============================================================================
module __Physics__: Base class for mananging pore-scale Physics properties
===============================================================================

 OpenPNM.Base logging Tools OpenPNM.Network GenericNetwork OpenPNM.Phases GenericPhase N/A OpenPNM.Physics.models N/A scipy sp N/A logger N/A N/A logging getLogger __name__ GenericPhysics N/A N/A N/A OpenPNM Base Core N/A N/A 
    Generic class to generate Physics objects

    Parameters
    ----------
    network : OpenPNM Network object
        The network to which this Physics should be attached

    phase : OpenPNM Phase object
        The Phase object to which this Physics applies

    geometry : OpenPNM Geometry object
        The Geometry object that defines the pores/throats where this Physics
        should be applied.  If this argument is supplied, then pores and
        throats cannot be specified.

    pores and/or throats : array_like
        The list of pores and throats where this physics applies. If either are
        left blank this will apply the physics nowhere.  The locations can be
        change after instantiation using ``set_locations()``.  If pores and
        throats are supplied, than a geometry cannot be specified.

    name : str, optional
        A unique string name to identify the Physics object, typically same as
        instance name but can be anything.  If left blank, and name will be
        generated that include the class name and a random string.

     __init__ N/A N/A self network phase geometry pores throats N/A None None None N/A N/A kwargs N/A N/A N/A N/A N/A super __init__ kwargs N/A N/A logger name N/A self name N/A N/A network None N/A N/A network N/A GenericNetwork N/A N/A N/A N/A self network update N/A N/A network name network N/A N/A N/A N/A N/A self _net physics update N/A N/A self name self N/A N/A phase None N/A N/A phase N/A GenericPhase network N/A self _net N/A N/A N/A N/A phase physics update N/A N/A self name self N/A N/A N/A N/A self phases update N/A N/A phase name phase N/A N/A geometry None N/A N/A N/A N/A N/A N/A sp size pores 0 N/A N/A N/A sp size throats 0 N/A N/A N/A Exception Cannot specify a Geometry AND pores or throats N/A pores N/A N/A N/A self _net toindices N/A N/A self _net N/A N/A pore. N/A geometry name N/A throats N/A N/A N/A self _net toindices N/A N/A self _net N/A N/A throat. N/A geometry name N/A N/A N/A N/A self _phases N/A 0 N/A N/A pore. N/A self name False N/A N/A N/A N/A self _phases N/A 0 N/A N/A throat. N/A self name False N/A N/A N/A self _net N/A N/A pore. N/A self name False N/A N/A N/A self _net N/A N/A throat. N/A self name False N/A N/A N/A N/A N/A self set_locations pores pores throats throats N/A N/A N/A N/A N/A N/A N/A self controller purge_object self N/A N/A Exception Provided locations are in use, instantiation cancelled N/A __getitem__ N/A N/A self key N/A N/A N/A element N/A N/A N/A key split . N/A 0 N/A N/A N/A N/A N/A key split . N/A -1 N/A self name N/A N/A key N/A element .all N/A N/A key N/A N/A self keys N/A N/A N/A N/A N/A super GenericPhysics self __getitem__ key N/A N/A N/A N/A N/A N/A self _phases N/A 0 N/A key N/A N/A N/A N/A self _phases N/A 0 N/A N/A N/A element . N/A self name N/A _set_phase N/A N/A self phase N/A N/A N/A current_phase N/A N/A self _phases N/A 0 N/A pore_label N/A N/A current_phase pop N/A pore. N/A self name N/A throat_label N/A N/A current_phase pop N/A throat. N/A self name N/A N/A phase N/A N/A pore. N/A self name pore_label N/A N/A phase N/A N/A throat. N/A self name throat_label N/A N/A N/A N/A self phases clear N/A N/A N/A N/A self phases update N/A N/A phase name phase N/A N/A N/A N/A current_phase physics pop N/A self name N/A N/A N/A N/A phase physics update N/A N/A self name self N/A _get_phase N/A N/A self N/A N/A N/A N/A N/A self _phases N/A 0 N/A N/A parent_phase N/A property fget _get_phase fset _set_phase set_locations N/A N/A self pores throats mode N/A N/A N/A add N/A N/A 
        Assign or unassign a Physics object to specified locations

        Parameters
        ----------
        pores : array_like
            The pore locations in the Network where this Physics is to apply

        throats : array_like
            The throat locations in the Network where this Physics is to apply

        mode : string
            Either 'add' (default) or 'remove' the object from the specified
            locations

        Examples
        --------
        >>> import OpenPNM

         N/A N/A mode add N/A N/A item N/A N/A self props N/A N/A N/A N/A item N/A N/A N/A self models keys N/A N/A N/A N/A self models N/A item N/A regen_mode constant N/A N/A N/A Exception N/A Constant properties found on object,  cannot increase size N/A N/A N/A N/A sp size pores 0 N/A N/A N/A N/A N/A Tools SetLocations add obj self element pore locations pores N/A N/A N/A N/A sp size throats 0 N/A N/A N/A N/A N/A Tools SetLocations add obj self element throat locations throats N/A N/A mode remove N/A N/A N/A N/A N/A sp size pores 0 N/A N/A N/A N/A N/A Tools SetLocations drop obj self element pore locations pores N/A N/A throats None N/A N/A N/A N/A N/A Tools SetLocations drop obj self element throat locations throats N/A N/A N/A N/A self models regenerate N/A N/A