Skip to content

User Guide

How umcfGui sees urbanMicroclimateFoam cases, and what it does with them.

  • Cases: solver cases and meshing steps, regions, and the chain of cases a project is made of.
  • OpenFOAM versions: how umcfGui tells OpenFOAM-8 and OpenFOAM-12 cases apart, and what it reports about partly ported cases.
  • Dictionaries: how umcfGui reads and edits OpenFOAM dictionaries without losing your formatting.
  • Surfaces: the STL geometry in constant/triSurface: what would break meshing, importing and repairing it, and tree crowns from a table of trees.
  • Meshes: the mesh of each region, and the checks it passes before use.
  • 3D scene and selection: drawing the meshes and surfaces, and picking patches and surface regions in them.
  • Checking a case: what the case check finds, code by code.
  • The case workflow: the scripts read, checked and written again, and the workflow description system/umcfWorkflow.
  • Fields and results: reading the solver's field files, ASCII or binary, compressed or not.
  • The desktop app: umcf-gui, the window and what each part of it does.
  • Command line: umcf-cli check, mesh, surface, render, run and commands, without the GUI.