Repository navigation
Home
Describe a CFD simulation in plain English. The app writes the OpenFOAM case, runs it in Docker, fixes what breaks, and shows you the results in 3D.
OpenFOAM Studio is a desktop app for engineers and researchers who understand fluid dynamics but would rather not spend a day hand-editing dictionary files to discover they mistyped a patch name.
You type "lid-driven cavity at Re=400". It classifies the problem, generates every file in dependency order, meshes it, solves it, and if foamRun throws a FOAM FATAL ERROR it reads the log, explains the root cause, and proposes a fix you approve.
| Installation | Download, first launch, Docker setup |
| Configuring an AI provider | Bring your own key, or use the Claude CLI with no key |
| Your first simulation | The workflow end to end |
| Troubleshooting | Docker not detected, startup errors, viewer problems |
| How it works | Architecture, where your data lives, what the agent can and cannot do |
| Limitations | What this does not do yet, and what is deliberately out of scope |
| Building from source | For contributors |
Natural-language case setup. No template picking, no dictionary reference open in another window. The agent knows OpenFOAM 13's file layout and dependency order — controlDict before blockMeshDict before the 0/ field files, with patch names matched exactly across all of them.
Everything runs locally. The solver executes in an OpenFOAM container on your machine. No upload, no cloud account, no per-simulation cost. The only outbound traffic is to whichever LLM provider you configure — and if you point it at Ollama or LM Studio, not even that.
Nothing is hidden. Every generated file is visible and editable in a Monaco editor. Every Docker command the agent runs is logged with live output and an exit code. You can inspect, override, or walk away with a plain OpenFOAM case at any point.
Error recovery that explains itself. When a run fails you get a root-cause diagnosis and a concrete diff — not a silent retry. You approve before anything is rewritten.
Results in the app. Solved cases render in 3D with field colouring, colormaps, a scalar bar, and time animation. Slice, clip, iso-surface, vector glyphs, streamlines, point probe, and a two-viewport compare mode with a shared camera. No separate ParaView trip for a first look.
Physics validated, not just "it ran." The lid-driven cavity is checked against Ghia et al. (1982) as an acceptance gate. A simulation that converges to the wrong answer is worse than one that fails loudly.
- macOS (Apple Silicon or Intel) or Windows x64
- Docker Desktop, installed and running
- An AI provider — an API key for Anthropic, OpenAI, or Google; any OpenAI-compatible endpoint including local Ollama and LM Studio; or the Claude Code CLI, which needs no key
No Node.js, no npm, no Python. The installers bundle their own runtime.
Early-stage, and honest about it. The five staged test suites — environment, file generation, mesh quality, solver execution, and the Ghia physics benchmark — all pass. Expect rough edges outside the incompressible-flow path, and read Limitations before planning work around it.
Source, issues, and the CFD knowledge base the agent reads from: github.com/PKrunal26/openfoam-studio
This offering is not approved or endorsed by OpenCFD Limited, producer and distributor of the OpenFOAM software via www.openfoam.com, and owner of the OPENFOAM and OpenCFD trademarks.
MIT licensed. Not approved or endorsed by OpenCFD Limited, owner of the OPENFOAM and OpenCFD trademarks.