GenericAlgorithm¶
- class openpnm.algorithms.GenericAlgorithm(*args, **kwargs)[source]¶
Generic class to define the foundation of Algorithms
- Parameters
network (GenericNetwork) – The network object to which this algorithm will apply.
name (str, optional) – Name of the algorithm
- Attributes
Np
A shortcut to query the total number of pores on the object
Nt
A shortcut to query the total number of throats on the object
Ps
A shortcut to get a list of all pores on the object
Ts
A shortcut to get a list of all throats on the object
name
String representing the name of the object
network
A shortcut to get a handle to the associated network.
project
A shortcut to get a handle to the associated project.
settings
Dictionary containing object settings.
Methods
get_conduit_data
(poreprop[, throatprop, mode])Combines requested data into a single 3-column array.
interleave_data
(prop)Retrieves requested property from associated objects, to produce a full Np or Nt length array.
interpolate_data
(propname[, mode])Determines a pore (or throat) property as the average of it's neighboring throats (or pores)
map_pores
(pores, origin[, filtered])Given a list of pore on a target object, finds indices of those pores on the calling object
map_throats
(throats, origin[, filtered])Given a list of throats on a target object, finds indices of those throats on the calling object
props
([element, mode, deep])Returns a list containing the names of all defined pore or throat properties.
show_hist
([props, bins, fontsize])Shows a quick plot of key property distributions.
to_indices
(mask)Converts a boolean mask to a list of pore or throat indices.
to_mask
([pores, throats])Convert a list of pore or throat indices into a boolean mask of the correct length.
toindices
(*args, **kwargs)Brief explanation of tomask
tomask
(*args, **kwargs)Brief explanation of tomask
reset
results