fea.plan — Plan a RunMat FEA study or sweep without solving.
fea.plan(study) validates and plans a .fea path, fea.Study, or fea.Sweep without executing the solver.
Syntax
plan = fea.plan(study)Inputs
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
study | Any | Yes | — | A .fea path, fea.Study object, or fea.Sweep object. |
Returns
| Name | Type | Description |
|---|---|---|
result | Any | FEA object or operation result. |
Errors
| Identifier | When | Message |
|---|---|---|
RunMat:fea:LoadFailed | A .fea document cannot be read, parsed, or resolved. | fea: failed to load FEA document |
RunMat:fea:InvalidInput | A builtin receives an unsupported argument pattern or object type. | fea: invalid input |
RunMat:fea:OperationFailed | A validation, planning, run, result-query, comparison, or trend operation fails. | fea: operation failed |
RunMat:fea:Internal | An FEA object or operation result cannot be converted to a RunMat value. | fea: internal error |
How fea.plan works
- The input is a text path or typed study/sweep object; integer arrays have no input role.
- Planning resolves model data, runs validation, selects the versioned operation sequence, and writes planning evidence before returning.
- Plan counts, indexes, revisions, and other discrete metadata are structural integer outputs and remain exact; estimated physical or timing quantities retain their declared floating representation.
- Planning does not intrinsically require native OCCT when supplied geometry is already loaded or uses a non-OCCT import path. A topology-bearing CAD source may require its configured geometry importer during document resolution.
Example
Plan a study
plan = fea.plan(study);Using fea.plan with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how fea.plan changes the result.
Run a small fea.plan example, explain the result, then change one input and compare the output.
FAQ
Does planning run the solver?⌄
No. It validates and records the selected operation sequence without solving.
Related Fea functions
fea.boundaryCondition · fea.compare · fea.domain · fea.field · fea.interface · fea.loadCase · fea.material · fea.materialAssignment · fea.model · fea.plot · fea.results · fea.run · fea.runOptions · fea.step · fea.study · fea.sweep · fea.trends · fea.validate
Open-source implementation
Unlike proprietary runtimes, every RunMat function is open-source. Read exactly how fea.plan is executed, line by line, in Rust.
- View the source for fea.plan in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is an open-source runtime that executes MATLAB-syntax code blazing on any GPU. It is licensed under the Apache 2.0 license.
- RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
- Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.