API Reference

Find functions by the task you are performing. Use the problem-oriented engineering API for standard workflows, or the weak-form DSL directly for custom formulations. The engineering names remain part of the planned API; their internal migration to DSL-backed wrappers is described below.

TaskReferencePractical guide
Build a mesh, choose materials and unknownsPreprocessingFirst problem
Construct, convert or save fieldsFields and storageNodal vs element fields
Combine field values and tensorsField algebraOperators and fields
Differentiate a computed fieldField calculusField calculus and DSL operators
Assemble weak forms and mixed blocksWeak forms and assemblyAssembly and solvers
Prescribe constraints and coordinate basesBoundary conditions and MPCBoundary conditions and loads
Solve a linear system or eigenproblemSolutionMatrix-level workflow
Evaluate an energy-based materialConstitutive modelsNonlinear formulations
Model contactContactContact tutorials
Inspect, integrate or display resultsPostprocessingPostprocessing guide

Engineering workflow and legacy implementations

The sidebar includes these reference topics alongside the engineering pages; this topic map distinguishes retained engineering interfaces from legacy implementations. A function has one primary docstring entry, with links from related topics instead of copied reference text.

For a complete alphabetical inventory, aliases, and known API inconsistencies, see the public API audit. The bundled gmsh module is re-exported; its own API is documented by Gmsh.