Module Expr Str Import alias identifier ImportFrom alias ImportFrom alias Assign NameStore Call AttributeLoad NameLoad attr NameLoad ClassDef bases NameLoad body Expr Str FunctionDef arguments args NameParam defaults kwarg body Expr Call AttributeLoad Call NameLoad attr NameLoad Expr Call AttributeLoad NameLoad attr BinOpAdd BinOpAdd Str AttributeLoad AttributeLoad NameLoad attr attr Str decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults Str Str NameLoad kwarg body Expr Str Expr Call AttributeLoad NameLoad attr BinOpAdd Str AttributeLoad AttributeLoad NameLoad attr attr Expr Call AttributeLoad Call NameLoad attr keyword NameLoad keyword NameLoad keyword NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Str Return Call AttributeLoad NameLoad attr decorator_list decorator_list
N/A N/A 
===============================================================================
module __OhmicConduction__: Electronic or ionic conduction
===============================================================================

 N/A scipy sp OpenPNM.Algorithms GenericLinearTransport OpenPNM.Base logging N/A logger N/A N/A logging getLogger __name__ OhmicConduction N/A GenericLinearTransport N/A N/A 
    A subclass of GenericLinearTransport to simulate electron and ionic
    conduction.  The 2 main roles of this subclass are to set the default
    property names and to implement a method for calculating the effective
    conductivity of the network.

    Examples
    --------
    >>> import OpenPNM
    >>> pn = OpenPNM.Network.TestNet()
    >>> geo = OpenPNM.Geometry.TestGeometry(network=pn, pores=pn.pores(),
    ...                                     throats=pn.throats())
    >>> phase1 = OpenPNM.Phases.TestPhase(network=pn)
    >>> phys1 = OpenPNM.Physics.TestPhysics(network=pn, phase=phase1,
    ...                                     pores=pn.pores(), throats=pn.throats())
    >>> phys1['throat.electrical_conductance'] = 1
    >>> alg = OpenPNM.Algorithms.OhmicConduction(network=pn, phase=phase1)
    >>> BC1_pores = pn.pores('top')
    >>> alg.set_boundary_conditions(bctype='Dirichlet', bcvalue=0.6, pores=BC1_pores)
    >>> BC2_pores = pn.pores('bottom')
    >>> alg.set_boundary_conditions(bctype='Dirichlet', bcvalue=0.4, pores=BC2_pores)
    >>> alg.run()
    >>> alg.return_results()
    >>> Ceff = round(alg.calc_effective_conductivity(), 3)
    >>> print(Ceff)
    1.012

     __init__ N/A N/A self N/A kwargs N/A N/A N/A N/A N/A super __init__ kwargs N/A N/A N/A logger info N/A N/A Create  N/A N/A self __class__ __name__  Object N/A setup N/A N/A self conductance quantity super_pore_conductance N/A electrical_conductance voltage None params N/A N/A 
        This setup provides the initial requirements for the solver setup.
         N/A N/A N/A logger info N/A Setup  N/A N/A self __class__ __name__ N/A N/A N/A N/A super setup conductance conductance quantity quantity super_pore_conductance super_pore_conductance N/A calc_effective_conductivity N/A N/A self N/A N/A N/A 
        This calculates the effective electrical conductivity in this linear
        transport algorithm.
         N/A N/A N/A self _calc_eff_prop N/A N/A