OpenPhase Modules

Every page under this section documents one OpenPhase module: the classes it ships, the equations it implements, the $Token set its ReadInput() consumes, the C++ method signatures a user calls, and the dependencies the module pulls in. The reference style for these pages is PhaseField/interface-properties.md.

If you are new here, the recommended path is Getting Started → Introduction → Installation → Your First Simulation and then back to this index.

Module groups

Core

Infrastructure every simulation depends on — settings, time-step control, boundary conditions, output cadence.

• Settings — phase / component lists, output-directory paths, simulation-wide configuration.
• Run Time Control — time-step schedule, output cadence, units, restart.
• Boundary Conditions — face-level boundary handling for every Storage3D field.
• Grid Parameters — Nx, Ny, Nz, dx, IWidth, MPI cartesian decomposition.
• VTK — visualisation output (.vts, .pvts).
• Console Output — formatting helpers for time-step and diagnostic messages.

Phase Field

The multiphase-field core, its potential, the interface properties, and the cross-cutting accumulators.

• Phase Field — multiphase-field theory, evolution equations, active-parameter tracking, and the canonical grain-growth example.
• Double Obstacle — capillarity / curvature kernel; double-obstacle potential.
• Interface Properties — per-pair interface energy and mobility models (ISO, CUBIC, CUBICFULL, HEXBOETTGER, HEXSUN, HEXYANG, FACETED, FACETEDFULL).
• Driving Force — shared accumulator for chemical / mechanical / user-supplied driving forces.
• User Driving Force — per-phase-pair VALUE / FORMULA driving force.
• Interface Regularization — stabiliser for strongly driven interfaces.
• Stabilization — phase-field numerical-stabilisation knobs.
• Nucleation — heterogeneous nucleation framework: locations, intensity, distributions, variants.

Initialisation

Code-level helpers that populate the initial microstructure and the crystallography it lives in.

• Initializations — Voronoi, spheres, slabs, EBSD imports, …
• Orientations — per-grid orientation field; EBSD / misorientation visualisation.
• Symmetry Variants — crystallographic variants per phase.
• Crystallography — symmetry family selector.
• Noise — band-limited stochastic perturbations.

Thermal

Temperature field and heat-transport solvers.

• Temperature — temperature storage with control modes, latent-heat coupling, file-driven profiles.
• Heat Diffusion — transient heat equation with phase-weighted thermal properties.
• Heat Sources — face-flux, phase, and ellipsoidal volume sources with event triggers.

Diffusion

Solute-transport solvers; see the Diffusion overview for the whole solver family.

• Composition — shared concentration storage.
• Equilibrium Partition (Binary) — binary-alloy diffusion with anti-trapping.
• Interface Diffusion — grain-boundary / interface-confined flux.

Mechanics

Continuum mechanics, crystal plasticity, fracture, damage. The overview pages mechanics.md and damage.md carry the theory.

• Elastic Properties — per-phase elastic constants, transformation stretches, mechanical boundary conditions.
• Elasticity Solver (Spectral) — FFT-based mechanical-equilibrium solver.
• Mechanical Loads — time-scheduled load list.
• Fracture Field — field-level fracture kernel.

Electrics

Electrostatic potential and electrochemistry; see the Electrics overview.

• Electric Properties — charge / polarisation density storage.
• Electrical Potential — electrode list and per-component charges.

Magnetism

Linear magnetism; see the Magnetism overview.

• Linear Magnetic Solver — applied field with linear gradient + per-phase susceptibility.

Fluid Dynamics

Lattice Boltzmann solver and multi-physics couplings.

• Overview, LBM theory, FlowSolverLBM, Multi-phase flow, Solid–fluid, Solid–solid, Thermally compressible flow, Reactive flow, Usage / I/O.

Grand Potential

Grand-potential formulation for diffusion / thermodynamics.

• Grand Potential Solver, Grand Potential Density, Phase Density (base class), Phase Density — Parabolic.

Reactive Flows

Combustion / reactive-transport coupling on top of FluidDynamics.

• Flow Mixture, Species Transport, Energy Transport, Thermo-Chemistry (Cantera), Solid Body.

Thermodynamics

CALPHAD-style data; see the Thermodynamics overview for theory and the partitioning derivation.

• Thermodynamic Phase, Sublattice Model.

Transport

Field advection, velocities, moving frame, mass density.

• Advection (HR) — high-resolution advection scheme.
• Velocities — per-phase + average velocity field.
• Moving Frame — directional-solidification-style domain shift.
• Mass Density — per-phase mass-density storage.

Tools

Analysis utilities and post-processing helpers; see the Tools overview.

• Analysis Sintering, Microstructure Analysis, Time Info, Probability Distributions.

Containers

Static containers — vectors, matrices, tensors, node types. These ship alphabetically under Code Reference → Containers, not in the guide sidebar.