User guide¶
The user guide covers one task per page, in the order a simulation flows through femforge. Start with Concepts for the whole pipeline on one page.
- Geometry and tags: tag the bodies of the STEP file, in your CAD or in a build123d script.
- Materials: the material models, their property functions and units.
- Conditions and physics: body forces, boundary conditions and the physics presets femforge solves.
- Mesh: element sizes, gmsh options, deterministic meshing and the mesh backends.
- Frames: solve the model in 3D or as an axisymmetric 2D section.
- Driver and runs: how the driver stages, reuses and records each run.
- Results: load results, read forces and fields, and validate them.
- Artifacts and retention: the artifact store, reuse across processes and the retention policy.
- Telemetry: the logs, run indexes and sweep progress femforge records.
- Workbench: launch the workbench and inspect runs and fields in its panels.
- Optimization: parameter sweeps and the root-finding searches over expensive solves.
- Elmer: native and Docker: run Elmer from a native install or from the femforge image.
- CLI: the
femforgeandfemforge-workbenchcommands.