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.
| Task | Reference | Practical guide |
|---|---|---|
| Build a mesh, choose materials and unknowns | Preprocessing | First problem |
| Construct, convert or save fields | Fields and storage | Nodal vs element fields |
| Combine field values and tensors | Field algebra | Operators and fields |
| Differentiate a computed field | Field calculus | Field calculus and DSL operators |
| Assemble weak forms and mixed blocks | Weak forms and assembly | Assembly and solvers |
| Prescribe constraints and coordinate bases | Boundary conditions and MPC | Boundary conditions and loads |
| Solve a linear system or eigenproblem | Solution | Matrix-level workflow |
| Evaluate an energy-based material | Constitutive models | Nonlinear formulations |
| Model contact | Contact | Contact tutorials |
| Inspect, integrate or display results | Postprocessing | Postprocessing guide |
Engineering workflow and legacy implementations
- API layers: engineering wrappers, DSL and legacy assembly
- Engineering linear mechanics and eigen helpers
- Engineering heat assembly and solution
- Legacy nonlinear assembly
- Legacy Poisson and dedicated differential matrices
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.