- class OhmicConduction(*args, **kwargs)¶
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.
- calc_effective_conductivity(inlets=None, outlets=None, domain_area=None, domain_length=None)¶
This calculates the effective electrical conductivity.
inlets (array_like) – The pores where the inlet voltage boundary conditions were applied. If not given an attempt is made to infer them from the algorithm.
outlets (array_like) – The pores where the outlet voltage boundary conditions were applied. If not given an attempt is made to infer them from the algorithm.
The area and length of the domain are found using the bounding box around the inlet and outlet pores which do not necessarily lie on the edge of the domain, resulting in underestimation of sizes.
- setup(phase=None, quantity='', conductance='', **kwargs)¶
This method takes several arguments that are essential to running the algorithm and adds them to the settings.
Any additional arguments are added to the
settingsdictionary of the object.