-
Configuration File
Mesh File
Restart File
Solver Setup
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
Execution
Aeroacoustic analysis of unsteady pressure
Flamelet Solver — Python Wrapper Wall Boundary Conditions
Output Fields Reference
Error Messages
-
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
-
Option Reference
Problem Definition
FluidModel
Data-driven fluid model parameters
Freestream Conditions
Reference Conditions
Boundary Markers
Time-marching
Linear solver definition
Convergence
Multi-grid
Spatial Discretization
Adjoint and Gradient
Sobolev Gradient Solver Parameters
Input/output files and formats
Dynamic mesh definition
Aeroelastic Simulation (Typical Section Model)
Wind Gust
Equivalent Area
Grid deformation
Deformable mesh
FEM flow solver definition
FEA solver
Multizone definition
Radiation solver
Heat solver
Visualize Control Volumes
Inverse design problem
Unsupported options
FFD point inversion
Automatic Differentation options
Python Options
Hybrid_RANSLES Options
Output Options
libROM options
Renamed and Removed Options
-
GIT-ting Started
Developing SU2 on GitHub (Internal Developers)
Running Regression Tests
Code Review
Code Structure
Style Guide
Advanced AD Techniques
Containers for Development
Writing Unit Tests
Integrating Tracy Profiler with SU2
Automatic Differentiation (AD)
Code Reference (Doxygen)
Debugging SU2
Documentation Improvements and Status
Glossary
Docs Check
Input/output files and formats
Generated from SU2 commit
6b54b78464on 2026-10-23. Do not edit this page. Edit the comment above the option inCommon/src/CConfig.cppinstead.
TABULAR_FORMAT
I/O format for output plots.
More in config_template.cfg: Output tabular file format (TECPLOT, CSV)
- Type: one of the values below
- Values:
CSV,TECPLOT - Default:
CSV - In config_template.cfg:
TABULAR_FORMAT= CSV - Mentioned in: Guide to Version v7, Setup Guide: Shape Optimization with the Discrete Adjoint, Linear Elasticity, Realtime update of residuals and solution in paraview
- Used in 329 test case files, for example:
aeroelastic_NACA64A010.cfg(CSV),inv_NACA0012.cfg(TECPLOT) - Code:
CConfig.cppline 2344
OUTPUT_PRECISION
Number of digits of the text outputs (SU2_DOT, HISTORY and screen). Useful for exact gradient validation. It does not change the volume and surface files, see VOLUME_OUTPUT_PRECISION.
- Type: integer
- Default:
10 - In config_template.cfg:
OUTPUT_PRECISION= 10 - Mentioned in: Unconstrained shape design of a two way mixing channel
- Used in 13 test case files, for example:
chtMaster.cfg(16),inv_NACA0012_gradsmooth.cfg(10),dsma661_sa_config.cfg(15) - Code:
CConfig.cppline 2348
ACTDISK_JUMP
The jump is given by the difference in values or a ratio
More in config_template.cfg: Actuator disk jump definition using ratio or difference (DIFFERENCE, RATIO)
- Type: one of the values below
- Values:
DIFFERENCE,RATIO - Default:
DIFFERENCE - In config_template.cfg:
ACTDISK_JUMP= DIFFERENCE - Used in 2 test case files, for example:
actuatordisk_bem.cfg(DIFFERENCE) - Code:
CConfig.cppline 2350
MESH_FORMAT
Mesh input file format
More in config_template.cfg: Mesh input file format (SU2, SU2B, CGNS, RECTANGLE, BOX)
- Type: one of the values below
- Values:
SU2,SU2B,CGNS,RECTANGLE,BOX - Default:
SU2 - In config_template.cfg:
MESH_FORMAT= SU2 - Mentioned in: Basics of Multi-Zone Computations, Mesh File, Setup Guide: Heat Transfer and Conjugate Heat Transfer, Setup Guide: Incompressible Flows, Setup Guide: Laminar-Turbulent Transition, Setup Guide: Non-Ideal Compressible Flows and 8 more
- Used in 355 test case files, for example:
aeroelastic_NACA64A010.cfg(SU2),inv_cylinder3D.cfg(CGNS),linear_plane_strain_2d.cfg(RECTANGLE) - Code:
CConfig.cppline 2352
MESH_FILENAME
Mesh input file
- Type: string
- Default:
string("mesh") - In config_template.cfg:
MESH_FILENAME= mesh_NACA0012_inv - Mentioned in: Basics of Multi-Zone Computations, Setup Guide: Heat Transfer and Conjugate Heat Transfer, Setup Guide: Incompressible Flows, Setup Guide: Laminar-Turbulent Transition, Setup Guide: Non-Ideal Compressible Flows, Setup Guide: Shape Optimization with the Discrete Adjoint and 7 more
- Used in 383 test case files, for example:
aeroelastic_NACA64A010.cfg(mesh_NACA64A010_hybrid_inv.su2),air_nozzle_restart.cfg(nozzle.su2),backwardStep.cfg(backward_step) - Code:
CConfig.cppline 2354
MESH_OUT_FORMAT
Mesh output file format
More in config_template.cfg: Mesh output file format (SU2, SU2B)
- Type: one of the values below
- Values:
SU2,SU2B - Default:
SU2 - In config_template.cfg:
MESH_OUT_FORMAT= SU2 - Used in 2 test case files, for example:
mesh_su2_to_su2bin.cfg(SU2B) - Code:
CConfig.cppline 2356
MESH_OUT_FILENAME
Mesh output file name. Used when converting, scaling, or deforming a mesh.
- Type: string
- Default:
string("mesh_out") - In config_template.cfg:
MESH_OUT_FILENAME= mesh_out - Mentioned in: Setup Guide: Shape Optimization with the Discrete Adjoint, Inviscid Supersonic Wedge, Unconstrained shape design of a two way mixing channel
- Used in 248 test case files, for example:
inv_NACA0012.cfg(mesh_out),inv_NACA0012_discadj_multizone.cfg(mesh_out.su2),inv_ONERAM6_setting.cfg(mesh_ONERAM6_inv_FFD.su2) - Code:
CConfig.cppline 2358
MESH_BOX_SIZE
List of the number of grid points in the RECTANGLE or BOX grid in the x,y,z directions. (default: (33,33,33) ).
- Type: list of integers
- In config_template.cfg:
MESH_BOX_SIZE= (33, 33, 33) - Used in 7 test case files, for example:
linear_plane_strain_2d.cfg(( 129, 33, 2 )),lam_flatplate_unst.cfg((17, 33, 129)),lam_flatplate.cfg((65, 17, 0)) - Code:
CConfig.cppline 2361
MESH_BOX_LENGTH
List of the length of the RECTANGLE or BOX grid in the x,y,z directions. (default: (1.0,1.0,1.0) ).
- Type: fixed-size list of real numbers
- Default: Not extracted; see the code.
- In config_template.cfg:
MESH_BOX_LENGTH= (1.0, 1.0, 1.0) - Used in 7 test case files, for example:
linear_plane_strain_2d.cfg(( 1, 0.05, 0.01 )),nonlinear_plane_stress_2d.cfg(( 1, 0.05, 0.005 )),lam_flatplate_unst.cfg((0.01, 0.01, 0.1)) - Code:
CConfig.cppline 2365
MESH_BOX_OFFSET
List of the offset from 0.0 of the RECTANGLE or BOX grid in the x,y,z directions. (default: (0.0,0.0,0.0) ).
- Type: fixed-size list of real numbers
- Default: Not extracted; see the code.
- In config_template.cfg:
MESH_BOX_OFFSET= (0.0, 0.0, 0.0) - Code:
CConfig.cppline 2369
MESH_BOX_POLY_SOL_FEM
Polynomial degree of the FEM solution for the RECTANGLE or BOX grid. (default: 1).
- Type: integer
- Default:
1 - Not in config_template.cfg.
- Code:
CConfig.cppline 2372
MULTIZONE_MESH
Determine if the mesh file supports multizone.
More in config_template.cfg: Determine if the mesh file supports multizone. \n DEFAULT: true (temporarily)
- Type: YES / NO
- Default:
YES - In config_template.cfg:
MULTIZONE_MESH= YES - Mentioned in: Basics of Multi-Zone Computations, Setup Guide: Heat Transfer and Conjugate Heat Transfer, Static Fluid-Structure Interaction (FSI)
- Used in 18 test case files, for example:
configFEA.cfg(NO),lam_prem_ch4_cht_cfd_master.cfg(YES) - Code:
CConfig.cppline 2375
MULTIZONE_RESIDUAL
Determine if we need to allocate memory to store the multizone residual.
More in config_template.cfg: Determine if we need to allocate memory to store the multizone residual. \n DEFAULT: true (temporarily)
- Type: YES / NO
- Default:
NO - In config_template.cfg:
MULTIZONE_RESIDUAL= NO - Code:
CConfig.cppline 2377
CONTROLLING_VARIABLE_NAMES
! Names of the variables used as inputs for the data regression method in flamelet or data-driven fluid models.
More in config_template.cfg: Names of the controlling variables used to evaluate the look-up table and for which transported scalar variables are generated. These names should coincide with those listed in the look-up table.
- Type: list of strings
- In config_template.cfg:
CONTROLLING_VARIABLE_NAMES= (ProgressVariable, EnthalpyTot) - Mentioned in: Setup Guide: Species Transport and Combustion, Incompressible, Laminar Combustion Simulation, Incompressible, Laminar counterflow diffusion flame
- Used in 9 test case files, for example:
lam_prem_ch4_cfd.cfg((ProgressVariable, EnthalpyTot)),lam_partial_prem_ch4_cfd.cfg((ProgressVariable,EnthalpyTot,MixtureFraction)),laminar_premixed_h2_flame_cfd.cfg((ProgressVariable, EnthalpyTot, MixtureFraction)) - Code:
CConfig.cppline 2380
CONTROLLING_VARIABLE_SOURCE_NAMES
! Names of the variables in the flamelet manifold corresponding to the source terms of the controlling variables.
More in config_template.cfg: Names of the source term variables as they are present in the look-up table. For controlling variables without source terms, use “zero” or “null”, similar to the option USER_SOURCE_NAMES.
- Type: list of strings
- In config_template.cfg:
CONTROLLING_VARIABLE_SOURCE_NAMES= (ProdRateTot_PV, NULL) - Mentioned in: Setup Guide: Species Transport and Combustion, Incompressible, Laminar Combustion Simulation, Incompressible, Laminar counterflow diffusion flame
- Used in 9 test case files, for example:
lam_prem_ch4_cfd.cfg((ProdRateTot_PV, NULL)),lam_partial_prem_ch4_cfd.cfg((ProdRateTot_PV,NULL,NULL)),laminar_premixed_h2_flame_cfd.cfg((ProdRateTot_PV, NULL, NULL)) - Code:
CConfig.cppline 2383
LOOKUP_NAMES
Names of the passive lookup variables for flamelet LUT
More in config_template.cfg: Names of variables from the LUT that will be looked up for visualization
- Type: list of strings
- In config_template.cfg:
LOOKUP_NAMES= (MolarWeightMix, Conductivity, HeatRelease, Diffusivity) - Mentioned in: Setup Guide: Species Transport and Combustion, Incompressible, Laminar Combustion Simulation, Incompressible, Laminar counterflow diffusion flame
- Used in 8 test case files, for example:
lam_prem_ch4_cfd.cfg((MolarWeightMix, Conductivity, Cp, HeatRelease, Diffusivity)),lam_prem_ch4_hx_ad.cfg((MolarWeightMix, Conductivity, HeatRelease, Diffusivity, \),lam_partial_prem_ch4_cfd.cfg((MolarWeightMix, Conductivity, Cp, ProdRateTot_PV)) - Code:
CConfig.cppline 2386
USER_SCALAR_NAMES
Names of the user transport equations solved in the flamelet problem.
More in config_template.cfg: Names of the user defined (auxiliary) transport equations.
- Type: list of strings
- In config_template.cfg:
USER_SCALAR_NAMES= (Y-CO) - Mentioned in: Setup Guide: Species Transport and Combustion, Incompressible, Laminar Combustion Simulation
- Used in 7 test case files, for example:
lam_prem_ch4_cfd.cfg((CO, NOx)),lam_prem_ch4_hx_ad.cfg((Y-CO, Y-NOx_tot)),lam_partial_prem_ch4_cfd.cfg((CO, CO2)) - Code:
CConfig.cppline 2389
USER_SOURCE_NAMES
Names of the user scalar source terms.
More in config_template.cfg: Names of the source terms for the user defined transport equations. The source term has the form S = S_production + S_consumption * Y, with Y the mass fraction of the user scalar S = S_production + S_consumption * X, with X the mole fraction of the user scalar The second term can have the name “zero” or “null” to indicate that only a total source will be used.
- Type: list of strings
- In config_template.cfg:
USER_SOURCE_NAMES= ( ProdRateTot_Y-CO, zero) - Mentioned in: Setup Guide: Species Transport and Combustion, Incompressible, Laminar Combustion Simulation
- Used in 7 test case files, for example:
lam_prem_ch4_cfd.cfg(( \) - Code:
CConfig.cppline 2392
PREFERENTIAL_DIFFUSION
Enable preferential diffusion for FGM simulations.
More in config_template.cfg: Enable preferential diffusion for progress variable, total enthalpy, mixture fraction FGM problems. If ‘YES’, the preferential diffusion model from Efimov et al.(2021) is used for computing the viscous residual terms. If enabled, make sure the variables “Beta_ProgVar”, “Beta_Enth_Thermal”, “Beta_Enth”, and “Beta_MixFrac”, corresponding to the preferential diffusion terms of the progress variable, temperature, total enthalpy, and mixture fraction respectively are included in the manifold. By default, this option is disabled.
- Type: YES / NO
- Default:
NO - In config_template.cfg:
PREFERENTIAL_DIFFUSION= NO - Mentioned in: Changes in Version 8, Setup Guide: Species Transport and Combustion, Incompressible, Laminar Combustion Simulation
- Used in 2 test case files, for example:
laminar_premixed_h2_flame_cfd.cfg(YES),lam_prem_ch4_unsteady.cfg(NO) - Code:
CConfig.cppline 2395
CONV_FILENAME
Output file convergence history (w/o extension)
- Type: string
- Default:
string("history") - In config_template.cfg:
CONV_FILENAME= history - Mentioned in: Linear Elasticity, Realtime update of residuals and solution in paraview, Static Fluid-Structure Interaction (FSI)
- Used in 341 test case files, for example:
aeroelastic_NACA64A010.cfg(history),config.cfg(history_First),naca0012.cfg(0_history) - Code:
CConfig.cppline 2398
BREAKDOWN_FILENAME
Output file forces breakdown
More in config_template.cfg: Output file with the forces breakdown
- Type: string
- Default:
string("forces_breakdown.dat") - In config_template.cfg:
BREAKDOWN_FILENAME= forces_breakdown.dat - Used in 40 test case files, for example:
flow_cylinder.cfg(forces_breakdown.dat),disc_adj_heat.cfg(6rows_forces_breakdown.dat),actuatordisk_bem.cfg(forces_breakdown_actuatordisk_bem.dat) - Code:
CConfig.cppline 2400
SOLUTION_FILENAME
Restart flow input file (the file output under the filename set by RESTART_FLOW_FILENAME)
- Type: string
- Default:
string("solution") - In config_template.cfg:
SOLUTION_FILENAME= solution_flow - Mentioned in: Changes in Version 8, Guide to Version v7, Restart File, Setup Guide: Shape Optimization with the Discrete Adjoint, Setup Guide: Unsteady Flows and DES, Troubleshooting and 1 more
- Used in 356 test case files, for example:
aeroelastic_NACA64A010.cfg(solution_flow),air_nozzle_species.cfg(solution_flow_species),config.cfg(restart_flow) - Code:
CConfig.cppline 2402
SOLUTION_ADJ_FILENAME
Restart adjoint input file. Objective function abbreviation is expected.
- Type: string
- Default:
string("solution_adj") - In config_template.cfg:
SOLUTION_ADJ_FILENAME= solution_adj - Used in 242 test case files, for example:
inv_NACA0012.cfg(solution_adj),inv_NACA0012_discadj_multizone.cfg(solution_adj.dat),turb_nasa_binary.cfg(bin_solution_adj) - Code:
CConfig.cppline 2404
RESTART_FILENAME
Output file restart flow
- Type: string
- Default:
string("restart") - In config_template.cfg:
RESTART_FILENAME= restart_flow - Mentioned in: Changes in Version 8, Guide to Version v7, Restart File, Troubleshooting, Adjoint design optimization of a turbulent 3D pipe bend, Linear Elasticity and 1 more
- Used in 353 test case files, for example:
aeroelastic_NACA64A010.cfg(restart_flow),air_nozzle_species.cfg(restart_flow_species),inv_NACA0012_discadj_multizone.cfg(restart_flow.dat) - Code:
CConfig.cppline 2406
RESTART_ADJ_FILENAME
Output file restart adjoint. Objective function abbreviation will be appended.
- Type: string
- Default:
string("restart_adj") - In config_template.cfg:
RESTART_ADJ_FILENAME= restart_adj - Used in 240 test case files, for example:
inv_NACA0012.cfg(restart_adj),inv_NACA0012_discadj_multizone.cfg(restart_adj.dat),chtMaster.cfg(solution_adj) - Code:
CConfig.cppline 2408
VOLUME_FILENAME
Output file flow (w/o extension) variables
- Type: string
- Default:
string("vol_solution") - In config_template.cfg:
VOLUME_FILENAME= flow - Mentioned in: Guide to Version v7, Linear Elasticity, Realtime update of residuals and solution in paraview, Static Fluid-Structure Interaction (FSI)
- Used in 334 test case files, for example:
aeroelastic_NACA64A010.cfg(flow),configAD_fem.cfg(beam),configFEA.cfg(solid) - Code:
CConfig.cppline 2410
VOLUME_ADJ_FILENAME
-
Output file adjoint (w/o extension) variables
- Type: string
- Default:
string("adj_vol_solution") - In config_template.cfg:
VOLUME_ADJ_FILENAME= adjoint - Used in 227 test case files, for example:
inv_NACA0012.cfg(adjoint),chtMaster.cfg(flow_adj),configFEA.cfg(adjoint_solid) - Code:
CConfig.cppline 2413
GRAD_OBJFUNC_FILENAME
- Output objective function gradient
More in config_template.cfg: Output objective function gradient (using continuous adjoint)
- Type: string
- Default:
string("of_grad") - In config_template.cfg:
GRAD_OBJFUNC_FILENAME= of_grad - Mentioned in: Setup Guide: Shape Optimization with the Discrete Adjoint
- Used in 227 test case files, for example:
inv_NACA0012.cfg(of_grad),inv_NACA0012_discadj_multizone.cfg(of_grad.dat),chtMaster.cfg(of_grad.csv) - Code:
CConfig.cppline 2416
VALUE_OBJFUNC_FILENAME
- Output objective function
More in config_template.cfg: Output Objective function (in tecplot .dat or .csv format)
- Type: string
- Default:
string("of_func") - In config_template.cfg:
VALUE_OBJFUNC_FILENAME= of_eval - Used in 37 test case files, for example:
flow_cylinder.cfg(of_eval),turb_NACA0012_sst_multigrid_restart.cfg(of_eval.dat) - Code:
CConfig.cppline 2419
SURFACE_FILENAME
-
Output file surface flow coefficient (w/o extension)
- Type: string
- Default:
string("surface") - In config_template.cfg:
SURFACE_FILENAME= surface_flow - Mentioned in: Guide to Version v7
- Used in 303 test case files, for example:
aeroelastic_NACA64A010.cfg(surface_flow),configFlow.cfg(surface_fluid),lam_prem_ch4_cht_cfd_solid.cfg(surface_solid) - Code:
CConfig.cppline 2422
SURFACE_ADJ_FILENAME
-
Output file surface adjoint coefficient (w/o extension)
- Type: string
- Default:
string("surface_adjoint") - In config_template.cfg:
SURFACE_ADJ_FILENAME= surface_adjoint - Used in 221 test case files, for example:
inv_NACA0012.cfg(surface_adjoint),configFlow.cfg(adjoint_surface_fluid),trans_s809.cfg(trans_surface_adjoint) - Code:
CConfig.cppline 2425
SURFACE_SENS_FILENAME
-
Output file surface sensitivity (discrete adjoint) (w/o extension)
- Type: string
- Default:
string("surface_sens") - In config_template.cfg:
SURFACE_SENS_FILENAME= surface_sens - Used in 3 test case files, for example:
circles.cfg(surface_sens) - Code:
CConfig.cppline 2428
VOLUME_SENS_FILENAME
-
Output file volume sensitivity (discrete adjoint))
- Type: string
- Default:
string("volume_sens") - In config_template.cfg:
VOLUME_SENS_FILENAME= volume_sens - Code:
CConfig.cppline 2431
WRT_PERFORMANCE
Output the performance summary to the console at the end of SU2_CFD
- Type: YES / NO
- Default:
NO - In config_template.cfg:
WRT_PERFORMANCE= NO - Mentioned in: Setup Guide: Laminar-Turbulent Transition
- Used in 20 test case files, for example:
chtMaster.cfg(YES),config.cfg(NO) - Code:
CConfig.cppline 2433
WRT_AD_STATISTICS
Output the tape statistics (discrete adjoint)
- Type: YES / NO
- Default:
NO - In config_template.cfg:
WRT_AD_STATISTICS= NO - Used in 3 test case files, for example:
config_ad.cfg(NO),dsma661_sa_config.cfg(YES) - Code:
CConfig.cppline 2435
MARKER_ANALYZE_AVERAGE
Output averaged flow values on specified analyze marker. Options: AREA, MASSFLUX Use with MARKER_ANALYZE.
More in config_template.cfg: Method to compute the average value in MARKER_ANALYZE (AREA, MASSFLUX).
- Type: one of the values below
- Values:
AREA,MASSFLUX - Default:
MASSFLUX - In config_template.cfg:
MARKER_ANALYZE_AVERAGE = MASSFLUX - Mentioned in: Setup Guide: Turbomachinery, Shape Design With Multiple Objectives and Penalty Functions
- Used in 40 test case files, for example:
inv_wedge_ROE_multiobj.cfg(AREA),MFR_coupling.cfg(MASSFLUX) - Code:
CConfig.cppline 2440
COMM_LEVEL
- Level of MPI communications during runtime
More in config_template.cfg: MPI communication level (NONE, MINIMAL, FULL)
- Type: one of the values below
- Values:
NONE,MINIMAL,FULL - Default:
FULL - In config_template.cfg:
COMM_LEVEL= FULL - Code:
CConfig.cppline 2443