Base2#

class Base2(*args, **kwargs)[source]#

A subclassed dictionary used for storing data

Parameters:

network (dict) – An OpenPNM Network object, which is a subclass of a dict

Attributes:
Np

Shortcut to retrieve the number of pores in the domain

Nt

Shortcut to retrieve the number of throats in the domain

Ps

Shortcut to retrieve the indices of all pores

Ts

Shortcut to retrieve the indices of all throats

name
network

Shortcut to retrieve a handle to the network object associated with the

params

This attribute stores ‘scalar’ data that can be used by pore-scale models.

project
settings

Methods

get_conduit_data(propname)

Fetches an Nt-by-3 array of the requested property

interpolate_data(propname[, mode])

Generates an array of the requested pore/throat data by interpolating the neighboring throat/pore data.

props([element])

Retrieves a list of keys that contain numerical data (i.e. "properties").

to_indices(mask)

Converts a boolean mask to pore or throat indices

to_mask([pores, throats])

Generates a boolean mask with True values in the given locations