SU2
Functions
Descriptions of Configuration Options.

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

Functions

void CConfig::SetConfig_Options (unsigned short val_iZone, unsigned short val_nZone)
 Set the config options. More...
 

Detailed Description

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

Function Documentation

§ SetConfig_Options()

void CConfig::SetConfig_Options ( unsigned short  val_iZone,
unsigned short  val_nZone 
)

Set the config options.

CONFIG_CATEGORY: Problem Definition

REGIME_TYPE
DESCRIPTION: Regime type
OPTIONS: see Regime_Map

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

MATH_PROBLEM
DESCRIPTION: Mathematical problem
Options: DIRECT, ADJOINT

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

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

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

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

CONFIG_CATEGORY: FluidModel

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

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)

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

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

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

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)

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 (1 by deafult)

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

REF_ELEM_LENGTH
DESCRIPTION: Reference element length for computing the slope limiter epsilon

REF_SHARP_EDGES
DESCRIPTION: Reference coefficient for detecting sharp edges

REF_VELOCITY
DESCRIPTION: Reference velocity (incompressible only)

CONFIG_CATEGORY: Boundary Markers

HTP_AXIS
DESCRIPTION: Location of the HTP axis

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_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

MARKER_OUT_1D
DESCRIPTION: Outlet boundary marker(s) over which to calculate 1-D flow properties Format: ( outlet marker)

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_PRESSURE
DESCRIPTION: Symmetry boundary condition

MARKER_NEARFIELD
DESCRIPTION: Near-Field boundary condition

MARKER_FLUID_INTERFACE
DESCRIPTION: Fluid interface boundary marker(s)

MARKER_INTERFACE
DESCRIPTION: Zone interface boundary marker(s)

MARKER_FSI_INTERFACE
DESCRIPTION: FSI interface boundary marker(s)

MARKER_DIRICHLET
DESCRIPTION: Dirichlet boundary marker(s)

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

MARKER_ACTDISK
DESCRIPTION: Periodic boundary marker(s) for use with SU2_MSH Format: ( periodic marker, donor marker, rotation_center_x, rotation_center_y, rotation_center_z, rotation_angle_x-axis, rotation_angle_y-axis, rotation_angle_z-axis, translation_x, translation_y, translation_z, ... )

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

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_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_NRBC
DESCRIPTION: Riemann boundary marker(s) with the following formats, a unit vector.

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

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

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

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), ... )

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), ... )

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

SUBSONIC_ENGINE
DESCRIPTION: Engine subsonic intake region

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

CONFIG_CATEGORY: Time-marching
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

CONFIG_CATEGORY: Convergence

CONV_CRITERIA
DESCRIPTION: Convergence criteria
OPTIONS: see Converge_Crit_Map
DEFAULT: RESIDUAL

RESIDUAL_REDUCTION
DESCRIPTION: Residual reduction (order of magnitude with respect to the initial value)
DEFAULT: 3.0

RESIDUAL_MINVAL
DESCRIPTION: Min value of the residual (log10 of the residual)
DEFAULT: -8.0

RESIDUAL_FUNC_FLOW
DESCRIPTION: Flow functional for the Residual criteria
OPTIONS: See Residual_Map
DEFAULT: RHO_RESIDUAL

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

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

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

CAUCHY_FUNC_FLOW
DESCRIPTION: Flow functional for the Cauchy criteria
OPTIONS: see Objective_Map
DEFAULT: DRAG_COEFFICIENT

CAUCHY_FUNC_ADJFLOW
DESCRIPTION: Adjoint functional for the Cauchy criteria.
OPTIONS: See Sens_Map.
DEFAULT: SENS_GEOMETRY

CONFIG_CATEGORY: Multi-grid

START_UP_ITER
DESCRIPTION: Start up iterations using the fine grid only. DEFAULT: 0

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

CONFIG_CATEGORY: Spatial Discretization

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

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

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

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

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

SPATIAL_ORDER_FLOW
DESCRIPTION: Spatial numerical order integration
OPTIONS: See SpatialOrder_Map
DEFAULT: SECOND_ORDER

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

AD_COEFF_FLOW
DESCRIPTION: 1st, 2nd and 4th order artificial dissipation coefficients

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.

SPATIAL_ORDER_ADJFLOW
DESCRIPTION: Spatial numerical order integration
OPTIONS: See SpatialOrder_Map
DEFAULT: SECOND_ORDER

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

AD_COEFF_ADJFLOW
DESCRIPTION: 1st, 2nd and 4th order artificial dissipation coefficients for the adjoint solver.
FORMAT and default values: AD_COEFF_ADJFLOW = (0.15, 0.5, 0.02)

SPATIAL_ORDER_TURB
DESCRIPTION: Spatial numerical order integration.
OPTIONS: See SpatialOrder_Map
DEFAULT: FIRST_ORDER

SLOPE_LIMITER_TURB
DESCRIPTION: Slope limiter
OPTIONS: See Limiter_Map
DEFAULT VENKATAKRISHNAN

CONV_NUM_METHOD_TURB
DESCRIPTION: Convective numerical method

SPATIAL_ORDER_ADJTURB
DESCRIPTION: Spatial numerical order integration
OPTIONS: See SpatialOrder_Map
DEFAULT: FIRST_ORDER

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

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

OBJ_CHAIN_RULE_COEFF
DESCRIPTION: Coefficients defining the objective function gradient using the chain rule with area-averaged outlet primitive variables. This is used with the genereralized outflow objective.

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

CONFIG_CATEGORY: Input/output files and formats

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

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_FILENAME
DESCRIPTION: Mesh output file name. Used when converting, scaling, or deforming a mesh.
DEFAULT: mesh_out.su2

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

BREAKDOWN_FILENAME
DESCRIPTION: Output file forces breakdown

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

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.

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

RESTART_FLOW_FILENAME
DESCRIPTION: Output file restart flow

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

RESTART_WAVE_FILENAME
DESCRIPTION: Output file restart wave

RESTART_FLOW_FILENAME
DESCRIPTION: Output file restart structure

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

VOLUME_STRUCTURE_FILENAME
DESCRIPTION: Output file structure (w/o extension) variables

SURFACE_STRUCTURE_FILENAME
DESCRIPTION: Output file structure (w/o extension) variables

SURFACE_WAVE_FILENAME
DESCRIPTION: Output file structure (w/o extension) variables

SURFACE_HEAT_FILENAME
DESCRIPTION: Output file structure (w/o extension) variables

VOLUME_WAVE_FILENAME
DESCRIPTION: Output file wave (w/o extension) variables

VOLUME_HEAT_FILENAME
DESCRIPTION: Output file wave (w/o extension) variables

VOLUME_ADJWAVE_FILENAME
DESCRIPTION: Output file adj. wave (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))

WRT_SOL_FREQ
DESCRIPTION: Writing solution file frequency

WRT_SOL_FREQ_DUALTIME
DESCRIPTION: Writing solution file frequency for dual time

WRT_CON_FREQ
DESCRIPTION: Writing convergence history frequency

WRT_CON_FREQ_DUALTIME
DESCRIPTION: Writing convergence history frequency for the dual time

LOW_MEMORY_OUTPUT
DESCRIPTION: Output less information for lower memory use.

WRT_VOL_SOL
DESCRIPTION: Write a volume solution file

WRT_SRF_SOL
DESCRIPTION: Write a surface solution file

WRT_CSV_SOL
DESCRIPTION: Write a surface CSV solution file

WRT_RESIDUALS
DESCRIPTION: Output residual info to solution/restart file

WRT_LIMITERS
DESCRIPTION: Output limiter value information to solution/restart file

WRT_SHARPEDGES
DESCRIPTION: Output sharp edge limiter information to solution/restart file

ONE_D_OUTPUT
DESCRIPTION: Output averaged outlet flow values on specified exit marker.
Use with MARKER_OUT_1D.

CONSOLE_OUTPUT_VERBOSITY
DESCRIPTION: Verbosity level for console output

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

BULK_MODULUS_STRUCT
DESCRIPTION: Value of the Bulk Modulus for a structural problem
DEFAULT 160E9

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

PHYSICAL_PROBLEM_FLUID_FSI DESCRIPTION: Physical governing equations
Options: NONE (default),EULER, NAVIER_STOKES, RANS,

PHYSICAL_PROBLEM_STRUCTURAL_FSI DESCRIPTION: Physical governing equations
Options: NONE (default), FEM_ELASTICITY

KIND_INTERPOLATION
DESCRIPTION: Type of interpolation to use for multi-zone problems.
OPTIONS: see Interpolator_Map Sets Kind_Interpolation
CONFIG_CATEGORY: Wave solver
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