Module Reference

OpenPNM is a package for performing pore network simulations of transport in porous materials.

OpenPNM consists of several key modules. Each module is consisted of several classes and each class is consisted of a few methods. Here, you’ll find a comprehensive documentation of the modules, classes, and finally the methods, occasionally with basic embedded examples on how to use them.

openpnm.utils

Utilities and helper classes/functions

openpnm.core

Main classes of OpenPNM

openpnm.network

Object model for storing topological information of the network

openpnm.geometry

Object model for storing geometrical information of the network

openpnm.phases

Object model for storing intrinsic thermophysical properties

openpnm.physics

Object model for storing size-dependent thermophysical properties

openpnm.models

Collection of pore-scale models for manipulating data

openpnm.solvers

Collection of matrix solvers for steady state simulations

openpnm.integrators

Collection of ODE integrators for transient simulations

openpnm.algorithms

Collection of pre-defined algorithms

openpnm.topotools

Collection of functions for manipulating network topology

openpnm.io

Collection of functions for import/export-ing data

openpnm.metrics

Collection of preconfigured algorithms for specific tasks