Documentation 6b54b78464
Loading...
Searching...
No Matches
Description of the Configuration Options

Group of variables that can be set using the configuration file. More...

Functions

void CConfig::SetConfig_Options ()
 Set the config options.
 

Detailed Description

Group of variables that can be set using the configuration file.

Function Documentation

◆ SetConfig_Options()

void CConfig::SetConfig_Options ( )

Set the config options.

CONFIG_CATEGORY: Problem Definition

SOLVER
DESCRIPTION: Type of solver
Options: see Solver_Map
DEFAULT: NONE

MULTIZONE
DESCRIPTION: Enable multizone mode

PHYSICAL_PROBLEM
DESCRIPTION: Physical governing equations
Options: see Solver_Map
DEFAULT: NONE

MATH_PROBLEM
DESCRIPTION: Mathematical problem
Options: DIRECT, ADJOINT

KIND_TURB_MODEL
DESCRIPTION: Specify turbulence model
Options: see Turb_Model_Map
DEFAULT: NONE

SST_OPTIONS
DESCRIPTION: Specify SST turbulence model options/corrections.
Options: see SST_Options_Map
DEFAULT: NONE

SST_OPTIONS
DESCRIPTION: Specify SA turbulence model options/corrections.
Options: see SA_Options_Map
DEFAULT: NONE

KIND_INCOMP_SYSTEM
DESCRIPTION: Incomp type
OPTIONS: see Incomp_Map DEFAULT: NONE

KIND_PB_ITER
DESCRIPTION: Kind_PBIter
OPTIONS: see PBIter_Map

ROUGHSST_OPTIONS
DESCRIPTION: Specify type of boundary condition for rough walls for SST turbulence model.
Options: see ROUGHSST_Options_Map
DEFAULT: wilcox1998

KIND_TRANS_MODEL
DESCRIPTION: Specify transition model OPTIONS: see Trans_Model_Map
DEFAULT: NONE

SST_OPTIONS
DESCRIPTION: Specify LM transition model options/correlations.
Options: see LM_Options_Map
DEFAULT: NONE

HROUGHNESS
DESCRIPTION: Value of RMS roughness for transition model
DEFAULT: 1E-6

KIND_SCALAR_MODEL
DESCRIPTION: Specify scalar transport model
Options: see Scalar_Model_Map
DEFAULT: NONE

KIND_SGS_MODEL
DESCRIPTION: Specify subgrid scale model OPTIONS: see SGS_Model_Map
DEFAULT: NONE

KIND_FEM_DG_SHOCK
DESCRIPTION: Specify shock capturing method for DG OPTIONS: see ShockCapturingDG_Map
DEFAULT: NONE

KIND_VERIFICATION_SOLUTION
DESCRIPTION: Specify the verification solution OPTIONS: see Verification_Solution_Map
DEFAULT: NO_VERIFICATION_SOLUTION

KIND_MATRIX_COLORING
DESCRIPTION: Specify the method for matrix coloring for Jacobian computations OPTIONS: see MatrixColoring_Map
DEFAULT GREEDY_COLORING

WEAKLY_COUPLED_HEAT_EQUATION
DESCRIPTION: Enable heat equation for incompressible flows.

RESTART_SOL
DESCRIPTION: Restart solution from native solution file
Options: NO, YES

WRT_RESTART_COMPACT
DESCRIPTION: Minimize the size of restart files
Options: NO, YES

VOLUME_OUTPUT_PRECISION
DESCRIPTION: Floating-point type of the fields of the volume and surface files (CGNS and Paraview XML), the coordinates are always written in double precision by the CGNS writer.
Options: SINGLE, DOUBLE

BINARY_RESTART
DESCRIPTION: Read binary SU2 native restart files.
Options: YES, NO

WRT_RESTART_OVERWRITE
DESCRIPTION: overwrite restart files or append iteration number.
Options: YES, NO

WRT_SURFACE_OVERWRITE
DESCRIPTION: overwrite visualisation files or append iteration number.
Options: YES, NO

WRT_VOLUME_OVERWRITE
DESCRIPTION: overwrite visualisation files or append iteration number.
Options: YES, NO

SYSTEM_MEASUREMENTS
DESCRIPTION: System of measurements
OPTIONS: see Measurements_Map
DEFAULT: SI

MULTIZONE_ADAPT_FILENAME
DESCRIPTION: Append zone number to restart and solution filenames.

CONFIG_CATEGORY: FluidModel

FLUID_MODEL
DESCRIPTION: Fluid model
OPTIONS: See FluidModel_Map
DEFAULT: STANDARD_AIR

FLUID_NAME
DESCRIPTION: Fluid name
OPTIONS: see coolprop homepage
DEFAULT: nitrogen

CONFIG_CATEGORY: Data-driven fluid model parameters

INTERPOLATION_METHOD
DESCRIPTION: Interpolation method used to determine the thermodynamic state of the fluid.
OPTIONS: See DataDrivenMethod_Map DEFAULT: MLP

FILENAME_INTERPOLATOR
DESCRIPTION: Input file for the interpolation method.

DATADRIVEN_NEWTON_RELAXATION
DESCRIPTION: Relaxation factor for Newton solvers in data-driven fluid model.

\biref USE_PINN
DESCRIPTION: Use physics-informed approach for the entropy-based fluid model.

CONFINEMENT_PARAM
DESCRIPTION: Input Confinement Parameter for Vorticity Confinement

CONFIG_CATEGORY: Freestream Conditions

GAS_CONSTANT
DESCRIPTION: Specific gas constant (287.058 J/kg*K (air), only for compressible flows)

GAMMA_VALUE
DESCRIPTION: Ratio of specific heats (1.4 (air), only for compressible flows)

THERMODYNAMIC_PRESSURE
DESCRIPTION: Thermodynamics(operating) Pressure (101325 Pa), only for incompressible flows)

CP_VALUE
DESCRIPTION: Specific heat at constant pressure, Cp (1004.703 J/kg*K (air), constant density incompressible fluids only)

THERMAL_EXPANSION_COEFF
DESCRIPTION: Thermal expansion coefficient (0.00347 K^-1 (air), used for Boussinesq approximation for liquids/non-ideal gases)

MOLECULAR_WEIGHT
DESCRIPTION: Molecular weight for an incompressible ideal gas (28.96 g/mol (air) default)

  • DESCRIPTION: Specify if Mutation++ library is used *‍/

INLET_TEMPERATURE_VE
DESCRIPTION: NEMO inlet temperature_ve (K), if left 0 K, set to Ttr value

MARKER_MONITORING
DESCRIPTION: Marker(s) of the surface where evaluate the non-dimensional coefficients

VISCOSITY_MODEL
DESCRIPTION: model of the viscosity
OPTIONS: See ViscosityModel_Map
DEFAULT: SUTHERLAND

MIXINGVISCOSITY_MODEL
DESCRIPTION: Mixing model of the viscosity
OPTIONS: See ViscosityModel_Map
DEFAULT: DAVIDSON

REYNOLDS_NUMBER
DESCRIPTION: Reynolds number (non-dimensional, based on the free-stream values). Needed for viscous solvers. For incompressible solvers the Reynolds length will always be 1.0
DEFAULT: 0.0

REYNOLDS_LENGTH
DESCRIPTION: Reynolds length (1 m by default). Used for compressible solver: incompressible solver will use 1.0.

PRANDTL_LAM
DESCRIPTION: Laminar Prandtl number (0.72 (air), only for compressible flows)
DEFAULT: 0.72

PRANDTL_TURB
DESCRIPTION: Turbulent Prandtl number (0.9 (air), only for compressible flows)
DEFAULT 0.90

WALLMODEL_KAPPA
DESCRIPTION: von Karman constant used for the wall model
DEFAULT 0.41

WALLMODEL_MAXITER
DESCRIPTION: Max iterations used for the wall model
DEFAULT 200

WALLMODEL_RELFAC
DESCRIPTION: Relaxation factor used for the wall model
DEFAULT 0.5

WALLMODEL_MINYPLUS
DESCRIPTION: lower limit for Y+ used for the wall model
DEFAULT 5.0

WALLMODEL_B
DESCRIPTION: constant B used for the wall model
DEFAULT 5.5

BULK_MODULUS
DESCRIPTION: Value of the Bulk Modulus
DEFAULT 1.42E5

MACH_NUMBER
DESCRIPTION: Mach number (non-dimensional, based on the free-stream values). 0.0 by default

INIT_OPTION
DESCRIPTION: Init option to choose between Reynolds or thermodynamics quantities for initializing the solution
OPTIONS: see InitOption_Map
DEFAULT REYNOLDS

INIT_OPTION_INC
DESCRIPTION: Init option for the incompressible solver to choose between the initial density and the operating pressure for initializing the solution
OPTIONS: see InitOptionInc_Map
DEFAULT: fluid model dependent

FREESTREAM_PRESSURE
DESCRIPTION: Free-stream pressure (101325.0 N/m^2 by default)

FREESTREAM_DENSITY
DESCRIPTION: Free-stream density (1.2886 Kg/m^3 (air), 998.2 Kg/m^3 (water))
DEFAULT -1.0 (calculated from others)

FREESTREAM_TEMPERATURE
DESCRIPTION: Free-stream temperature (288.15 K by default)

FREESTREAM_TEMPERATURE_VE
DESCRIPTION: Free-stream vibrational-electronic temperature (288.15 K by default)

ENERGY_EQUATION
DESCRIPTION: Solve the energy equation in the incompressible flow solver.

TEMPERATURE_LIMITS
DESCRIPTION: Temperature limits for incompressible flows (0.0, 5000 K by default)

INC_DENSITY_REF
DESCRIPTION: Reference density for incompressible flows

INC_VELOCITY_REF
DESCRIPTION: Reference velocity for incompressible flows (1.0 by default)

INC_TEMPERATURE_REF
DESCRIPTION: Reference temperature for incompressible flows with the energy equation (1.0 by default)

INC_DENSITY_INIT
DESCRIPTION: Initial density for incompressible flows (1.2886 kg/m^3 by default)

INC_VELOCITY_INIT
DESCRIPTION: Initial velocity for incompressible flows (1.0,0,0 m/s by default)

INC_TEMPERATURE_INIT
DESCRIPTION: Initial temperature for incompressible flows with the energy equation (288.15 K by default)

INC_NONDIM
DESCRIPTION: Non-dimensionalization scheme for incompressible flows.

INC_INLET_DAMPING
DESCRIPTION: Damping factor applied to the iterative updates to the velocity at a pressure inlet in incompressible flow (0.1 by default).

INC_OUTLET_DAMPING
DESCRIPTION: Damping factor applied to the iterative updates to the pressure at a mass flow outlet in incompressible flow (0.1 by default).

SPECIES_INIT
DESCRIPTION: Initial values for scalar transport

SPECIES_CLIPPING
DESCRIPTION: Activate clipping for scalar transport equations
DEFAULT: false

SPECIES_CLIPPING_MAX
DESCRIPTION: Maximum values for scalar clipping

SPECIES_CLIPPING_MIN
DESCRIPTION: Minimum values for scalar clipping

FLAME_INIT_METHOD
DESCRIPTION: Ignition method for flamelet solver
DEFAULT: no ignition; cold flow only.

FLAME_ENTHALPY_BC
DESCRIPTION: enthalpy BC for thermal walls. FLOW_MARKERS (default): enthalpy derived from MARKER_ISOTHERMAL temperature or MARKER_HEATFLUX via GetEnthFromTemp. SPECIES_MARKERS: enthalpy and all other scalars taken directly from MARKER_WALL_SPECIES or the Python wrapper (SetMarkerCustomScalar).
DEFAULT: FLOW_MARKERS

FLAME_INIT
DESCRIPTION: flame front initialization using the flamelet model

SPARK_INIT
DESCRIPTION: spark initialization using the flamelet model

SPARK_REACTION_RATES
DESCRIPTION: Net source term values applied to species within spark area during spark ignition.

THICKENED_FLAME_CORRECTION
DESCRIPTION: Coarse grid correction for source terms and diffusive fluxes in reacting flows.

FLAME_INIT_IGNITION
DESCRIPTION: Ignition temperature for the flame initialization

DIFFUSIVITY_MODEL
DESCRIPTION: mass diffusivity model
DEFAULT constant disffusivity

DIFFUSIVITY_CONSTANT
DESCRIPTION: mass diffusivity if DIFFUSIVITYMODEL::CONSTANT_DIFFUSIVITY is chosen
DEFAULT 0.001 (Air)

SCHMIDT_LAM
DESCRIPTION: Laminar Schmidt number of mass diffusion
DEFAULT 1.0 (~for Gases)

SCHMIDT_TURB
DESCRIPTION: Turbulent Schmidt number of mass diffusion
DEFAULT 0.70 (more or less experimental value)

DESCRIPTION: Constant Lewis number for mass diffusion

FREESTREAM_VELOCITY
DESCRIPTION: Free-stream velocity (m/s)

AOA
DESCRIPTION: Angle of attack (degrees, only for compressible flows)

CONFIG_CATEGORY: Reference Conditions

REF_ORIGIN_MOMENT_X
DESCRIPTION: X Reference origin for moment computation

REF_ORIGIN_MOMENT_Y
DESCRIPTION: Y Reference origin for moment computation

REF_ORIGIN_MOMENT_Z
DESCRIPTION: Z Reference origin for moment computation

REF_AREA
DESCRIPTION: Reference area for force coefficients (0 implies automatic calculation)

SEMI_SPAN
DESCRIPTION: Wing semi-span (0 implies automatic calculation)

REF_LENGTH
DESCRIPTION: Reference length for pitching, rolling, and yawing non-dimensional moment

REF_SHARP_EDGES
DESCRIPTION: Reference coefficient for detecting sharp edges

REF_VELOCITY
DESCRIPTION: Reference velocity (incompressible only)

CONFIG_CATEGORY: Boundary Markers

MARKER_PLOTTING
DESCRIPTION: Marker(s) of the surface in the surface flow solution file

MARKER_MONITORING
DESCRIPTION: Marker(s) of the surface where evaluate the non-dimensional coefficients

MARKER_CREATE_COPY
DESCRIPTION: Marker(s) for which to create copies when reading the mesh

MARKER_CONTROL_VOLUME
DESCRIPTION: Marker(s) of the surface in the surface flow solution file

MARKER_DESIGNING
DESCRIPTION: Marker(s) of the surface where objective function (design problem) will be evaluated

GEO_MARKER
DESCRIPTION: Marker(s) of the surface where evaluate the geometrical functions

MARKER_EULER
DESCRIPTION: Euler wall boundary marker(s)

MARKER_FAR
DESCRIPTION: Far-field boundary marker(s)

MARKER_SYM
DESCRIPTION: Symmetry boundary condition

MARKER_NEARFIELD
DESCRIPTION: Near-Field boundary condition

MARKER_FLUID_INTERFACE
DESCRIPTION: Fluid interface boundary marker(s)

MARKER_DEFORM_MESH
DESCRIPTION: Deformable marker(s) at the interface

MARKER_DEFORM_MESH_SYM_PLANE
DESCRIPTION: Symmetry plane for mesh deformation only

MARKER_DEFORM_MESH_INTERNAL
DESCRIPTION: Internal marker for mesh deformation only

MARKER_FLUID_LOAD
DESCRIPTION: Marker(s) in which the flow load is computed/applied

MARKER_FSI_INTERFACE
DESCRIPTION: ZONE interface boundary marker(s)

MARKER_CHT_INTERFACE
DESCRIPTION: CHT interface boundary marker(s)

CHT_INTERFACE_CONTACT_RESISTANCE: Thermal contact resistance values for each CHT inerface.

MARKER_PYTHON_CUSTOM
DESCRIPTION: Python customizable marker(s)

PYTHON_CUSTOM_SOURCE
DESCRIPTION: Python custom source

MARKER_WALL_FUNCTIONS
DESCRIPTION: Viscous wall markers for which wall functions must be applied. Format: (Wall function marker, wall function type, ...)

MARKER_STRONG_BC
DESCRIPTION: Markers where a strong BC must be applied.

ACTDISK_TYPE
DESCRIPTION: Actuator Disk boundary type
OPTIONS: see ActDisk_Map
Default: VARIABLES_JUMP

MARKER_ACTDISK
DESCRIPTION:

MARKER_ACTDISK_BEM_CG
DESCRIPTION: Actuator disk CG for blade element momentum (BEM) method.

MARKER_ACTDISK_BEM_AXIS
DESCRIPTION: Actuator disk axis for blade element momentum (BEM) method.

ACTDISK_FILENAME
DESCRIPTION: Input file for a specified actuator disk (w/ extension)
DEFAULT: actdiskinput.dat

INLET_TYPE
DESCRIPTION: Inlet boundary type
OPTIONS: see Inlet_Map
DEFAULT: TOTAL_CONDITIONS

INLET_USE_NORMAL
DESCRIPTION: Use the local boundary normal for the flow direction with pressure inlets.

INC_INLET_TYPE
DESCRIPTION: List of inlet types for incompressible flows. List length must match number of inlet markers. Options: VELOCITY_INLET, PRESSURE_INLET, INPUT_FILE.

INLET_FILENAME
DESCRIPTION: Input file for a specified inlet profile (w/ extension)
DEFAULT: inlet.dat

INLET_MATCHING_TOLERANCE
DESCRIPTION: If a file is provided to specify the inlet profile, this tolerance will be used to match the coordinates in the input file to the points on the grid.
DEFAULT: 1E-6

MARKER_INLET
DESCRIPTION: Inlet boundary marker(s) with the following formats, Total Conditions: (inlet marker, total temp, total pressure, flow_direction_x, flow_direction_y, flow_direction_z, ... ) where flow_direction is a unit vector. Mass Flow: (inlet marker, density, velocity magnitude, flow_direction_x, flow_direction_y, flow_direction_z, ... ) where flow_direction is a unit vector.

MARKER_INLET_SPECIES
DESCRIPTION: Inlet Species boundary marker(s) with the following format Inlet Species: (inlet_marker, Species1, Species2, ..., SpeciesN-1, inlet_marker2, Species1, Species2, ...)

MARKER_INLET_TURBULENT
DESCRIPTION: Inlet Turbulence boundary marker(s) with the following format Inlet Turbulent: (inlet_marker, TurbulentIntensity1, ViscosityRatio1, inlet_marker2, TurbulentIntensity2, ViscosityRatio2, ...)

MARKER_RIEMANN
DESCRIPTION: Riemann boundary marker(s) with the following formats, a unit vector.
OPTIONS: See Riemann_Map. The variables indicated by the option and the flow direction unit vector must be specified.

MARKER_WALL_SPECIES
DESCRIPTION: Wall species boundary marker(s) with the following format: (marker_name, BC_TYPE, value, BC_TYPE, value, ...) where BC_TYPE is either FLUX (Neumann) or VALUE (Dirichlet). Each marker must specify the same number of species (N species per marker).
OPTIONS: See Wall_Map.

MARKER_GILES
DESCRIPTION: Giles boundary marker(s) with the following formats, a unit vector.

SPATIAL_FOURIER
DESCRIPTION: Option to compute the spatial fourier trasformation for the Giles BC.

GILES_EXTRA_RELAXFACTOR
DESCRIPTION: the 1st coeff the value of the under relaxation factor to apply to the shroud and hub, the 2nd coefficient is the the percentage of span-wise height influenced by this extra under relaxation factor.

AVERAGE_PROCESS_TYPE
DESCRIPTION: types of mixing process for averaging quantities at the boundaries.
OPTIONS: see MixingProcess_Map
DEFAULT: AREA_AVERAGE

AVERAGE_PROCESS_KIND
DESCRIPTION: types of mixing process for averaging quantities at the boundaries.
OPTIONS: see MixingProcess_Map
DEFAULT: AREA_AVERAGE

PERFORMANCE_AVERAGE_PROCESS_KIND
DESCRIPTION: types of mixing process for averaging quantities at the boundaries for performance computation.
OPTIONS: see MixingProcess_Map
DEFAULT: AREA_AVERAGE

MIXEDOUT_COEFF
DESCRIPTION: the 1st coeff is an under relaxation factor for the Newton method, the 2nd coefficient is the tolerance for the Newton method, 3rd coefficient is the maximum number of iteration for the Newton Method.

RAMP_MOTION_FRAME
DESCRIPTION: option to ramp up or down the frame of motion velocity value

RAMP_MOTION_FRAME_COEFF
DESCRIPTION: the 1st coeff is the staring outlet value, the 2nd coeff is the number of iterations for the update, 3rd is the number of total iteration till reaching the final outlet pressure value

RAMP_OUTLET
DESCRIPTION: option to ramp up or down the Giles outlet value

RAMP_OUTLET_COEFF
DESCRIPTION: the 1st coeff is the staring outlet value, the 2nd coeff is the number of iterations for the update, 3rd is the number of total iteration till reaching the final outlet pressure value

MARKER_MIXINGPLANE
DESCRIPTION: Identify the boundaries in which the mixing plane is applied.

TURBULENT_MIXINGPLANE
DESCRIPTION: Activate mixing plane also for turbulent quantities

RELATIVE_FRAME_SLIDINGPLANE
DESCRIPTION: Activate sliding plane for relative frame

MARKER_TURBOMACHINERY
DESCRIPTION: Identify the boundaries for which the turbomachinery settings are applied.

NUM_SPANWISE_SECTIONS
DESCRIPTION: Integer number of spanwise sections to compute 3D turbo BC and Performance for turbomachinery

SPANWISE_KIND
DESCRIPTION: type of algorithm to identify the span-wise sections at the turbo boundaries.
OPTIONS: see SpanWise_Map
Default: AUTOMATIC

TURBOMACHINERY_KIND
DESCRIPTION: types of turbomachinery architecture.
OPTIONS: see TurboMachinery_Map
Default: AXIAL

TURBOMACHINERY_KIND
DESCRIPTION: types of turbomachynery Performance Calculations.
OPTIONS: see TurboPerfKind_Map
Default: TURBINE

MARKER_SHROUD
DESCRIPTION: markers in which velocity is forced to 0.0.
Format: (shroud1, shroud2, ...)

MARKER_SUPERSONIC_INLET
DESCRIPTION: Supersonic inlet boundary marker(s)
Format: (inlet marker, temperature, static pressure, velocity_x, velocity_y, velocity_z, ... ), i.e. primitive variables specified.

MARKER_SUPERSONIC_OUTLET
DESCRIPTION: Supersonic outlet boundary marker(s)

MARKER_OUTLET
DESCRIPTION: Outlet boundary marker(s)
Format: ( outlet marker, back pressure (static), ... )

INC_INLET_TYPE
DESCRIPTION: List of outlet types for incompressible flows. List length must match number of inlet markers. Options: PRESSURE_OUTLET, MASS_FLOW_OUTLET.

MARKER_ISOTHERMAL DESCRIPTION: Isothermal wall boundary marker(s)
Format: ( isothermal marker, wall temperature (static), ... ) <>

MARKER_HEATFLUX
DESCRIPTION: Specified heat flux wall boundary marker(s) Format: ( Heat flux marker, wall heat flux (static), ... )

INTEGRATED_HEATFLUX
DESCRIPTION: Prescribe Heatflux in [W] instead of [W/m^2] \

MARKER_HEATTRANSFER DESCRIPTION: Heat flux with specified heat transfer coefficient boundary marker(s)
Format: ( Heat transfer marker, heat transfer coefficient, wall temperature (static), ... ) <>

Smoluchowski/Maxwell wall boundary marker(s)
DESCRIPTION: Slip velocity and temperature jump wall boundary marker(s) Format: ( Heat flux marker, wall temperature (static), momentum accomodation coefficient, thermal accomodation coefficient ... )

WALL_ROUGHNESS
DESCRIPTION: Specified roughness heights at wall boundary marker(s) Format: ( Wall marker, roughness_height (static), ... )

MARKER_ENGINE_INFLOW
DESCRIPTION: Engine inflow boundary marker(s) Format: ( nacelle inflow marker, fan face Mach, ... )

SUBSONIC_ENGINE
DESCRIPTION: Engine subsonic intake region

SINE_LOAD
DESCRIPTION: option to apply the load as a sine

SINE_LOAD_COEFF
DESCRIPTION: the 1st coeff is the amplitude, the 2nd is the frequency, 3rd is the phase in radians

RAMP_AND_RELEASE
DESCRIPTION: release the load after applying the ramp

ENGINE_INFLOW_TYPE
DESCRIPTION: Inlet boundary type
OPTIONS: see Engine_Inflow_Map
Default: FAN_FACE_MACH

CONFIG_CATEGORY: Time-marching

CFL_REDUCTION_SPECIES
DESCRIPTION: Reduction factor of the CFL coefficient in the species problem
DEFAULT: 1.0

CONFIG_CATEGORY: Linear solver definition

LINEAR_SOLVER
DESCRIPTION: Linear solver for the implicit, mesh deformation, or discrete adjoint systems
OPTIONS: see Linear_Solver_Map
DEFAULT: FGMRES

LINEAR_SOLVER_PREC
DESCRIPTION: Preconditioner for the Krylov linear solvers
OPTIONS: see Linear_Solver_Prec_Map
DEFAULT: LU_SGS

LINEAR_SOLVER
DESCRIPTION: Linear solver for the poisson system
OPTIONS: see Linear_Solver_Map
DEFAULT: FGMRES

LINEAR_SOLVER_PREC
DESCRIPTION: Preconditioner for the Krylov linear solvers
OPTIONS: see Linear_Solver_Prec_Map
DEFAULT: LU_SGS

\DESCRIPTION: Automatically compute relaxation factors for flow corrections in the SIMPLE algorithm

CONFIG_CATEGORY: Convergence

CONV_FIELD
DESCRIPTION: Output field to monitor
Default: depends on solver

CONV_RESIDUAL_MINVAL
DESCRIPTION: Min value of the residual (log10 of the residual)
DEFAULT: -14.0

CONV_STARTITER
DESCRIPTION: Iteration number to begin convergence monitoring
DEFAULT: 5

CONV_CAUCHY_ELEMS
DESCRIPTION: Number of elements to apply the criteria.
DEFAULT 100

CONV_CAUCHY_EPS
DESCRIPTION: Epsilon to control the series convergence
DEFAULT: 1e-10

CONV_WINDOW_STARTITER
DESCRIPTION: Iteration number after START_ITER_WND to begin convergence monitoring
DEFAULT: 15

CONV_WINDOW_CAUCHY_EPS
DESCRIPTION: Epsilon to control the series convergence
DEFAULT: 1e-3

CONV_WINDOW_CAUCHY_ELEMS
DESCRIPTION: Number of elements to apply the criteria.
DEFAULT 100

WINDOW_CAUCHY_CRIT
DESCRIPTION: Determines, if the cauchy convergence criterion should be used for windowed time averaged objective functions

CONV_WINDOW_FIELD
DESCRIPTION: Output fields for the Cauchy criterium for the TIME iteration. The criterium is applied to the windowed time average of the chosen funcion.

CONFIG_CATEGORY: Multi-grid

MGLEVEL
DESCRIPTION: Multi-grid Levels. DEFAULT: 0

MGCYCLE
DESCRIPTION: Multi-grid cycle. OPTIONS: See MG_Cycle_Map. Defualt V_CYCLE

MG_PRE_SMOOTH
DESCRIPTION: Multi-grid pre-smoothing level

MG_POST_SMOOTH
DESCRIPTION: Multi-grid post-smoothing level

MG_CORRECTION_SMOOTH
DESCRIPTION: Jacobi implicit smoothing of the correction

MG_DAMP_RESTRICTION
DESCRIPTION: Damping factor for the residual restriction. DEFAULT: 0.75

MG_DAMP_PROLONGATION
DESCRIPTION: Damping factor for the correction prolongation. DEFAULT 0.75

MG_SMOOTH_EARLY_EXIT
DESCRIPTION: Enable early exit for MG smoothing when RMS drops below threshold. DEFAULT: NO

MG_SMOOTH_RES_THRESHOLD
DESCRIPTION: Early exit smoothing when current_rms drops below threshold * initial_rms. DEFAULT: 0.9

MG_SMOOTH_OUTPUT
DESCRIPTION: Print compact per-cycle smoothing iteration summary. DEFAULT: NO

MG_SMOOTH_STAGNATION_TOL
DESCRIPTION: Stop smoothing if current_rms >= previous_rms * this value. Values < 1.0 enable early exit on stagnation, 1.0 only exits on defect growth. DEFAULT: 0.99

MG_SMOOTH_COEFF
DESCRIPTION: Smoothing coefficient for the correction prolongation Jacobi smoother. DEFAULT: 1.25

MG_MIN_MESHSIZE
DESCRIPTION: Minimum number of CVs on the coarsest multigrid level, counted over the whole level rather than per rank, so the hierarchy does not change with the number of ranks. DEFAULT: 500

MG_IMPLICIT_LINES
DESCRIPTION: Pave the coarse grid with advancing fronts raised from boundaries that carry a stretched layer normal to themselves. DEFAULT: NO

MG_STARTUP_ITER
DESCRIPTION: Max number of iterations spent on each mesh during the Full Multigrid (FMG) startup phase. DEFAULT: 100

MG_STARTUP_CONVERGENCE
DESCRIPTION: During the startup phase of Full-MG, leave the current level once CONV_FIELD has dropped by this many orders of magnitude relative to its value when the level became active. DEFAULT: -2

MG_STARTUP_STAGNATION
DESCRIPTION: Full-MG promotion on stagnation. If the active level's residual ratio between successive iterations exceeds this value for MG_STARTUP_STAGNATION_ITER consecutive iterations, promote to the next finer level without waiting out MG_STARTUP_ITER. 0 disables it. DEFAULT: 0.99

MG_STARTUP_STAGNATION_ITER
DESCRIPTION: Consecutive stalled iterations required before Full-MG promotes on stagnation. 0 disables it, as MG_STARTUP_STAGNATION= 0 does. DEFAULT: 5

MG_CFL_SCALING
DESCRIPTION: Per-level CFL scaling factors for coarse MG levels. Entry i is the ratio CFL(i+1)/CFL(i). If fewer values than nMGLevels are given, the last value is repeated. DEFAULT: 0.25 (i.e., 1/4 per level)

CONFIG_CATEGORY: Spatial Discretization

NUM_METHOD_GRAD
DESCRIPTION: Numerical method for spatial gradients
OPTIONS: See Gradient_Map.
DEFAULT: WEIGHTED_LEAST_SQUARES.

NUM_METHOD_GRAD
DESCRIPTION: Numerical method for spatial gradients used only for upwind reconstruction
OPTIONS: See Gradient_Map.
DEFAULT: NO_GRADIENT.

VENKAT_LIMITER_COEFF
DESCRIPTION: Coefficient for the limiter. DEFAULT value 0.05. Larger values decrease the extent of limiting, values approaching zero cause lower-order approximation to the solution.

ADJ_SHARP_LIMITER_COEFF
DESCRIPTION: Coefficient for detecting the limit of the sharp edges. DEFAULT value 3.0. Use with sharp edges limiter.

LIMITER_ITER
DESCRIPTION: Freeze the value of the limiter after a number of iterations. DEFAULT value 999999.

CONV_NUM_METHOD_FLOW
DESCRIPTION: Convective numerical method
OPTIONS: See Upwind_Map , Centered_Map.

NUM_METHOD_FEM_FLOW
DESCRIPTION: Numerical method
OPTIONS: See FEM_Map , Centered_Map.

MUSCL_FLOW
DESCRIPTION: Check if the MUSCL scheme should be used

MUSCL_KAPPA_FLOW
DESCRIPTION: Blending coefficient for the U-MUSCL scheme

RAMP_MUSCL
DESCRIPTION: Enable ramping of the MUSCL scheme from 1st to 2nd order using specified method

brief RAMP_MUSCL_COEFF
DESCRIPTION: the 1st coeff is the ramp start iteration, the 2nd coeff is the iteration update frequenct, 3rd coeff is the total number of iterations

RAMP_MUSCL_POWER
DESRCIPTION: Exponent of the MUSCL ramp formulation

KIND_MUSCL_RAMP
DESCRIPTION: The kind of MUSCL Ramp to be applied

SLOPE_LIMITER_FLOW DESCRIPTION: Slope limiter for the direct solution.
OPTIONS: See Limiter_Map
DEFAULT VENKATAKRISHNAN

JST_SENSOR_COEFF
DESCRIPTION: 2nd and 4th order artificial dissipation coefficients for the JST method

LAX_SENSOR_COEFF
DESCRIPTION: 1st order artificial dissipation coefficients for the Lax-Friedrichs method.

USE_ACCURATE_FLUX_JACOBIANS
DESCRIPTION: Use numerically computed Jacobians for AUSM+up(2) and SLAU(2)

CENTRAL_JACOBIAN_FIX_FACTOR
DESCRIPTION: Improve the numerical properties (diagonal dominance) of the global Jacobian matrix, 3 to 4 is "optimum" (central schemes)

CENTRAL_JACOBIAN_FIX_FACTOR
DESCRIPTION: Control numerical properties of the global Jacobian matrix using a multiplication factor for incompressible central schemes

CONV_NUM_METHOD_ADJFLOW
DESCRIPTION: Convective numerical method for the adjoint solver.
OPTIONS: See Upwind_Map , Centered_Map. Note: not all methods are guaranteed to be implemented for the adjoint solver.

MUSCL_ADJFLOW
DESCRIPTION: Check if the MUSCL scheme should be used

MUSCL_KAPPA_ADJFLOW
DESCRIPTION: Blending coefficient for the U-MUSCL scheme

SLOPE_LIMITER_ADJFLOW DESCRIPTION: Slope limiter for the adjoint solution.
OPTIONS: See Limiter_Map
DEFAULT VENKATAKRISHNAN

ADJ_JST_SENSOR_COEFF
DESCRIPTION: 2nd and 4th order artificial dissipation coefficients for the adjoint JST method.

LAX_SENSOR_COEFF
DESCRIPTION: 1st order artificial dissipation coefficients for the adjoint Lax-Friedrichs method.

MUSCL_TURB
DESCRIPTION: Check if the MUSCL scheme should be used

MUSCL_KAPPA_TURB
DESCRIPTION: Blending coefficient for the U-MUSCL scheme

SLOPE_LIMITER_TURB
DESCRIPTION: Slope limiter
OPTIONS: See Limiter_Map
DEFAULT VENKATAKRISHNAN

CONV_NUM_METHOD_TURB
DESCRIPTION: Convective numerical method

USE_ACCURATE_TURB_JACOBIANS
DESCRIPTION: Use numerically computed Jacobians for Standard SA model

MUSCL_ADJTURB
DESCRIPTION: Check if the MUSCL scheme should be used

SLOPE_LIMITER_ADJTURB
DESCRIPTION: Slope limiter
OPTIONS: See Limiter_Map
DEFAULT VENKATAKRISHNAN

CONV_NUM_METHOD_ADJTURB
DESCRIPTION: Convective numerical method for the adjoint/turbulent problem

MUSCL_SPECIES
DESCRIPTION: Check if the MUSCL scheme should be used
DEFAULT false

MUSCL_KAPPA_SPECIES
DESCRIPTION: Blending coefficient for the U-MUSCL scheme

SLOPE_LIMITER_SPECIES
DESCRIPTION: Slope limiter
OPTIONS: See Limiter_Map
DEFAULT NONE

CONV_NUM_METHOD_SPECIES
DESCRIPTION: Convective numerical method for species transport

MUSCL_HEAT
DESCRIPTION: Check if the MUSCL scheme should be used

MUSCL_KAPPA_HEAT
DESCRIPTION: Blending coefficient for the U-MUSCL scheme

SLOPE_LIMITER_HEAT
DESCRIPTION: Slope limiter
OPTIONS: See Limiter_Map
DEFAULT NONE

CONV_NUM_METHOD_HEAT
DESCRIPTION: Convective numerical method

CONFIG_CATEGORY: Adjoint and Gradient

LIMIT_ADJFLOW
DESCRIPTION: Limit value for the adjoint variable.
DEFAULT: 1E6.

MG_ADJFLOW
DESCRIPTION: Multigrid with the adjoint problem.
Defualt: YES

OBJECTIVE_WEIGHT
DESCRIPTION: Adjoint problem boundary condition weights. Applies scaling factor to objective(s)

OBJECTIVE_FUNCTION
DESCRIPTION: Adjoint problem boundary condition
OPTIONS: see Objective_Map
DEFAULT: DRAG_COEFFICIENT

CUSTOM_OBJFUNC
DESCRIPTION: User-provided definition of a custom objective function.

CUSTOM_OUTPUTS
DESCRIPTION: User-provided definitions for custom output.

SENS_REMOVE_SHARP
DESCRIPTION: Remove sharp edges from the sensitivity evaluation
Format: SENS_REMOVE_SHARP = YES
DEFAULT: NO

CONFIG_CATEGORY: Sobolev Gradient Solver Parameters

HESS_OBJFUNC_FILENAME
DESCRIPTION: Output filename for the Sobolev Hessian approximation.

CONFIG_CATEGORY: Input/output files and formats

OUTPUT_FORMAT
DESCRIPTION: I/O format for output plots.
OPTIONS: see TabOutput_Map
DEFAULT: TECPLOT

OUTPUT_PRECISION
DESCRIPTION: 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.
DEFAULT: 10

ACTDISK_JUMP
DESCRIPTION: The jump is given by the difference in values or a ratio

MESH_FORMAT
DESCRIPTION: Mesh input file format
OPTIONS: see Input_Map
DEFAULT: SU2

MESH_OUT_FORMAT
DESCRIPTION: Mesh output file format
OPTIONS: see OutputMesh_Map
DEFAULT: SU2

MESH_OUT_FILENAME
DESCRIPTION: Mesh output file name. Used when converting, scaling, or deforming a mesh.
DEFAULT: mesh_out

CONV_FILENAME
DESCRIPTION: Output file convergence history (w/o extension)
DEFAULT: history

BREAKDOWN_FILENAME
DESCRIPTION: Output file forces breakdown

SOLUTION_FLOW_FILENAME
DESCRIPTION: Restart flow input file (the file output under the filename set by RESTART_FLOW_FILENAME)
DEFAULT: solution_flow.dat

SOLUTION_ADJ_FILENAME
DESCRIPTION: Restart adjoint input file. Objective function abbreviation is expected.

RESTART_FLOW_FILENAME
DESCRIPTION: Output file restart flow

RESTART_ADJ_FILENAME
DESCRIPTION: Output file restart adjoint. Objective function abbreviation will be appended.

VOLUME_FLOW_FILENAME
DESCRIPTION: Output file flow (w/o extension) variables

VOLUME_ADJ_FILENAME
DESCRIPTION: Output file adjoint (w/o extension) variables

GRAD_OBJFUNC_FILENAME
DESCRIPTION: Output objective function gradient

VALUE_OBJFUNC_FILENAME
DESCRIPTION: Output objective function

SURFACE_FLOW_FILENAME
DESCRIPTION: Output file surface flow coefficient (w/o extension)

SURFACE_ADJ_FILENAME
DESCRIPTION: Output file surface adjoint coefficient (w/o extension)

SURFACE_SENS_FILENAME_FILENAME
DESCRIPTION: Output file surface sensitivity (discrete adjoint) (w/o extension)

VOLUME_SENS_FILENAME
DESCRIPTION: Output file volume sensitivity (discrete adjoint))

MARKER_ANALYZE_AVERAGE
DESCRIPTION: Output averaged flow values on specified analyze marker. Options: AREA, MASSFLUX
Use with MARKER_ANALYZE.

COMM_LEVEL
DESCRIPTION: Level of MPI communications during runtime

CONFIG_CATEGORY: Dynamic mesh definition
CONFIG_CATEGORY: Aeroelastic Simulation (Typical Section Model)
CONFIG_CATEGORY: Optimization Problem
CONFIG_CATEGORY: Wind Gust
CONFIG_CATEGORY: Equivalent Area
CONFIG_CATEGORY: Grid deformation

OUTPUT_FORMAT
DESCRIPTION: I/O format for output plots.
OPTIONS: see Output_Map
DEFAULT: TECPLOT

CONFIG_CATEGORY: Deformable mesh
CONFIG_CATEGORY: FEM flow solver definition
CONFIG_CATEGORY: FEA solver

FEA_FILENAME
DESCRIPTION: Filename to input for element-based properties
Default: default_element_properties

ELECTRIC_FIELD_CONST
DESCRIPTION: Value of the Dielectric Elastomer constant

DESIGN_VARIABLE_FEA
DESCRIPTION: Design variable for FEA problems
OPTIONS: See DVFEA_Map
DEFAULT VENKATAKRISHNAN

REFERENCE_GEOMETRY_PENALTY
DESCRIPTION: Penalty weight value for the objective function

REFERENCE_GEOMETRY_FILENAME
DESCRIPTION: Reference geometry filename
Default: reference_geometry

REFERENCE_GEOMETRY_FORMAT
DESCRIPTION: Format of the reference geometry file
OPTIONS: see Input_Ref_Map
DEFAULT: SU2

REFERENCE_GEOMETRY_SURFACE
DESCRIPTION: If true consider only the surfaces where loads are applied.

REFERENCE_NODE
DESCRIPTION: Reference node for the structure (optimization applications)

REFERENCE_NODE_DISPLACEMENT
DESCRIPTION: Target displacement of the reference node

REFERENCE_NODE_PENALTY
DESCRIPTION: Penalty weight value for the objective function

TOTAL_DV_PENALTY
DESCRIPTION: Penalty weight value to maintain the total sum of DV constant

STRESS_PENALTY_PARAM
DESCRIPTION: Maximum allowed stress and KS exponent for structural optimization

REGIME_TYPE
DESCRIPTION: Geometric condition
OPTIONS: see Struct_Map

REGIME_TYPE
DESCRIPTION: Material model
OPTIONS: see Material_Map

REGIME_TYPE
DESCRIPTION: Compressibility of the material
OPTIONS: see MatComp_Map

PRESTRETCH_FILENAME
DESCRIPTION: Filename to input for prestretching membranes
Default: prestretch_file.dat

CONFIG_CATEGORY: Multizone definition
KIND_INTERPOLATION \n
DESCRIPTION: Type of interpolation to use for multi-zone problems.
OPTIONS: see Interpolator_Map Sets Kind_Interpolation
KIND_INTERPOLATION \n
DESCRIPTION: Type of radial basis function to use for radial basis function interpolation.
OPTIONS: see RadialBasis_Map Sets Kind_RadialBasis
INLETINTERPOLATION \n
DESCRIPTION: Type of spanwise interpolation to use for the inlet face.
OPTIONS: see Inlet_SpanwiseInterpolation_Map Sets Kind_InletInterpolation
INLETINTERPOLATION \n
DESCRIPTION: Type of spanwise interpolation to use for the inlet face.
OPTIONS: see Inlet_SpanwiseInterpolation_Map Sets Kind_InletInterpolation
CONFIG_CATEGORY: Radiation solver

MARKER_EMISSIVITY DESCRIPTION: Wall emissivity of the marker for radiation purposes
Format: ( marker, emissivity of the marker, ... ) <>

CONFIG_CATEGORY: Heat solver
CONFIG_CATEGORY: Visualize Control Volumes
CONFIG_CATEGORY: Inverse design problem
CONFIG_CATEGORY: Unsupported options
CONFIG_CATEGORY:FFD point inversion
CONFIG_CATEGORY: Automatic Differentation options
CONFIG_CATEGORY:Python Options

OPT_COMBINE_OBJECTIVE
DESCRIPTION: Flag specifying whether to internally combine a multi-objective function or treat separately

CONFIG_CATEGORY:Hybrid_RANSLES Options
CONFIG_CATEGORY:Output Options
CONFIG_CATEGORY:libROM options

SAVE_LIBROM
DESCRIPTION: Flag for saving data with libROM.

LIBROM_BASE_FILENAME
DESCRIPTION: Output base file name for libROM

BASIS_GENERATION
DESCRIPTION: Flag for saving data with libROM.

MAX_BASIS_DIM
DESCRIPTION: Maximum number of basis vectors.

ROM_SAVE_FREQ
DESCRIPTION: How often to save snapshots for unsteady problems.