- SpeciesByName.props(element=None, mode='all', deep=False)#
Returns a list containing the names of all defined pore or throat properties.
element (str, optional) – Can be either ‘pore’ or ‘throat’ to specify what properties are returned. If no element is given, both are returned
mode (str, optional) –
Controls what type of properties are returned. Options are:
Returns all properties on the object (default)
Returns only properties that are associated with a model
returns data values that were not generated by a model, but manaully created.
deep (bool) – If set to
Truethen the props on all associated subdomain objects are returned as well.
An alphabetically sorted list containing the string name of all
pore or throat properties currently defined. This list is an
iterable, so is useful for scanning through properties.
>>> import openpnm as op >>> pn = op.network.Cubic(shape=[3, 3, 3]) >>> pn.props('pore') ['pore.coords'] >>> pn.props('throat') ['throat.conns'] >>> pn.props() ['pore.coords', 'throat.conns']