core#

Main classes of OpenPNM#

This module contains the main classes from which all other major objects derive.

The Base class#

The Base class is a dict that has added methods for indexing the pores and throats, applying labels, and managing the stored data. All OpenPNM object inherit from Base so possess these methods.

Classes

Base2

A subclassed dictionary used for storing data

Domain

The main class used for Network, Phase and Algorithm objects.

LabelMixin

r This mixin adds functionality to the Base2 class so that boolean arrays are treated as labels

ModelWrapper

This class is used to hold individual models and provide some extra functionality, such as pretty-printing and the ability to run itself.

ModelsDict

This subclassed dictionary is assigned to the models attribute of all objects that inherit from the ModelsMixin class.

ModelsMixin2

This class is added to Network and Phase objects under the models attribute.

ParserMixin