Wake CFD Docs

About this manual

Wake CFD is a GPU-based computational fluid dynamics (CFD) solver. Its primary documented engineering path is density-based Navier–Stokes (DBNS) for external aerodynamics. Pressure-based Navier–Stokes (PBNS) and Flux Reconstruction (FR) are in development. The formulations share a JSONC input model across the command line, desktop GUI, and automation workflows.

This manual explains how to install Wake CFD, select a solver, define a case, run it, and assess the result. It is written as a reference for engineers who need both a repeatable first run and enough detail to build production cases.

Note

Version and scope. The manual describes the capabilities and configuration schema of the Wake CFD build associated with the published documentation. Solver availability, platform support, and configuration keys can change between releases. Record the Wake CFD version with every engineering result.

Wake CFD at a glance

Use this table to find the part of the manual that matches the work you need to do.

Engineering task	Primary Wake CFD path	Start here
Install Wake CFD and run a known case	Desktop or CLI	Getting started
Compressible external aerodynamics	DBNS	Physical models
Low-Mach or incompressible flow	PBNS (in development)	Analysis setup
High-order, unsteady, or vortex-dominated flow	FR (in development)	Numerical methods
Turbomachinery and rotating domains	DBNS; PBNS path in development	Domains and Interfaces
Parameter studies, HPC, or external automation	CLI, Python, MPI, and Slurm	Automation and integration

Choosing a solver

DBNS, PBNS, and FR are different numerical formulations available through the same case model and execution environment. Choose the formulation from the flow physics and the required numerical behavior; do not choose it only from the mesh format or the user interface.

Formulation	Best suited to	Documented dimensional scope	Status
DBNS — density-based Navier–Stokes	Compressible external aerodynamics, transonic and hypersonic flow, turbomachinery	2D and 3D; Euler, laminar, and RANS paths	Production
PBNS — pressure-based Navier–Stokes	Low-Mach and pressure-based flow, including internal flow	3D; steady and unsteady controls depend on the case	In development
FR — Flux Reconstruction	High-order spatial discretization, unsteady and vortex-dominated flow	2D and 3D; polynomial order p=1–4	In development

The solver selection is independent of how a case is launched. A case can be created in the GUI, edited as JSONC for the CLI, or generated and monitored through the Python and automation interfaces.

How to use this manual

The chapters are organized by the decisions made during a typical analysis:

If you need to…	Read…
Install Wake CFD and complete a first run	Getting started
Use Wake CFD Desktop or the CLI	User interfaces
Learn from a guided engineering case	Learning and tutorials
Choose recommended settings or diagnose a run	Best practices
Define mesh, physics, domains, numerics, and outputs	Input and configuration
Integrate Wake CFD with Python, Slurm, or an AI agent	API and automation

Read the chapters in order for a first installation. For an experienced user, the input chapters can be used as a reference independently of the introductory chapters.

One case model across interfaces

The GUI, CLI, Python SDK, and automation workflows use the same JSONC case model. The model describes the mesh, analysis formulation, material and physical models, domains and boundaries, numerical method, run control, monitoring, and outputs. This common model lets a case move from interactive setup to a scripted or HPC run without translating the physics into a different input format. When an MCP agent attaches to Wake CFD Desktop, the same model becomes a live control surface: agent edits are reconciled into the open project for human review.

Note

Figure placeholder — shared Wake CFD case workflow

Engineering intent
        ↓
Shared JSONC case model
        ↓
GUI  ·  CLI  ·  Python / automation
        ↓
DBNS  ·  PBNS  ·  FR solver paths
        ↓
Results, monitors, and validation review

For the print release, replace this box with a final vector diagram showing the same relationships. The surrounding text defines the content and connections that the final figure must represent.

A reproducible first run

The recommended first run is the packaged ONERA M6 half-wing example. It exercises the installation, mesh loading, solver execution, output writing, and basic result review without requiring a new mesh or a case to be authored from scratch.

1. Install Wake CFD and confirm that the executable starts.
2. Run the ONERA M6 quickstart.
3. Inspect the residual history and the Mach, pressure, or Cp field.
4. Keep this result as a baseline before changing the mesh, boundary conditions, or physical model.

For a GUI-based version of the same workflow, see the GUI quickstart. For scripted execution, continue to the CLI running guide.

Validation and engineering use

Wake CFD results should be interpreted together with their mesh, boundary conditions, physical model, numerical settings, convergence history, and solver version. A successful process exit is not by itself evidence that the result is accurate.

Use the separate Wake CFD Validation Reports to review comparisons with analytical solutions, published reference computations, and experimental data. For a new engineering case:

• start from a comparable validated or verified case;
• change one major setting at a time and retain a baseline result;
• check conservation and convergence monitors before interpreting field data;
• record the solver, model, mesh, precision, and version with the result.

Document conventions

• Configuration keys and command-line arguments appear as code.
• Quantities are shown in SI units unless a section states otherwise.
• Tables summarize supported combinations; linked reference pages contain the full key descriptions and restrictions.
• A limitation or development status is stated where it affects solver selection or result interpretation.

The remainder of the manual provides the installation steps, interface workflows, input reference, numerical controls, automation hooks, and troubleshooting guidance needed to carry a case from setup to review.