- class openpnm.core.Subdomain(*args, **kwargs)¶
This subclass of the Base class provides the ability assign the object to specific locations (pores and throats) in the domain. This class is subclassed by GenericGeometry and GenericPhysics.
The Project object has two methods,
check_physics_healththat look to make sure all locations are assigned to one and only one Geometry and/or Physics.
A shortcut to query the total number of pores on the object
A shortcut to query the total number of throats on the object
A shortcut to get a list of all pores on the object
A shortcut to get a list of all throats on the object
String representing the name of the object
A shortcut to get a handle to the associated network.
A shortcut to get a handle to the associated project.
Dictionary containing object settings.
filter_by_label([pores, throats, labels, mode])
Returns which of the supplied pores (or throats) has the specified label(s)
get_conduit_data(poreprop[, throatprop, mode])
Combines requested data into a single 3-column array.
Retrieves requested property from associated objects, to produce a full Np or Nt length array.
Determines a pore (or throat) property as the average of it's neighboring throats (or pores)
labels([pores, throats, element, mode])
Returns a list of labels present on the object
Returns the number of pores of the specified labels
Return the number of throats of the specified labels
pores([labels, mode, asmask, to_global])
Returns pore indicies where given labels exist, according to the logic specified by the
props([element, mode, deep])
Returns a list containing the names of all defined pore or throat properties.
set_label(label[, pores, throats, mode])
Creates or updates a label array
set_locations([pores, throats, mode])
Assign a Subdomain object to specific pores and/or throats
show_hist([props, bins, fontsize])
Shows a quick plot of key property distributions.
throats([labels, mode, asmask, to_global])
Returns throat locations where given labels exist, according to the logic specified by the
Convert local indices from a subdomain object to global values
Converts a boolean mask to a list of pore or throat indices.
to_local([pores, throats, missing_vals])
Convert global indices to local values relative to a subdomain object
Convert a list of pore or throat indices into a boolean mask of the correct length.