equivalent_diameter#

equivalent_diameter(network, throat_area='throat.cross_sectional_area', throat_shape='circle')[source]#

Calculates the diameter of a cirlce or edge-length of a sqaure with same area as the throat.

Parameters:

network (OpenPNM Network object) –

throat_areastr

Name of the dictionary key on network containing the ndarray of throat surface values.

throat_shapestr

The shape cross-sectional shape of the throat to assume when back-calculating from the area. Options are ‘circle’ (default) or ‘square’.

Returns:

diameters – A numpy ndarray containing throat diameter values

Return type:

ndarray