equivalent_diameter

openpnm.models.geometry.throat_size.equivalent_diameter(target, throat_area='throat.area', throat_shape='circle')[source]

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

Parameters
  • target (OpenPNM Base object) – Object with which this model is associated. This controls the length of the calculated array, and also provides access to other necessary properties.

  • thorat_area (str) – Name of the dictionary key on target where the array containing throat area values is stored

  • throat_shape (str) – 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