num_throats#

IonicConduction.num_throats(labels='all', mode='union')#

Return the number of throats of the specified labels

Parameters:
  • labels (list of strings, optional) – The throat labels that should be included in the count. If not supplied, all throats are counted.

  • mode (str, optional) –

    Specifies how the count should be performed. The options are:

    mode

    meaning

    ’or’

    Returns the labels that are assigned to any of the given locations. Also accepts ‘union’ and ‘any’

    ’and’

    Labels that are present on all the given locations. also accepts ‘intersection’ and ‘all’

    ’xor’

    Labels that are present on only one of the given locations.Also accepts ‘exclusive_or’

    ’nor’

    Labels that are not present on any of the given locations. Also accepts ‘not’ and ‘none’

    ’nand’

    Labels that are present on all but one of the given locations

    ’xnor’

    Labels that are present on more than one of the given locations.

Returns:

Nt – Number of throats with the specified labels

Return type:

int

See also

num_pores, count

Notes

Technically, ‘nand’ and ‘xnor’ should also count throats with none of the labels, however, to make the count more useful these are not included.