Introduction to SU2

SU2, Multiphysics Simulation and Design Software

Using the Documentation

What's New

Changes in Version 8

Guide to Version v7

Quick Start

Installation

Software Components

SU2 on Linux/MacOS

Build From Source

Build SU2 on Linux/MacOS

Build SU2 on Windows

Running Unit Tests

Theory

Governing Equations in SU2

Streamwise Periodicity

Thermochemical Nonequilibrium

Users Guide

Configuration File

Physical Definition

Markers and Boundary Conditions

Convective Schemes

Slope Limiters and Shock Resolution

History and Solution Output

Linear Solvers and Preconditioners

Basics of Multi-Zone Computations

Physical Models

Turbulence Models

Transition Models

Hybrid RANS/LES (DES)

Wall Treatment: Wall Functions and Roughness

Case Setup Guides

Setup Guide: Steady RANS for External Aerodynamics

Setup Guide: Incompressible Flows

Setup Guide: Unsteady Flows and DES

Setup Guide: Laminar-Turbulent Transition

Setup Guide: Turbomachinery

Setup Guide: Heat Transfer and Conjugate Heat Transfer

Setup Guide: Species Transport and Combustion

Setup Guide: Shape Optimization with the Discrete Adjoint

Setup Guide: Non-Ideal Compressible Flows

Developer Docs

GIT-ting Started

Developing SU2 on GitHub (Internal Developers)

Running Regression Tests

Advanced AD Techniques

Containers for Development

Writing Unit Tests

Integrating Tracy Profiler with SU2

FAQ

Troubleshooting

Contact

Running Regression Tests

The regression tests can be run on your local machine by using the Python scripts available in the SU2/TestCases/ directory and the mesh files from the su2code/TestCases and Tutorials repository. See the Test Cases page for more information on working with the TestCases repo.

When you are ready to combine your modifications into the develop branch, creating a pull request will automatically run these same regression tests. Your pull request must pass these tests in order to be merged into the develop branch. In the pull request, you will be able to see the state of the tests, and by clicking on links find the details of the test results.

Improve this page