Code Reference (Doxygen)

The code reference describes the classes and files of SU2. Doxygen makes it from the comments in the source code. It is rebuilt each time the code changes, so it always matches the code.

Open the code reference

Good places to start:

• Class list: all classes, with their parents and children.
• File list: all source files.
• CDriver: runs the simulation and creates all the other objects.
• CConfig: reads the configuration file. The Option Reference is made from it.
• CSolver, CNumerics, CVariable, CGeometry: the solvers, the numerical schemes, the stored variables and the mesh.

To build it on your computer, run this command in the SU2 folder. Then open Docs/html/index.html.

doxygen doxyfile

Last checked against SU2 develop 11c177b904.