Concept reference

Figure Catalog

Bind figure roles to solver fields, viewpoints, and renderers so the viewer, docs, and report agree.

1 min read

Binding contract

Each figure-catalog entry binds a semantic role (e.g., "residual history," "centerline u-velocity," "surface pressure contour") to a solver field, a viewpoint, and a renderer. Docs and help explain the intent; the typed registry remains the source of truth.

Published figure-role bindings

  • openfoam.primary-scalar.contour
  • openfoam.boundary-scalar.histogram
  • su2.pressure-coefficient.wing
  • su2.mach-slice.midspan
  • ccx.von-mises.contour
  • ccx.sigma-yy.point-d

Renderers are interchangeable

A renderer is a function from (figure-role, run-artifacts) to an image or interactive scene. PyVista, the Trame viewer, and matplotlib are all valid renderers — the catalog decides which to use; you swap renderers without changing the report.

Bridge to validation and review

Figure-catalog entries tie into benchmark-facing review flows. Current benchmark labels include:

  • SU2 ONERA M6 transonic wing RANS benchmark
  • CalculiX NAFEMS LE1 elliptic membrane benchmark

Was this page helpful?

Edit this page on GitHub

Search docs

Find pages across the SimPilot docs.