label_phases#

label_phases(network, alias={1: 'void', 2: 'solid'})[source]#

Create pore and throat labels based on ‘pore.phase’ values

Parameters:

  • network (dict) – The network stored as a dictionary as returned from the regions_to_network function

  • alias (dict) – A mapping between integer values in ‘pore.phase’ and string labels. The default is {1: 'void', 2: 'solid'} which will result in the labels 'pore.void' and 'pore.solid', as well as 'throat.solid_void', 'throat.solid_solid', and 'throat.void_void'. The reverse labels are also added for convenience like throat.void_solid.

Returns:

network – The same network as passed in but with new boolean arrays added for the phase labels.

Return type:

dict

Examples

Click here to view online example.