StokesFlow¶
- class StokesFlow(*args, **kwargs)[source]¶
Bases:
openpnm.algorithms.ReactiveTransport.ReactiveTransport
A subclass of GenericLinearTransport to simulate viscous flow.
- calc_effective_permeability(inlets=None, outlets=None, domain_area=None, domain_length=None)[source]¶
This calculates the effective permeability in this linear transport algorithm.
- Parameters
inlets (array_like) – The pores where the inlet pressure 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 pressure boundary conditions were applied. If not given an attempt is made to infer them from the algorithm.
domain_area (scalar, optional) – The area of the inlet (and outlet) boundary faces. If not given then an attempt is made to estimate it, but it is usually underestimated.
domain_length (scalar, optional) – The length of the domain between the inlet and outlet boundary faces. If not given then an attempt is made to estimate it, but it is usually underestimated.
Notes
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)[source]¶
This method takes several arguments that are essential to running the algorithm and adds them to the settings.
- Parameters
%(StokesFlowSettings.parameters)s –
Notes
Any additional arguments are added to the
settings
dictionary of the object.