API reference

The package flory is built around the core module mcmp, which implements general finder CoexistingPhasesFinder for multiphase coexistence in multicomponent mixtures:

mcmp

Module containing finder for coexisting phases.

See Implementation details for the implementation details of the finder CoexistingPhasesFinder.

The general finder CoexistingPhasesFinder can be applied to a combination of interaction, entropy, ensemble and constraint:

interaction

Module containing several common interaction energies.

entropy

Module containing several common entropic energies.

ensemble

Module containing several common ensembles.

constraint

Module containing several constrains.

The module free_energy provides a comprehensive way to create interaction and entropy instances, and provides more useful functionalities:

free_energy

Module containing several common free energies.

For usual systems, shortcut provide shortcuts for simple tasks of finding coexisting phases:

shortcut

Shortcuts for simple tasks of finding coexisting phases.

All Modules

Below, we list the full module structure of the package.

flory

Package for finding coexisting phases of multicomponent mixtures.