Skip to content

umcfGui

An open-source GUI for urbanMicroclimateFoam: set up, run and inspect urban microclimate simulations.

urbanMicroclimateFoam (UMCF) is a multi-region OpenFOAM solver for urban microclimate: CFD in the air, heat and moisture transport in porous building materials, vegetation, and view-factor radiation. umcfGui edits UMCF cases, runs their pipeline (locally or as an exported cluster job) and shows the results. It never re-implements the physics: results always come from a solver run.

Early development

umcfGui is at milestone M0, the foundation. The libraries that read and edit cases exist and are tested against real cases, and so do the command line (umcf-cli) and a first desktop app (umcf-gui). Meshing set-up and the run pipeline don't exist yet. See the roadmap.

Design goals

  • Never lose a case

    People hand-edit OpenFOAM dictionaries. umcfGui keeps every comment, alignment, #include and $macro: a file it hasn't changed is byte-for-byte the same, and an edit touches only the entry it changes. Dictionaries

  • OpenFOAM-8 and OpenFOAM-12

    UMCF exists for both, and real projects mix them. umcfGui works out each case's version from its files and reports what's left over from porting. OpenFOAM versions

  • Cluster first

    Most UMCF cases are too big for a workstation. Running locally is optional; exporting a case with its run scripts for a cluster scheduler is always there.

  • Scriptable

    Every action is a command with an id, usable from the GUI, the command line, a JSON control channel and an MCP server for AI agents. Architecture

Licence

umcfGui is free software under the GNU General Public License v3.0 or later, the same as urbanMicroclimateFoam and OpenFOAM.