Documentation 6b54b78464
Loading...
Searching...
No Matches
option_structure.hpp File Reference

Defines classes for referencing options for easy input in CConfig. More...

#include "./parallelization/mpi_structure.hpp"
#include <iostream>
#include <sstream>
#include <string>
#include <vector>
#include <array>
#include <map>
#include <cstdlib>
#include <algorithm>
#include <cassert>

Go to the source code of this file.

Classes

class  CEmptyMap< T, U >
 We use this dummy class instead of std::map when we only need the enum definition and not the string to enum maps, this makes compilation much faster. More...
 
struct  SST_ParsedOptions
 Structure containing parsed SST options. More...
 
struct  CMGOptions
 Structure containing multigrid options. More...
 
struct  SA_ParsedOptions
 Structure containing parsed SA options. More...
 
struct  LM_ParsedOptions
 Structure containing parsed LM options. More...
 
struct  DataDrivenFluid_ParsedOptions
 Structure containing parsed options for data-driven fluid model. More...
 
struct  FluidFlamelet_ParsedOptions
 Structure containing parsed options for flamelet fluid model. More...
 
struct  StreamwisePeriodicValues
 Container to hold Variables for streamwise Periodic flow as they are often used together in places. More...
 
class  COptionBase
 

Macros

#define MakePair(a, b)
 

Typedefs

template<class T , class U >
using MapType = CEmptyMap< T, U >
 

Enumerations

enum class  SU2_COMPONENT {
  SU2_CFD , SU2_DEF , SU2_DOT , SU2_GEO ,
  SU2_SOL
}
 Different software components of SU2. More...
 
enum  : unsigned int { MAX_SOLS = 14 }
 
enum class  COMM_TYPE {
  UNSIGNED_LONG , LONG , UNSIGNED_SHORT , FLOAT ,
  DOUBLE , PASSIVE_DOUBLE , CHAR , SHORT ,
  INT
}
 
enum  GEO_TYPE {
  VERTEX = 1 , LINE = 3 , TRIANGLE = 5 , QUADRILATERAL = 9 ,
  TETRAHEDRON = 10 , HEXAHEDRON = 12 , PRISM = 13 , PYRAMID = 14
}
 Types of geometric entities based on VTK nomenclature. More...
 
enum  ANSWER { NONE = 0 , NO = 0 , YES = 1 }
 Boolean answers. More...
 
enum  AVERAGE_TYPE { AVERAGE_AREA = 1 , AVERAGE_MASSFLUX = 2 }
 Average method for marker analyze. More...
 
enum class  MAIN_SOLVER {
  NONE , EULER , NAVIER_STOKES , RANS ,
  INC_EULER , INC_NAVIER_STOKES , INC_RANS , HEAT_EQUATION ,
  FEM_ELASTICITY , ADJ_EULER , ADJ_NAVIER_STOKES , ADJ_RANS ,
  TEMPLATE_SOLVER , DISC_ADJ_EULER , DISC_ADJ_RANS , DISC_ADJ_NAVIER_STOKES ,
  DISC_ADJ_INC_EULER , DISC_ADJ_INC_RANS , DISC_ADJ_INC_NAVIER_STOKES , DISC_ADJ_HEAT ,
  DISC_ADJ_FEM_EULER , DISC_ADJ_FEM_RANS , DISC_ADJ_FEM_NS , DISC_ADJ_FEM ,
  FEM_EULER , FEM_NAVIER_STOKES , FEM_RANS , FEM_LES ,
  MULTIPHYSICS , POISSON_EQUATION , NEMO_EULER , NEMO_NAVIER_STOKES
}
 different solver types for the CFD component More...
 
enum class  ENUM_MULTIZONE { MZ_BLOCK_GAUSS_SEIDEL , MZ_BLOCK_JACOBI }
 Different solver types for multizone problems. More...
 
enum class  STRUCT_DEFORMATION { SMALL , LARGE }
 Material geometric conditions. More...
 
enum class  STRUCT_MODEL { LINEAR_ELASTIC , NEO_HOOKEAN , KNOWLES , IDEAL_DE }
 Material model. More...
 
enum class  STRUCT_COMPRESS { COMPRESSIBLE , NEARLY_INCOMP }
 Material compressibility. More...
 
enum class  INCOMP_SYSTEM { DENSITY_BASED , PRESSURE_BASED }
 Type of incompressible solver. More...
 
enum class  PBITER { SIMPLE , SIMPLEC }
 Type of iteration. More...
 
enum class  INTERFACE_INTERPOLATOR { NEAREST_NEIGHBOR , ISOPARAMETRIC , WEIGHTED_AVERAGE , RADIAL_BASIS_FUNCTION }
 Types of interpolators. More...
 
enum class  RADIAL_BASIS {
  WENDLAND_C2 , INV_MULTI_QUADRIC , GAUSSIAN , THIN_PLATE_SPLINE ,
  MULTI_QUADRIC
}
 Types of radial basis functions. More...
 
enum class  INLET_SPANWISE_INTERP { NONE , LINEAR_1D , AKIMA_1D , CUBIC_1D }
 type of radial spanwise interpolation function for the inlet face More...
 
enum class  INLET_INTERP_TYPE { VR_VTHETA , ALPHA_PHI }
 type of radial spanwise interpolation data type for the inlet face More...
 
enum  ENUM_TRANSFER {
  ZONES_ARE_EQUAL = 0 , NO_COMMON_INTERFACE = 1 , NO_TRANSFER = 2 , FLOW_TRACTION = 10 ,
  BOUNDARY_DISPLACEMENTS = 21 , SLIDING_INTERFACE = 13 , CONSERVATIVE_VARIABLES = 14 , MIXING_PLANE = 15 ,
  CONJUGATE_HEAT_FS = 16 , CONJUGATE_HEAT_WEAKLY_FS = 17 , CONJUGATE_HEAT_SF = 18 , CONJUGATE_HEAT_WEAKLY_SF = 19 ,
  CONJUGATE_HEAT_SS = 20
}
 types of (coupling) transfers between distinct physical zones More...
 
enum class  ENUM_REGIME { COMPRESSIBLE = 0 , INCOMPRESSIBLE = 1 , NO_FLOW = 2 }
 different regime modes More...
 
enum  ENUM_KIND_NONDIM {
  DIMENSIONAL = 0 , FREESTREAM_PRESS_EQ_ONE = 1 , FREESTREAM_VEL_EQ_MACH = 2 , FREESTREAM_VEL_EQ_ONE = 3 ,
  INITIAL_VALUES = 4 , REFERENCE_VALUES = 5
}
 different non-dimensional modes More...
 
enum  ENUM_MEASUREMENTS { SI = 0 , US = 1 }
 different system of measurements More...
 
enum  RUNTIME_TYPE {
  RUNTIME_FLOW_SYS = 2 , RUNTIME_TURB_SYS = 3 , RUNTIME_ADJFLOW_SYS = 6 , RUNTIME_ADJTURB_SYS = 7 ,
  RUNTIME_MULTIGRID_SYS = 14 , RUNTIME_FEA_SYS = 20 , RUNTIME_ADJFEA_SYS = 30 , RUNTIME_HEAT_SYS = 21 ,
  RUNTIME_ADJHEAT_SYS = 31 , RUNTIME_TRANS_SYS = 22 , RUNTIME_RADIATION_SYS = 23 , RUNTIME_ADJRAD_SYS = 24 ,
  RUNTIME_SPECIES_SYS = 25 , RUNTIME_ADJSPECIES_SYS = 26 , RUNTIME_POISSON_SYS = 27
}
 different types of systems More...
 
enum  SOLVER_TYPE : const int {
  FLOW_SOL =0 , ADJFLOW_SOL =1 , TURB_SOL =2 , ADJTURB_SOL =3 ,
  TRANS_SOL =4 , HEAT_SOL =5 , ADJHEAT_SOL =6 , RAD_SOL =7 ,
  ADJRAD_SOL =8 , MESH_SOL =9 , ADJMESH_SOL =10 , SPECIES_SOL =11 ,
  ADJSPECIES_SOL =12 , FEA_SOL =0 , ADJFEA_SOL =1 , POISSON_SOL =13 ,
  TEMPLATE_SOL =0
}
 
enum  ENUM_SPACE { NO_CONVECTIVE = 0 , SPACE_CENTERED = 1 , SPACE_UPWIND = 2 , FINITE_ELEMENT = 3 }
 Types of spatial discretizations. More...
 
enum  ENUM_FLUIDMODEL {
  STANDARD_AIR = 0 , IDEAL_GAS = 1 , VW_GAS = 2 , PR_GAS = 3 ,
  CONSTANT_DENSITY = 4 , INC_IDEAL_GAS = 5 , INC_IDEAL_GAS_POLY = 6 , MUTATIONPP = 7 ,
  SU2_NONEQ = 8 , FLUID_MIXTURE = 9 , COOLPROP = 10 , FLUID_FLAMELET = 11 ,
  DATADRIVEN_FLUID = 12
}
 Types of fluid model. More...
 
enum  ENUM_GASMODEL {
  NO_MODEL = 0 , ARGON = 1 , AIR7 = 2 , AIR21 = 3 ,
  O2 = 4 , N2 = 5 , AIR5 = 6 , ARGON_SID = 7 ,
  ONESPECIES = 8
}
 types of gas models More...
 
enum class  ENUM_DATADRIVEN_METHOD { LUT = 0 , MLP = 1 }
 Types of interpolation methods for data-driven fluid models. More...
 
enum class  TRANSCOEFFMODEL { SUTHERLAND , WILKE , GUPTAYOS , CHAPMANN_ENSKOG }
 types of coefficient transport model More...
 
enum class  INC_DENSITYMODEL { CONSTANT , BOUSSINESQ , VARIABLE , FLAMELET }
 Types of density models. More...
 
enum  ENUM_INIT_OPTION { REYNOLDS = 0 , TD_CONDITIONS = 1 }
 Types of initialization option. More...
 
enum class  INIT_OPTION_INC { DENSITY_INIT , OPERATING_PRESSURE }
 Types of initialization of the incompressible solver. More...
 
enum class  FREESTREAM_OPTION { TEMPERATURE_FS , DENSITY_FS }
 Types of freestream specification. More...
 
enum class  VISCOSITYMODEL {
  CONSTANT , SUTHERLAND , POLYNOMIAL , FLAMELET ,
  COOLPROP
}
 Types of viscosity model. More...
 
enum class  MIXINGVISCOSITYMODEL { WILKE , DAVIDSON }
 Types of Mixing viscosity model. More...
 
enum class  CONDUCTIVITYMODEL {
  CONSTANT , CONSTANT_PRANDTL , POLYNOMIAL , FLAMELET ,
  COOLPROP
}
 Types of thermal conductivity model. More...
 
enum class  CONDUCTIVITYMODEL_TURB { NONE , CONSTANT_PRANDTL }
 Types of turbulent thermal conductivity model. More...
 
enum class  DIFFUSIVITYMODEL {
  CONSTANT_DIFFUSIVITY , CONSTANT_SCHMIDT , UNITY_LEWIS , CONSTANT_LEWIS ,
  FLAMELET
}
 types of mass diffusivity models More...
 
enum  ENUM_GRIDMOVEMENT {
  NO_MOVEMENT = 0 , RIGID_MOTION = 2 , ROTATING_FRAME = 8 , STEADY_TRANSLATION = 11 ,
  GUST = 12
}
 Types of unsteady mesh motion. More...
 
enum  ENUM_SURFACEMOVEMENT {
  DEFORMING = 1 , MOVING_WALL = 2 , AEROELASTIC = 3 , AEROELASTIC_RIGID_MOTION = 4 ,
  EXTERNAL = 6 , EXTERNAL_ROTATION = 7
}
 
enum  ENUM_GUST_TYPE {
  NO_GUST = 0 , TOP_HAT = 1 , SINE = 2 , ONE_M_COSINE = 3 ,
  VORTEX = 4 , EOG = 5
}
 Type of wind gusts. More...
 
enum  ENUM_GUST_DIR { X_DIR = 0 , Y_DIR = 1 , Z_DIR = 2 }
 Type of wind direction. More...
 
enum class  CENTERED {
  NONE , JST , LAX , JST_MAT ,
  JST_KE , LD2 , CDS
}
 Types of centered spatial discretizations. More...
 
enum class  UPWIND {
  NONE , ROE , SCALAR_UPWIND , AUSM ,
  HLLC , SW , MSW , TURKEL ,
  SLAU , CONVECTIVE_TEMPLATE , L2ROE , LMROE ,
  SLAU2 , FDS , LAX_FRIEDRICH , AUSMPLUSUP ,
  AUSMPLUSUP2 , AUSMPLUSM , BOUNDED_SCALAR , UDS
}
 Types of upwind spatial discretizations. More...
 
enum  ENUM_FEM { NO_FEM = 0 , DG = 1 }
 Types of FEM spatial discretizations. More...
 
enum class  FEM_SHOCK_CAPTURING_DG { NONE , PERSSON }
 Types of shock capturing method in Discontinuous Galerkin numerical method. More...
 
enum  ENUM_MATRIX_COLORING { GREEDY_COLORING = 0 , NATURAL_COLORING = 1 }
 Types of matrix coloring to compute a sparse Jacobian matrix. More...
 
enum class  LIMITER {
  NONE , VENKATAKRISHNAN , NISHIKAWA_R3 , NISHIKAWA_R4 ,
  NISHIKAWA_R5 , VENKATAKRISHNAN_WANG , BARTH_JESPERSEN , VAN_ALBADA_EDGE ,
  SHARP_EDGES , WALL_DISTANCE
}
 Types of slope limiters. More...
 
enum class  TURB_MODEL { NONE , SA , SST }
 Types of turbulent models. More...
 
enum class  TURB_FAMILY { NONE , SA , KW }
 Families of turbulence models. More...
 
enum class  SST_OPTIONS {
  NONE , V1994 , V2003 , V1994m ,
  V2003m , SUST , V , KL ,
  UQ , COMP_Wilcox , COMP_Sarkar , DLL
}
 SST Options. More...
 
enum class  ROUGHSST_MODEL { WILCOX1998 , WILCOX2006 , LIMITER_KNOPP , LIMITER_AUPOIX }
 SST rough-wall boundary conditions Options. More...
 
enum class  SA_OPTIONS {
  NONE , NEG , EDW , FT2 ,
  QCR2000 , COMP , ROT , BC ,
  EXP
}
 SA Options. More...
 
enum class  TURB_TRANS_MODEL { NONE , LM }
 Types of transition models. More...
 
enum class  LM_OPTIONS {
  NONE , LM2015 , MALAN , SULUKSNA ,
  KRAUSE , KRAUSE_HYPER , MEDIDA_BAEDER , MEDIDA ,
  MENTER_LANGTRY , DEFAULT
}
 LM Options. More...
 
enum class  TURB_TRANS_CORRELATION {
  MALAN , SULUKSNA , KRAUSE , KRAUSE_HYPER ,
  MEDIDA_BAEDER , MEDIDA , MENTER_LANGTRY , DEFAULT
}
 Types of transition correlations. More...
 
enum class  SPECIES_MODEL { NONE , SPECIES_TRANSPORT , FLAMELET }
 types of species transport models More...
 
enum  FLAMELET_SCALAR_VARIABLES { I_PROGVAR , I_ENTH , I_MIXFRAC }
 Progress variable and enthalpy are the first and second entries in the lookup table. More...
 
enum  FLAMELET_SCALAR_SOURCES { I_SRC_TOT_PROGVAR }
 the source terms for the flamelet method. At the moment only progress variable More...
 
enum  FLAMELET_LOOKUP_OPS { THERMO , PREFDIF , SOURCES , LOOKUP }
 Look-up operations for the flamelet scalar solver. More...
 
enum  FLAMELET_PREF_DIFF_SCALARS {
  I_BETA_PROGVAR , I_BETA_ENTH_THERMAL , I_BETA_ENTH , I_BETA_MIXFRAC ,
  N_BETA_TERMS
}
 The preferential diffusion scalar indices for the preferential diffusion model. More...
 
enum class  FLAMELET_INIT_TYPE { FLAME_FRONT , SPARK , NONE }
 Flame initialization options for the flamelet solver. More...
 
enum class  FLAMELET_ENTHALPY_BC { FLOW_MARKERS , SPECIES_MARKERS }
 Selects the source of wall/inlet enthalpy boundary conditions for the flamelet solver. SPECIES_MARKERS (default): inlet H is taken directly from MARKER_INLET_SPECIES; wall enthalpy BC is obtained from MARKER_WALL_SPECIES. FLOW_MARKERS: inlet H is derived from the MARKER_INLET temperature via a Newton iteration on the LUT (reverse lookup using Z,T) from MARKER_ISOTHERMAL or MARKER_HEATFLUX. More...
 
enum class  TURB_SGS_MODEL {
  NONE , IMPLICIT_LES , SMAGORINSKY , WALE ,
  VREMAN
}
 Types of subgrid scale models. More...
 
enum class  WINDOW_FUNCTION { SQUARE , HANN , HANN_SQUARE , BUMP }
 Types of window (weight) functions for cost functional. More...
 
enum  ENUM_HYBRIDRANSLES {
  NO_HYBRIDRANSLES = 0 , SA_DES = 1 , SA_DDES = 2 , SA_ZDES = 3 ,
  SA_EDDES = 4
}
 Types of hybrid RANS/LES models. More...
 
enum  ENUM_ROELOWDISS {
  NO_ROELOWDISS = 0 , FD = 1 , NTS = 2 , NTS_DUCROS = 3 ,
  FD_DUCROS = 4
}
 Types of Roe Low Dissipation Schemes. More...
 
enum class  WALL_FUNCTIONS {
  NONE , STANDARD_FUNCTION , ADAPTIVE_FUNCTION , SCALABLE_FUNCTION ,
  EQUILIBRIUM_MODEL , NONEQUILIBRIUM_MODEL , LOGARITHMIC_MODEL
}
 Types of wall functions. More...
 
enum  ENUM_TIME_INT {
  RUNGE_KUTTA_EXPLICIT = 1 , EULER_EXPLICIT = 2 , EULER_IMPLICIT = 3 , CLASSICAL_RK4_EXPLICIT = 4 ,
  ADER_DG = 5
}
 Type of time integration schemes. More...
 
enum  ENUM_ADER_PREDICTOR { ADER_ALIASED_PREDICTOR = 1 , ADER_NON_ALIASED_PREDICTOR = 2 }
 Type of predictor for the ADER-DG time integration scheme. More...
 
enum  ENUM_HEAT_TIMESTEP { MINIMUM = 1 , CONVECTIVE = 2 , VISCOUS = 3 , BYFLOW = 4 }
 Type of heat timestep calculation. More...
 
enum class  STRUCT_TIME_INT { NEWMARK_IMPLICIT , GENERALIZED_ALPHA }
 Type of time integration schemes. More...
 
enum class  STRUCT_SPACE_ITE { NEWTON , MOD_NEWTON }
 Type of time integration schemes. More...
 
enum  ENUM_FLOW_GRADIENT { NO_GRADIENT = 0 , GREEN_GAUSS = 1 , LEAST_SQUARES = 2 , WEIGHTED_LEAST_SQUARES = 3 }
 Types of schemes to compute the flow gradient. More...
 
enum  GEOMETRY_ACTION { ALLOCATE = 0 , UPDATE = 1 }
 Types of action to take on a geometry structure. More...
 
enum  GEOMETRY_MODE { FUNCTION = 0 , GRADIENT = 1 }
 Types of action to perform when doing the geometry evaluation. More...
 
enum  BC_TYPE {
  EULER_WALL = 1 , FAR_FIELD = 2 , SYMMETRY_PLANE = 3 , INLET_FLOW = 4 ,
  OUTLET_FLOW = 5 , PERIODIC_BOUNDARY = 6 , NEARFIELD_BOUNDARY = 7 , CUSTOM_BOUNDARY = 10 ,
  DISPLACEMENT_BOUNDARY = 14 , LOAD_BOUNDARY = 15 , FLOWLOAD_BOUNDARY = 16 , SUPERSONIC_INLET = 19 ,
  SUPERSONIC_OUTLET = 20 , ENGINE_INFLOW = 21 , ENGINE_EXHAUST = 22 , RIEMANN_BOUNDARY = 24 ,
  ISOTHERMAL = 25 , HEAT_FLUX = 26 , HEAT_TRANSFER = 27 , ACTDISK_INLET = 32 ,
  ACTDISK_OUTLET = 33 , CLAMPED_BOUNDARY = 34 , LOAD_DIR_BOUNDARY = 35 , LOAD_SINE_BOUNDARY = 36 ,
  GILES_BOUNDARY = 37 , INTERNAL_BOUNDARY = 38 , FLUID_INTERFACE = 39 , DISP_DIR_BOUNDARY = 40 ,
  DAMPER_BOUNDARY = 41 , MIXING_PLANE_INTERFACE = 42 , CHT_WALL_INTERFACE = 50 , SMOLUCHOWSKI_MAXWELL = 55 ,
  SEND_RECEIVE = 99
}
 Types of boundary conditions. More...
 
enum class  STRUCT_2DFORM { PLANE_STRESS , PLANE_STRAIN }
 2D Formulation for structural problems More...
 
enum class  BGS_RELAXATION { NONE , FIXED , AITKEN }
 Kinds of relaxation for multizone problems. More...
 
enum  ENUM_DYN_TRANSFER_METHOD {
  INSTANTANEOUS = 1 , POL_ORDER_1 = 2 , POL_ORDER_3 = 3 , POL_ORDER_5 = 4 ,
  SIGMOID_10 = 5 , SIGMOID_20 = 6
}
 Types of dynamic transfer methods. More...
 
enum  ENUM_DVFEA {
  NODV_FEA = 0 , YOUNG_MODULUS = 1 , POISSON_RATIO = 2 , DENSITY_VAL = 3 ,
  DEAD_WEIGHT = 4 , ELECTRIC_FIELD = 5
}
 Kinds of Design Variables for FEA problems. More...
 
enum class  RADIATION_MODEL { NONE , P1 }
 Kinds of radiation models. More...
 
enum class  P1_INIT { ZERO , TEMPERATURE }
 Kinds of P1 initialization. More...
 
enum  CHT_COUPLING { DIRECT_TEMPERATURE_NEUMANN_HEATFLUX , AVERAGED_TEMPERATURE_NEUMANN_HEATFLUX , DIRECT_TEMPERATURE_ROBIN_HEATFLUX , AVERAGED_TEMPERATURE_ROBIN_HEATFLUX }
 Kinds of coupling methods at CHT interfaces. The first (temperature) part determines the BC method on the fluid side, the second (heatflux) part determines the BC method on the solid side of the CHT interface. More...
 
enum  RIEMANN_TYPE {
  TOTAL_CONDITIONS_PT = 1 , DENSITY_VELOCITY = 2 , STATIC_PRESSURE = 3 , TOTAL_SUPERSONIC_INFLOW = 4 ,
  STATIC_SUPERSONIC_INFLOW_PT = 5 , STATIC_SUPERSONIC_INFLOW_PD = 6 , MIXING_IN = 7 , MIXING_OUT = 8 ,
  SUPERSONIC_OUTFLOW = 9 , RADIAL_EQUILIBRIUM = 10 , TOTAL_CONDITIONS_PT_1D = 11 , STATIC_PRESSURE_1D = 12 ,
  MIXING_IN_1D = 13 , MIXING_OUT_1D = 14 , MASS_FLOW_OUTLET = 15
}
 Types Riemann boundary treatments. More...
 
enum class  WALL_SPECIES_TYPE { FLUX , VALUE }
 Types of wall species boundary conditions. More...
 
enum  AVERAGEPROCESS_TYPE { ALGEBRAIC = 1 , AREA = 2 , MIXEDOUT = 3 , MASSFLUX = 4 }
 Types of mixing process for averaging quantities at the boundaries. More...
 
enum  MIXINGPLANE_INTERFACE_TYPE { MATCHING = 1 , NEAREST_SPAN = 2 , LINEAR_INTERPOLATION = 3 }
 Types of mixing process for averaging quantities at the boundaries. More...
 
enum  SPANWISE_TYPE { AUTOMATIC = 1 , EQUISPACED = 2 }
 this option allow to compute the span-wise section in different ways. More...
 
enum class  TURBOMACHINERY_TYPE {
  AXIAL , CENTRIFUGAL , CENTRIPETAL , CENTRIPETAL_AXIAL ,
  AXIAL_CENTRIFUGAL
}
 Types of mixing process for averaging quantities at the boundaries. More...
 
enum class  TURBO_PERF_KIND { TURBINE , COMPRESSOR , PROPELLOR }
 Types of Turbomachinery performance Type. More...
 
enum class  TURBO_INTERFACE_KIND { MIXING_PLANE = ENUM_TRANSFER::MIXING_PLANE , FROZEN_ROTOR = ENUM_TRANSFER::SLIDING_INTERFACE }
 Types of Turbomachinery interfaces. More...
 
enum  TURBO_MARKER_TYPE { INFLOW = 1 , OUTFLOW = 2 }
 Types of Turbomachinery performance flag. More...
 
enum class  RAMP_TYPE { GRID , BOUNDARY , MUSCL }
 
enum class  MUSCL_RAMP_TYPE { ITERATION , SMOOTH_FUNCTION }
 
enum  RAMP_COEFF { INITIAL_VALUE = 0 , UPDATE_FREQ = 1 , FINAL_ITER = 2 }
 Coefficients of the ramp specified in the config, ordered by index in the config. More...
 
enum class  INLET_TYPE {
  TOTAL_CONDITIONS , MASS_FLOW , INPUT_FILE , VELOCITY_INLET ,
  PRESSURE_INLET
}
 Types inlet boundary treatments. More...
 
enum class  INC_OUTLET_TYPE { PRESSURE_OUTLET , MASS_FLOW_OUTLET }
 Types outlet boundary treatments. More...
 
enum  ENGINE_INFLOW_TYPE { FAN_FACE_MACH = 1 , FAN_FACE_MDOT = 2 , FAN_FACE_PRESSURE = 3 }
 Types engine inflow boundary treatments. More...
 
enum  ACTDISK_TYPE {
  VARIABLES_JUMP = 1 , BC_THRUST = 2 , NET_THRUST = 3 , DRAG_MINUS_THRUST = 4 ,
  MASSFLOW = 5 , POWER = 6 , VARIABLE_LOAD = 7 , BLADE_ELEMENT = 8
}
 Types actuator disk boundary treatments. More...
 
enum class  WALL_TYPE { SMOOTH , ROUGH }
 types of wall boundary condition - smooth or rough More...
 
enum  ENUM_OBJECTIVE {
  DRAG_COEFFICIENT = 1 , LIFT_COEFFICIENT = 2 , SIDEFORCE_COEFFICIENT = 3 , EFFICIENCY = 4 ,
  INVERSE_DESIGN_PRESSURE = 5 , INVERSE_DESIGN_HEATFLUX = 6 , TOTAL_HEATFLUX = 7 , MAXIMUM_HEATFLUX = 8 ,
  AVG_TEMPERATURE = 70 , MOMENT_X_COEFFICIENT = 9 , MOMENT_Y_COEFFICIENT = 10 , MOMENT_Z_COEFFICIENT = 11 ,
  EQUIVALENT_AREA = 12 , NEARFIELD_PRESSURE = 13 , FORCE_X_COEFFICIENT = 14 , FORCE_Y_COEFFICIENT = 15 ,
  FORCE_Z_COEFFICIENT = 16 , THRUST_COEFFICIENT = 17 , TORQUE_COEFFICIENT = 18 , FIGURE_OF_MERIT = 19 ,
  BUFFET_SENSOR = 20 , SURFACE_TOTAL_PRESSURE = 28 , SURFACE_STATIC_PRESSURE = 29 , SURFACE_STATIC_TEMPERATURE = 57 ,
  SURFACE_MASSFLOW = 30 , SURFACE_MACH = 51 , SURFACE_UNIFORMITY = 52 , SURFACE_SECONDARY = 53 ,
  SURFACE_MOM_DISTORTION = 54 , SURFACE_SECOND_OVER_UNIFORM = 55 , SURFACE_PRESSURE_DROP = 56 , SURFACE_SPECIES_0 = 58 ,
  SURFACE_SPECIES_VARIANCE = 59 , CUSTOM_OBJFUNC = 31 , REFERENCE_GEOMETRY = 60 , REFERENCE_NODE = 61 ,
  VOLUME_FRACTION = 62 , TOPOL_DISCRETENESS = 63 , TOPOL_COMPLIANCE = 64 , STRESS_PENALTY = 65 ,
  ENTROPY_GENERATION = 80 , TOTAL_PRESSURE_LOSS = 81 , KINETIC_ENERGY_LOSS = 82
}
 Types of objective functions. More...
 
enum  ENUM_GRID {
  SU2 = 1 , SU2_BIN = 2 , CGNS_GRID = 3 , RECTANGLE = 4 ,
  BOX = 5
}
 Types of grid file formats. More...
 
enum class  OUTPUT_TYPE {
  TECPLOT_ASCII , TECPLOT_BINARY , SURFACE_TECPLOT_ASCII , SURFACE_TECPLOT_BINARY ,
  CSV , SURFACE_CSV , PARAVIEW_ASCII , PARAVIEW_LEGACY_BINARY ,
  SURFACE_PARAVIEW_ASCII , SURFACE_PARAVIEW_LEGACY_BINARY , MESH , MESH_BINARY ,
  RESTART_BINARY , RESTART_ASCII , PARAVIEW_XML , SURFACE_PARAVIEW_XML ,
  PARAVIEW_MULTIBLOCK , CGNS , SURFACE_CGNS , STL_ASCII ,
  STL_BINARY
}
 Type of solution output file formats. More...
 
enum class  TAB_OUTPUT { TAB_CSV , TAB_TECPLOT }
 Type of solution output file formats. More...
 
enum class  VOLUME_OUTPUT_PRECISION { SINGLE , DOUBLE }
 Floating-point type of the fields of the volume and surface files (CGNS and Paraview XML). More...
 
enum  ENUM_SENSITIVITY { SU2_NATIVE = 1 , UNORDERED_ASCII = 2 }
 Type of volume sensitivity file formats (inout to SU2_DOT) More...
 
enum  JUMP_DEFINITION { DIFFERENCE = 1 , RATIO = 2 }
 Type of jump definition. More...
 
enum class  MG_CYCLE { V , W , FULL }
 Type of multigrid cycle. More...
 
enum  ENUM_PARAM {
  NO_DEFORMATION = 0 , TRANSLATION = 1 , ROTATION = 2 , SCALE = 3 ,
  FFD_SETTING = 10 , FFD_CONTROL_POINT = 11 , FFD_NACELLE = 12 , FFD_GULL = 13 ,
  FFD_CAMBER = 14 , FFD_TWIST = 15 , FFD_THICKNESS = 16 , FFD_ROTATION = 18 ,
  FFD_CONTROL_POINT_2D = 19 , FFD_CAMBER_2D = 20 , FFD_THICKNESS_2D = 21 , FFD_CONTROL_SURFACE = 23 ,
  FFD_ANGLE_OF_ATTACK = 24 , HICKS_HENNE = 30 , PARABOLIC = 31 , NACA_4DIGITS = 32 ,
  AIRFOIL = 33 , CST = 34 , SURFACE_BUMP = 35 , SURFACE_FILE = 36 ,
  HICKS_HENNE_CAMBER = 37 , DV_EFIELD = 40 , DV_YOUNG = 41 , DV_POISSON = 42 ,
  DV_RHO = 43 , DV_RHO_DL = 44 , TRANSLATE_GRID = 50 , ROTATE_GRID = 51 ,
  SCALE_GRID = 52 , ANGLE_OF_ATTACK = 101
}
 Types of design parameterizations. More...
 
enum  ENUM_FFD_BLENDING { BSPLINE_UNIFORM = 0 , BEZIER = 1 }
 Types of FFD Blending function. More...
 
enum  ENUM_LINEAR_SOLVER {
  CONJUGATE_GRADIENT , BCGSTAB , FGMRES , RESTARTED_FGMRES ,
  FGCRODR , SMOOTHER , PASTIX_LDLT , PASTIX_LU
}
 Types of solvers for solving linear systems. More...
 
enum class  LINEAR_SOLVER_INNER { NONE , BCGSTAB , SMOOTHER }
 Inner solver for nested linear solver, only compatible with "flexible" linear solvers. More...
 
enum  ENUM_FFD_CONTINUITY { DERIVATIVE_NONE = 0 , DERIVATIVE_1ST = 1 , DERIVATIVE_2ND = 2 , USER_INPUT = 3 }
 Types surface continuity at the intersection with the FFD. More...
 
enum  ENUM_FFD_COORD_SYSTEM { CARTESIAN = 0 , CYLINDRICAL = 1 , SPHERICAL = 2 , POLAR = 3 }
 Types of coordinates systems for the FFD. More...
 
enum  ENUM_SENS_SMOOTHING { NO_SMOOTH = 0 , SOBOLEV = 1 , BIGRID = 2 }
 Types of sensitivity smoothing. More...
 
enum  ENUM_LINEAR_SOLVER_PREC {
  IDENTITY , JACOBI , LU_SGS , LINELET ,
  ILU , Q_LU_SGS , Q_JACOBI , Q_IDENTITY ,
  PASTIX_ILU =10 , PASTIX_LU_P , PASTIX_LDLT_P
}
 Types of preconditioners for the linear solver. More...
 
enum  ENUM_GEO_ANALYTIC {
  NO_GEO_ANALYTIC = 0 , NACA0012_AIRFOIL = 1 , NACA4412_AIRFOIL = 2 , CYLINDER = 3 ,
  BIPARABOLIC = 4
}
 Types of analytic definitions for various geometries. More...
 
enum  ENUM_GEO_DESCRIPTION { TWOD_AIRFOIL = 0 , WING = 1 , FUSELAGE = 2 , NACELLE = 3 }
 Types of axis orientation. More...
 
enum class  TIME_MARCHING {
  STEADY , TIME_STEPPING , DT_STEPPING_1ST , DT_STEPPING_2ND ,
  ROTATIONAL_FRAME , HARMONIC_BALANCE
}
 Types of schemes for unsteady computations. More...
 
enum  ENUM_DEFORM_STIFFNESS { CONSTANT_STIFFNESS = 0 , INVERSE_VOLUME = 1 , SOLID_WALL_DISTANCE = 2 }
 Types of element stiffnesses imposed for FEA mesh deformation. More...
 
enum  ENUM_DIRECTDIFF_VAR {
  NO_DERIVATIVE = 0 , D_MACH = 1 , D_AOA = 2 , D_PRESSURE = 3 ,
  D_TEMPERATURE = 4 , D_DENSITY = 5 , D_TURB2LAM = 6 , D_SIDESLIP = 7 ,
  D_VISCOSITY = 8 , D_REYNOLDS = 9 , D_DESIGN = 10 , D_YOUNG = 11 ,
  D_POISSON = 12 , D_RHO = 13 , D_RHO_DL = 14 , D_EFIELD = 15
}
 The direct differentation variables. More...
 
enum class  CHECK_TAPE_TYPE { OBJECTIVE_FUNCTION , FULL_SOLVER }
 Types of tapes that can be checked in a tape debug run. More...
 
enum class  CHECK_TAPE_VARIABLES { SOLVER_VARIABLES , MESH_COORDINATES }
 Types of variables that can be checked for in a tape debug run. More...
 
enum class  RECORDING {
  CLEAR_INDICES , SOLUTION_VARIABLES , MESH_COORDS , MESH_DEFORM ,
  SOLUTION_AND_MESH
}
 
enum  ENUM_INPUT_REF { SU2_REF = 1 , CUSTOM_REF = 2 }
 Types of input file formats. More...
 
enum  PERIODIC_QUANTITIES {
  PERIODIC_NONE , PERIODIC_VOLUME , PERIODIC_NEIGHBORS , PERIODIC_RESIDUAL ,
  PERIODIC_LAPLACIAN , PERIODIC_MAX_EIG , PERIODIC_SENSOR , PERIODIC_SOL_GG ,
  PERIODIC_PRIM_GG , PERIODIC_SOL_LS , PERIODIC_PRIM_LS , PERIODIC_SOL_ULS ,
  PERIODIC_PRIM_ULS , PERIODIC_SOL_GG_R , PERIODIC_PRIM_GG_R , PERIODIC_SOL_LS_R ,
  PERIODIC_PRIM_LS_R , PERIODIC_SOL_ULS_R , PERIODIC_PRIM_ULS_R , PERIODIC_LIM_SOL_1 ,
  PERIODIC_LIM_SOL_2 , PERIODIC_LIM_PRIM_1 , PERIODIC_LIM_PRIM_2 , PERIODIC_IMPLICIT
}
 Vertex-based quantities exchanged during periodic marker communications. More...
 
enum class  MPI_QUANTITIES {
  SOLUTION , SOLUTION_OLD , SOLUTION_GRADIENT , SOLUTION_GRAD_REC ,
  SOLUTION_LIMITER , SOLUTION_GEOMETRY , PRIMITIVE_GRADIENT , PRIMITIVE_GRAD_REC ,
  PRIMITIVE_LIMITER , UNDIVIDED_LAPLACIAN , MAX_EIGENVALUE , SENSOR ,
  AUXVAR_GRADIENT , COORDINATES , COORDINATES_OLD , MAX_LENGTH ,
  GRID_VELOCITY , SOLUTION_EDDY , STOCH_SOURCE_LANG , DES_LENGTHSCALE ,
  SOLUTION_MATRIX , SOLUTION_MATRIXTRANS , NEIGHBORS , SOLUTION_FEA ,
  MESH_DISPLACEMENTS , SOLUTION_TIME_N , SOLUTION_TIME_N1 , MOM_COEFF ,
  MOM_CORRECTION , HBYA_CORRECTION
}
 Vertex-based quantities exchanged in MPI point-to-point communications. More...
 
enum  COMM_LEVEL { COMM_NONE = 0 , COMM_MINIMAL = 1 , COMM_FULL = 2 }
 MPI communication level. More...
 
enum class  ENUM_FILTER_KERNEL {
  CONSTANT_WEIGHT , CONICAL_WEIGHT , GAUSSIAN_WEIGHT , DILATE_MORPH ,
  ERODE_MORPH
}
 Types of filter kernels, initially intended for structural topology optimization applications. More...
 
enum class  ENUM_PROJECTION_FUNCTION { NONE , HEAVISIDE_UP , HEAVISIDE_DOWN }
 Types of projection function, initially intended for structural topology optimization applications. More...
 
enum class  VERIFICATION_SOLUTION {
  NONE , INVISCID_VORTEX , RINGLEB , NS_UNIT_QUAD ,
  TAYLOR_GREEN_VORTEX , INC_TAYLOR_GREEN_VORTEX , MMS_NS_UNIT_QUAD , MMS_NS_UNIT_QUAD_WALL_BC ,
  MMS_NS_TWO_HALF_CIRCLES , MMS_NS_TWO_HALF_SPHERES , MMS_INC_EULER , MMS_INC_NS ,
  USER_DEFINED_SOLUTION
}
 the different validation solution More...
 
enum class  ENUM_STREAMWISE_PERIODIC { NONE , PRESSURE_DROP , MASSFLOW }
 Types of streamwise periodicity. More...
 
enum class  POD_KIND { STATIC , INCREMENTAL }
 Type of POD basis generation (for use with libROM) More...
 
enum class  LINEAR_SOLVER_MODE { STANDARD , MESH_DEFORM , GRADIENT_MODE , POISSON }
 Type of operation for the linear system solver, changes the source of solver options. More...
 
enum class  ENUM_SOBOLEV_MODUS { NONE , PARAM_LEVEL_COMPLETE , MESH_LEVEL , ONLY_GRAD }
 mode of operation for the sobolev smoothing solver. More...
 
enum class  DEFORM_KIND { ELASTIC , RBF }
 Type of mesh deformation. More...
 

Functions

unsigned short nFacesOfElementType (unsigned short elementType)
 Get the number of faces of the element.
 
unsigned short nPointsOfElementType (unsigned short elementType)
 Get the number of points of the element.
 
int GetSU2BinaryScalarSize (int precisionField)
 Size in bytes of the floating point data of a native SU2 binary solution file.
 
int GetSU2BinaryMetadataSize (int precisionField, int metadataField)
 Number of metadata scalars in the trailer of a native SU2 binary solution file.
 
void SU2BinaryDataToPassive (const void *buffer, int scalarSize, unsigned long count, passivedouble *data)
 Convert floating point data read from a native SU2 binary solution file, which may have been written by a build of different precision, to the precision of this build.
 
TURB_FAMILY TurbModelFamily (TURB_MODEL model)
 Associate turb models with their family.
 
SST_ParsedOptions ParseSSTOptions (const SST_OPTIONS *SST_Options, unsigned short nSST_Options, int rank)
 Function to parse SST options.
 
SA_ParsedOptions ParseSAOptions (const SA_OPTIONS *SA_Options, unsigned short nSA_Options, int rank)
 Function to parse SA options.
 
LM_ParsedOptions ParseLMOptions (const LM_OPTIONS *LM_Options, unsigned short nLM_Options, int rank, TURB_MODEL Kind_Turb_Model)
 Function to parse LM options.
 
bool isParaview (OUTPUT_TYPE format)
 Return true if format is one of the Paraview options.
 
bool isTecplot (OUTPUT_TYPE format)
 Return true if format is one of the Tecplot options.
 

Variables

const unsigned int EXIT_DIVERGENCE = 2
 Exit code (divergence).
 
const unsigned int MAX_PARAMETERS = 10
 Maximum number of parameters for a design variable definition.
 
const unsigned int MAX_NUMBER_PERIODIC = 10
 Maximum number of periodic boundary conditions.
 
const unsigned int MAX_STRING_SIZE = 400
 Maximum size of a generic string.
 
const unsigned int MAX_NUMBER_FFD = 15
 Maximum number of FFDBoxes for the FFD.
 
const unsigned int MAX_TERMS = 7
 Maximum number of terms in the numerical equations (dimension of solver container array).
 
const unsigned int MAX_ZONES = 3
 Maximum number of zones.
 
const unsigned int MAX_FE_KINDS = 7
 Maximum number of Finite Elements.
 
const unsigned int NO_RK_ITER = 0
 No Runge-Kutta iteration.
 
const unsigned int OVERHEAD = 4
 Overhead space above nMarker when allocating space for boundary elems (MPI + periodic).
 
const unsigned int MESH_0 = 0
 Definition of the finest grid level.
 
const unsigned int MESH_1 = 1
 Definition of the finest grid level.
 
const unsigned int ZONE_0 = 0
 Definition of the first grid domain.
 
const unsigned int ZONE_1 = 1
 Definition of the second grid domain.
 
const unsigned int INST_0 = 0
 Definition of the first instance per grid level.
 
constexpr passivedouble STANDARD_GRAVITY = 9.80665
 Acceleration due to gravity at surface of earth.
 
constexpr passivedouble UNIVERSAL_GAS_CONSTANT = 8.3144598
 Universal gas constant in J/(mol*K)
 
constexpr passivedouble BOLTZMANN_CONSTANT = 1.3806503E-23
 Boltzmann's constant [J K^-1].
 
constexpr passivedouble AVOGAD_CONSTANT = 6.0221415E26
 Avogadro's constant, number of particles in one kmole.
 
constexpr passivedouble FUND_ELEC_CHARGE_CGS = 4.8032047E-10
 Fundamental electric charge in CGS units, cm^(3/2) g^(1/2) s^(-1).
 
constexpr passivedouble STD_REF_TEMP = 298.15
 Standard reference temperature for enthalpy in Kelvin.
 
constexpr passivedouble EPS = 1.0E-16
 Error scale.
 
constexpr passivedouble TURB_EPS = 1.0E-16
 Turbulent Error scale.
 
constexpr passivedouble ONE2 = 0.5
 One divided by two.
 
constexpr passivedouble ONE3 = 1.0 / 3.0
 One divided by three.
 
constexpr passivedouble TWO3 = 2.0 / 3.0
 Two divided by three.
 
constexpr passivedouble FOUR3 = 4.0 / 3.0
 Four divided by three.
 
constexpr passivedouble PI_NUMBER = 3.14159265358979323846
 Pi number (not using M_PI to avoid Windows issues).
 
constexpr passivedouble STEFAN_BOLTZMANN = 5.670367E-08
 Stefan-Boltzmann constant in W/(m^2*K^4).
 
const int MASTER_NODE = 0
 Master node for MPI parallelization.
 
const int SINGLE_NODE = 1
 There is only a node in the MPI parallelization.
 
const int SINGLE_ZONE = 1
 There is only a zone.
 
constexpr unsigned short N_ELEM_TYPES = 7
 General output & CGNS defines.
 
constexpr unsigned short N_POINTS_LINE = 2
 General output & CGNS defines.
 
constexpr unsigned short N_POINTS_TRIANGLE = 3
 General output & CGNS defines.
 
constexpr unsigned short N_POINTS_QUADRILATERAL = 4
 General output & CGNS defines.
 
constexpr unsigned short N_POINTS_TETRAHEDRON = 4
 General output & CGNS defines.
 
constexpr unsigned short N_POINTS_HEXAHEDRON = 8
 General output & CGNS defines.
 
constexpr unsigned short N_POINTS_PYRAMID = 5
 General output & CGNS defines.
 
constexpr unsigned short N_POINTS_PRISM = 6
 General output & CGNS defines.
 
constexpr unsigned short N_POINTS_MAXIMUM = 8
 Max. out of the above, used for static arrays, keep it up to date.
 
constexpr unsigned short N_FACES_LINE = 1
 General output & CGNS defines.
 
constexpr unsigned short N_FACES_TRIANGLE = 3
 General output & CGNS defines.
 
constexpr unsigned short N_FACES_QUADRILATERAL = 4
 General output & CGNS defines.
 
constexpr unsigned short N_FACES_TETRAHEDRON = 4
 General output & CGNS defines.
 
constexpr unsigned short N_FACES_PYRAMID = 5
 General output & CGNS defines.
 
constexpr unsigned short N_FACES_PRISM = 5
 General output & CGNS defines.
 
constexpr unsigned short N_FACES_HEXAHEDRON = 6
 General output & CGNS defines.
 
constexpr unsigned short N_FACES_MAXIMUM = 6
 Max. out of the above, used for static arrays, keep it up to date.
 
const int CGNS_STRING_SIZE = 33
 Length of strings used in the CGNS format.
 
const int SU2_RESTART_MAGIC_NUMBER = 535532
 Hex representation of "SU2".
 
const int SU2_RESTART_HEADER_SIZE = 5
 Number of ints in the header.
 
const int SU2_RESTART_PRECISION_IDX = 3
 Position of the precision field.
 
const int SU2_RESTART_METADATA_IDX = 4
 Position of the legacy metadata count.
 
const int SU2_RESTART_MAX_METADATA = 8
 Most metadata doubles a trailer ever had.
 
const int SU2_BINARY_STRING_SIZE = 65
 Length of strings (e.g. marker names) used in the native SU2 binary mesh format. Shared by CSU2BinaryMeshReaderBase and CSU2MeshBinaryFileWriter so they cannot drift apart.
 
const int SU2_CONN_SIZE = 10
 Size of the connectivity array that is allocated for each element that we read from a mesh file in the format [[globalID vtkType n0 n1 n2 n3 n4 n5 n6 n7 n8].
 
const int SU2_CONN_SKIP = 2
 Offset to skip the globalID and VTK type at the start of the element connectivity list for each CGNS element.
 
constexpr passivedouble COLORING_EFF_THRESH = 0.875
 Below this value fallback strategies are used instead.
 
constexpr int N_POLY_COEFFS = 5
 Number of coefficients in temperature polynomial fits for fluid models.
 
const int CONV_TERM = 0
 Position of the convective terms in the numerics container array.
 
const int VISC_TERM = 1
 Position of the viscous terms in the numerics container array.
 
const int SOURCE_FIRST_TERM = 2
 Position of the first source term in the numerics container array.
 
const int SOURCE_SECOND_TERM = 3
 Position of the second source term in the numerics container array.
 
const int CONV_BOUND_TERM = 4
 Position of the convective boundary terms in the numerics container array.
 
const int VISC_BOUND_TERM = 5
 Position of the viscous boundary terms in the numerics container array.
 
const int GRAD_TERM = 6
 Position of the gradient smoothing terms in the numerics container array.
 
const int FEA_TERM = 0
 Position of the finite element analysis terms in the numerics container array.
 
const int DE_TERM = 1
 Position of the dielectric terms in the numerics container array.
 
const int MAT_NHCOMP = 2
 Position of the Neo-Hookean compressible material model.
 
const int MAT_IDEALDE = 3
 Position of the Ideal-DE material model.
 
const int MAT_KNOWLES = 4
 Position of the Knowles material model.
 
const int EL_LINE = 6
 Types of finite elements (in 1D or 2D or 3D)
 
const int EL_TRIA = 0
 Elements of three nodes (2D).
 
const int EL_QUAD = 1
 Elements of four nodes (2D).
 
const int EL_TRIA2 = 2
 Elements of three nodes (2D), with second order gauss quadrature.
 
const int EL_TETRA = 0
 Elements of four nodes (3D).
 
const int EL_HEXA = 1
 Elements of eight nodes (3D).
 
const int EL_PYRAM = 2
 Elements of five nodes (3D).
 
const int EL_PRISM = 3
 Elements of six nodes (3D).
 
const int EL_TETRA2 = 4
 Elements of four nodes, with second order gauss quadrature (3D).
 
const int EL_PYRAM2 = 5
 Elements of five nodes, with third order gauss quadrature (3D).
 

Detailed Description

Defines classes for referencing options for easy input in CConfig.

Author
J. Hicken, B. Tracey
Version
8.5.0 "Harrier"

SU2 Project Website: https://su2code.github.io

The SU2 Project is maintained by the SU2 Foundation (http://su2foundation.org)

Copyright 2012-2026, SU2 Contributors (cf. AUTHORS.md)

SU2 is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

SU2 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with SU2. If not, see http://www.gnu.org/licenses/.

Macro Definition Documentation

◆ MakePair

#define MakePair (   a,
  b 
)

Typedef Documentation

◆ MapType

template<class T , class U >
using MapType = CEmptyMap<T,U>

Enumeration Type Documentation

◆ anonymous enum

anonymous enum : unsigned int
Enumerator
MAX_SOLS 

◆ ACTDISK_TYPE

Types actuator disk boundary treatments.

Enumerator
VARIABLES_JUMP 

User specifies the variables jump.

BC_THRUST 

User specifies the BC thrust.

NET_THRUST 

User specifies the Net thrust.

DRAG_MINUS_THRUST 

User specifies the D-T.

MASSFLOW 

User specifies the massflow.

POWER 

User specifies the power.

VARIABLE_LOAD 

User specifies the load distribution.

BLADE_ELEMENT 

User specifies to use Blade element method.

◆ ANSWER

enum ANSWER

Boolean answers.

Enumerator
NONE 
NO 

Boolean definition of no.

YES 

Boolean definition of yes.

◆ AVERAGE_TYPE

Average method for marker analyze.

Enumerator
AVERAGE_AREA 

Area-weighted average.

AVERAGE_MASSFLUX 

Mass-flux weighted average.

◆ AVERAGEPROCESS_TYPE

Types of mixing process for averaging quantities at the boundaries.

Enumerator
ALGEBRAIC 

an algebraic average is computed at the boundary of interest.

AREA 

an area average is computed at the boundary of interest.

MIXEDOUT 

an mixed-out average is computed at the boundary of interest.

MASSFLUX 

a mass flow average is computed at the boundary of interest.

◆ BC_TYPE

enum BC_TYPE

Types of boundary conditions.

Enumerator
EULER_WALL 

Boundary Euler wall definition.

FAR_FIELD 

Boundary far-field definition.

SYMMETRY_PLANE 

Boundary symmetry plane definition.

INLET_FLOW 

Boundary inlet flow definition.

OUTLET_FLOW 

Boundary outlet flow definition.

PERIODIC_BOUNDARY 

Periodic boundary definition.

NEARFIELD_BOUNDARY 

Near-Field boundary definition.

CUSTOM_BOUNDARY 

custom boundary definition.

DISPLACEMENT_BOUNDARY 

Boundary displacement definition.

LOAD_BOUNDARY 

Boundary Load definition.

FLOWLOAD_BOUNDARY 

Boundary Load definition.

SUPERSONIC_INLET 

Boundary supersonic inlet definition.

SUPERSONIC_OUTLET 

Boundary supersonic inlet definition.

ENGINE_INFLOW 

Boundary nacelle inflow.

ENGINE_EXHAUST 

Boundary nacelle exhaust.

RIEMANN_BOUNDARY 

Riemann Boundary definition.

ISOTHERMAL 

No slip isothermal wall boundary condition.

HEAT_FLUX 

No slip constant heat flux wall boundary condition.

HEAT_TRANSFER 

No slip heat transfer boundary condition.

ACTDISK_INLET 

Actuator disk inlet boundary definition.

ACTDISK_OUTLET 

Actuator disk outlet boundary definition.

CLAMPED_BOUNDARY 

Clamped Boundary definition.

LOAD_DIR_BOUNDARY 

Boundary Load definition.

LOAD_SINE_BOUNDARY 

Sine-waveBoundary Load definition.

GILES_BOUNDARY 

Giles Boundary definition.

INTERNAL_BOUNDARY 

Internal Boundary definition.

FLUID_INTERFACE 

Domain interface definition.

DISP_DIR_BOUNDARY 

Boundary displacement definition.

DAMPER_BOUNDARY 

Damper.

MIXING_PLANE_INTERFACE 
CHT_WALL_INTERFACE 

Domain interface definition.

SMOLUCHOWSKI_MAXWELL 

Smoluchoski/Maxwell wall boundary condition.

SEND_RECEIVE 

Boundary send-receive definition.

◆ BGS_RELAXATION

enum class BGS_RELAXATION
strong

Kinds of relaxation for multizone problems.

Enumerator
NONE 

No relaxation in the strongly coupled approach.

FIXED 

Relaxation with a fixed parameter.

AITKEN 

Relaxation using Aitken's dynamic parameter.

◆ CENTERED

enum class CENTERED
strong

Types of centered spatial discretizations.

Enumerator
NONE 

No centered scheme is used.

JST 

Jameson-Smith-Turkel centered numerical method.

LAX 

Lax-Friedrich centered numerical method.

JST_MAT 

JST with matrix dissipation.

JST_KE 

Kinetic Energy preserving Jameson-Smith-Turkel centered numerical method.

LD2 

Low-Dissipation Low-Dispersion (LD2) centered scheme.

CDS 

Central Difference Scheme used for pressure based solver.

◆ CHECK_TAPE_TYPE

enum class CHECK_TAPE_TYPE
strong

Types of tapes that can be checked in a tape debug run.

Enumerator
OBJECTIVE_FUNCTION 

Tape that only includes dependencies and objective function calculation.

FULL_SOLVER 

Tape that includes dependencies and all solvers.

◆ CHECK_TAPE_VARIABLES

enum class CHECK_TAPE_VARIABLES
strong

Types of variables that can be checked for in a tape debug run.

Enumerator
SOLVER_VARIABLES 

A (debug) tag will be assigned to solver/conservative variables.

MESH_COORDINATES 

A (debug) tag will be assigned to solver/conservative variables and mesh coordinates.

◆ CHT_COUPLING

Kinds of coupling methods at CHT interfaces. The first (temperature) part determines the BC method on the fluid side, the second (heatflux) part determines the BC method on the solid side of the CHT interface.

Enumerator
DIRECT_TEMPERATURE_NEUMANN_HEATFLUX 
AVERAGED_TEMPERATURE_NEUMANN_HEATFLUX 
DIRECT_TEMPERATURE_ROBIN_HEATFLUX 
AVERAGED_TEMPERATURE_ROBIN_HEATFLUX 

◆ COMM_LEVEL

enum COMM_LEVEL

MPI communication level.

Enumerator
COMM_NONE 

Disable all MPI comms. Purely for testing, as results are incorrect.

COMM_MINIMAL 

Perform only the minimal set of MPI communications for correctness. Disables many console and output comms.

COMM_FULL 

Perform all MPI communications.

◆ COMM_TYPE

enum class COMM_TYPE
strong
Enumerator
UNSIGNED_LONG 

Communication type for unsigned long.

LONG 

Communication type for long.

UNSIGNED_SHORT 

Communication type for unsigned short.

FLOAT 

Communication type for su2mixedfloat.

DOUBLE 

Communication type for double.

PASSIVE_DOUBLE 

Communication type for passivedouble.

CHAR 

Communication type for char.

SHORT 

Communication type for short.

INT 

Communication type for int.

◆ CONDUCTIVITYMODEL

enum class CONDUCTIVITYMODEL
strong

Types of thermal conductivity model.

Enumerator
CONSTANT 

Constant thermal conductivity.

CONSTANT_PRANDTL 

Constant Prandtl number.

POLYNOMIAL 

Polynomial thermal conductivity.

FLAMELET 

LUT method for flamelets.

COOLPROP 

COOLPROP thermal conductivity.

◆ CONDUCTIVITYMODEL_TURB

enum class CONDUCTIVITYMODEL_TURB
strong

Types of turbulent thermal conductivity model.

Enumerator
NONE 

No turbulent contribution to the effective thermal conductivity for RANS.

CONSTANT_PRANDTL 

Include contribution to effective conductivity using constant turbulent Prandtl number for RANS.

◆ DEFORM_KIND

enum class DEFORM_KIND
strong

Type of mesh deformation.

Enumerator
ELASTIC 

Linear elasticity method.

RBF 

Radial basis function interpolation.

◆ DIFFUSIVITYMODEL

enum class DIFFUSIVITYMODEL
strong

types of mass diffusivity models

Enumerator
CONSTANT_DIFFUSIVITY 

Constant mass diffusivity for scalar transport.

CONSTANT_SCHMIDT 

Constant Schmidt number for mass diffusion in scalar transport.

UNITY_LEWIS 

Unity Lewis model for mass diffusion in scalar transport.

CONSTANT_LEWIS 

Different Lewis number model for mass diffusion in scalar transport.

FLAMELET 

flamelet model for tabulated chemistry, diffusivity from lookup table

◆ ENGINE_INFLOW_TYPE

Types engine inflow boundary treatments.

Enumerator
FAN_FACE_MACH 

User specifies fan face mach number.

FAN_FACE_MDOT 

User specifies Static pressure.

FAN_FACE_PRESSURE 

User specifies Static pressure.

◆ ENUM_ADER_PREDICTOR

Type of predictor for the ADER-DG time integration scheme.

Enumerator
ADER_ALIASED_PREDICTOR 

Aliased predictor, easiest to do.

ADER_NON_ALIASED_PREDICTOR 

Non-aliased predictor. Consistent, but more difficult.

◆ ENUM_DATADRIVEN_METHOD

enum class ENUM_DATADRIVEN_METHOD
strong

Types of interpolation methods for data-driven fluid models.

Enumerator
LUT 
MLP 

◆ ENUM_DEFORM_STIFFNESS

Types of element stiffnesses imposed for FEA mesh deformation.

Enumerator
CONSTANT_STIFFNESS 

Impose a constant stiffness for each element (steel).

INVERSE_VOLUME 

Impose a stiffness for each element that is inversely proportional to cell volume.

SOLID_WALL_DISTANCE 

Impose a stiffness for each element that is proportional to the distance from the solid surface.

◆ ENUM_DIRECTDIFF_VAR

The direct differentation variables.

Enumerator
NO_DERIVATIVE 
D_MACH 

Derivative w.r.t. the Mach number.

D_AOA 

Derivative w.r.t. the angle of attack.

D_PRESSURE 

Derivative w.r.t. the freestream pressure.

D_TEMPERATURE 

Derivative w.r.t. the freestream temperature.

D_DENSITY 

Derivative w.r.t. the freestream density.

D_TURB2LAM 

Derivative w.r.t. the turb2lam.

D_SIDESLIP 

Derivative w.r.t. the sideslip angle.

D_VISCOSITY 

Derivative w.r.t. the viscosity.

D_REYNOLDS 

Derivative w.r.t. the reynolds number.

D_DESIGN 

Derivative w.r.t. the design??

D_YOUNG 

Derivative w.r.t. the Young's modulus.

D_POISSON 

Derivative w.r.t. the Poisson's ratio.

D_RHO 

Derivative w.r.t. the solid density (inertial)

D_RHO_DL 

Derivative w.r.t. the density for dead loads.

D_EFIELD 

Derivative w.r.t. the electric field.

◆ ENUM_DVFEA

enum ENUM_DVFEA

Kinds of Design Variables for FEA problems.

Enumerator
NODV_FEA 

No design variable for FEA problems.

YOUNG_MODULUS 

Young modulus (E) as design variable.

POISSON_RATIO 

Poisson ratio (Nu) as design variable.

DENSITY_VAL 

Density (Rho) as design variable.

DEAD_WEIGHT 

Dead Weight (Rho_DL) as design variable.

ELECTRIC_FIELD 

Electric field (E) as design variable.

◆ ENUM_DYN_TRANSFER_METHOD

Types of dynamic transfer methods.

Enumerator
INSTANTANEOUS 

No ramp, load is transfer instantaneously.

POL_ORDER_1 

The load is transferred using a ramp.

POL_ORDER_3 

The load is transferred using an order 3 polynomial function.

POL_ORDER_5 

The load is transferred using an order 5 polynomial function.

SIGMOID_10 

The load is transferred using a sigmoid with parameter 10.

SIGMOID_20 

The load is transferred using a sigmoid with parameter 20.

◆ ENUM_FEM

enum ENUM_FEM

Types of FEM spatial discretizations.

Enumerator
NO_FEM 

No finite element scheme is used.

DG 

Discontinuous Galerkin numerical method.

◆ ENUM_FFD_BLENDING

Types of FFD Blending function.

Enumerator
BSPLINE_UNIFORM 

BSpline blending.

BEZIER 

Bezier blending.

◆ ENUM_FFD_CONTINUITY

Types surface continuity at the intersection with the FFD.

Enumerator
DERIVATIVE_NONE 

No derivative continuity.

DERIVATIVE_1ST 

First derivative continuity.

DERIVATIVE_2ND 

Second derivative continuity.

USER_INPUT 

User input.

◆ ENUM_FFD_COORD_SYSTEM

Types of coordinates systems for the FFD.

Enumerator
CARTESIAN 

Cartesian coordinate system.

CYLINDRICAL 

Cylindrical coordinate system.

SPHERICAL 

Spherical coordinate system.

POLAR 

Polar coordinate system.

◆ ENUM_FILTER_KERNEL

enum class ENUM_FILTER_KERNEL
strong

Types of filter kernels, initially intended for structural topology optimization applications.

Enumerator
CONSTANT_WEIGHT 

Uniform weight.

CONICAL_WEIGHT 

Linear decay with distance from center point [Bruns and Tortorelli, 2001].

GAUSSIAN_WEIGHT 

Bell shape around center point [Bruns and Tortorelli, 2003].

DILATE_MORPH 

Continuous version of the dilate morphology operator [Sigmund 2007].

ERODE_MORPH 

Continuous version of the erode morphology operator [Sigmund 2007].

◆ ENUM_FLOW_GRADIENT

Types of schemes to compute the flow gradient.

Enumerator
NO_GRADIENT 

No gradient method. Only possible for reconstruction gradient, in which case, the option chosen for NUM_METHOD_GRAD is used.

GREEN_GAUSS 

Gradient computation using Green-Gauss theorem.

LEAST_SQUARES 

Gradient computation using unweighted least squares.

WEIGHTED_LEAST_SQUARES 

Gradients computation using inverse-distance weighted least squares.

◆ ENUM_FLUIDMODEL

Types of fluid model.

Enumerator
STANDARD_AIR 

Standard air gas model.

IDEAL_GAS 

Ideal gas model.

VW_GAS 

Van Der Waals gas model.

PR_GAS 

Perfect Real gas model.

CONSTANT_DENSITY 

Constant density gas model.

INC_IDEAL_GAS 

Incompressible ideal gas model.

INC_IDEAL_GAS_POLY 

Inc. ideal gas, polynomial gas model.

MUTATIONPP 

Mutation++ gas model for nonequilibrium flow.

SU2_NONEQ 

User defined gas model for nonequilibrium flow.

FLUID_MIXTURE 

Species mixture model.

COOLPROP 

Thermodynamics library.

FLUID_FLAMELET 

lookup table (LUT) method for premixed flamelets.

DATADRIVEN_FLUID 

multi-layer perceptron driven fluid model.

◆ ENUM_GASMODEL

types of gas models

Enumerator
NO_MODEL 
ARGON 
AIR7 
AIR21 
O2 
N2 
AIR5 
ARGON_SID 
ONESPECIES 

◆ ENUM_GEO_ANALYTIC

Types of analytic definitions for various geometries.

Enumerator
NO_GEO_ANALYTIC 

No analytic definition of the geometry.

NACA0012_AIRFOIL 

Use the analytical definition of the NACA0012 for doing the grid adaptation.

NACA4412_AIRFOIL 

Use the analytical definition of the NACA4412 for doing the grid adaptation.

CYLINDER 

Use the analytical definition of a cylinder for doing the grid adaptation.

BIPARABOLIC 

Use the analytical definition of a biparabolic airfoil for doing the grid adaptation.

◆ ENUM_GEO_DESCRIPTION

Types of axis orientation.

Enumerator
TWOD_AIRFOIL 

Airfoil analysis.

WING 

Wing analysis.

FUSELAGE 

Fuselage analysis.

NACELLE 

Nacelle analysis.

◆ ENUM_GRID

enum ENUM_GRID

Types of grid file formats.

Enumerator
SU2 

SU2 ascii format.

SU2_BIN 

SU2 binary format.

CGNS_GRID 

CGNS format for the computational grid.

RECTANGLE 

2D rectangular mesh with N x M points of size Lx x Ly.

BOX 

3D box mesh with N x M x L points of size Lx x Ly x Lz.

◆ ENUM_GRIDMOVEMENT

Types of unsteady mesh motion.

Enumerator
NO_MOVEMENT 

Simulation on a static mesh.

RIGID_MOTION 

Simulation with rigid mesh motion (plunging/pitching/rotation).

ROTATING_FRAME 

Simulation in a rotating frame.

STEADY_TRANSLATION 

Simulation in a steadily translating frame.

GUST 

Simulation on a static mesh with a gust.

◆ ENUM_GUST_DIR

Type of wind direction.

Enumerator
X_DIR 

Gust direction-X.

Y_DIR 

Gust direction-Y.

Z_DIR 

Gust direction-Z.

◆ ENUM_GUST_TYPE

Type of wind gusts.

Enumerator
NO_GUST 

No gust.

TOP_HAT 

Top-hat function shaped gust

SINE 

Sine shaped gust.

ONE_M_COSINE 

1-cosine shaped gust

VORTEX 

A gust made from vortices.

EOG 

An extreme operating gust.

◆ ENUM_HEAT_TIMESTEP

Type of heat timestep calculation.

Enumerator
MINIMUM 

Local time stepping based on minimum lambda.

CONVECTIVE 

Local time stepping based on convective spectral radius.

VISCOUS 

Local time stepping based on viscous spectral radius.

BYFLOW 

Unsing the mean solvers time step.

◆ ENUM_HYBRIDRANSLES

Types of hybrid RANS/LES models.

Enumerator
NO_HYBRIDRANSLES 

No turbulence model.

SA_DES 

Kind of Hybrid RANS/LES (SA - Detached Eddy Simulation (DES)).

SA_DDES 

Kind of Hybrid RANS/LES (SA - Delayed DES (DDES) with Delta_max SGS ).

SA_ZDES 

Kind of Hybrid RANS/LES (SA - Delayed DES (DDES) with Vorticity based SGS like Zonal DES).

SA_EDDES 

Kind of Hybrid RANS/LES (SA - Delayed DES (DDES) with Shear Layer Adapted SGS: Enhanced DDES).

◆ ENUM_INIT_OPTION

Types of initialization option.

Enumerator
REYNOLDS 

Reynold's number initalization.

TD_CONDITIONS 

Total conditions initalization.

◆ ENUM_INPUT_REF

Types of input file formats.

Enumerator
SU2_REF 

SU2 input format (from a restart).

CUSTOM_REF 

CGNS input format for the computational grid.

◆ ENUM_KIND_NONDIM

different non-dimensional modes

Enumerator
DIMENSIONAL 

Dimensional simulation (compressible or incompressible).

FREESTREAM_PRESS_EQ_ONE 

Non-dimensional compressible simulation with freestream pressure equal to 1.0.

FREESTREAM_VEL_EQ_MACH 

Non-dimensional compressible simulation with freestream velocity equal to Mach number.

FREESTREAM_VEL_EQ_ONE 

Non-dimensional compressible simulation with freestream pressure equal to 1.0.

INITIAL_VALUES 

Non-dimensional incompressible simulation based on intial values for external flow.

REFERENCE_VALUES 

Non-dimensional incompressible simulation based on custom reference values.

◆ ENUM_LINEAR_SOLVER

Types of solvers for solving linear systems.

Enumerator
CONJUGATE_GRADIENT 

Preconditionated conjugate gradient method for grid deformation.

BCGSTAB 

BCGSTAB - Biconjugate Gradient Stabilized Method (main solver).

FGMRES 

Flexible Generalized Minimal Residual method.

RESTARTED_FGMRES 

Flexible Generalized Minimal Residual method with restart.

FGCRODR 

Flexible Generalized Conjugate Residual Method with Inner Orthogonalization and Deflated Restarting.

SMOOTHER 

Iterative smoother.

PASTIX_LDLT 

PaStiX LDLT (complete) factorization.

PASTIX_LU 

PaStiX LU (complete) factorization.

◆ ENUM_LINEAR_SOLVER_PREC

Types of preconditioners for the linear solver.

Enumerator
IDENTITY 

No preconditioner.

JACOBI 

Jacobi preconditioner.

LU_SGS 

LU SGS preconditioner.

LINELET 

Line implicit preconditioner.

ILU 

ILU(k) preconditioner.

Q_LU_SGS 

LU-SGS with quantized (int8) off-diagonal storage; L/U are never allocated as ScalarType.

Q_JACOBI 

Jacobi with quantized (int8) off-diagonal storage; same matvec quantization as Q_LU_SGS, the diagonal inverse is still computed and applied at full precision.

Q_IDENTITY 

No preconditioner, but the matrix-vector product still uses quantized (int8) off-diagonal storage, same matvec quantization as Q_LU_SGS/Q_JACOBI.

PASTIX_ILU 

PaStiX ILU(k) preconditioner.

PASTIX_LU_P 

PaStiX LU as preconditioner.

PASTIX_LDLT_P 

PaStiX LDLT as preconditioner.

◆ ENUM_MATRIX_COLORING

Types of matrix coloring to compute a sparse Jacobian matrix.

Enumerator
GREEDY_COLORING 

Greedy type of algorithm for the coloring.

NATURAL_COLORING 

One color for every DOF, very slow. Only to be used for debugging.

◆ ENUM_MEASUREMENTS

different system of measurements

Enumerator
SI 

Definition of compressible solver.

US 

Definition of incompressible solver.

◆ ENUM_MULTIZONE

enum class ENUM_MULTIZONE
strong

Different solver types for multizone problems.

Enumerator
MZ_BLOCK_GAUSS_SEIDEL 

Definition of a Block-Gauss-Seidel multizone solver.

MZ_BLOCK_JACOBI 

Definition of a Block-Jacobi solver.

◆ ENUM_OBJECTIVE

Types of objective functions.

Enumerator
DRAG_COEFFICIENT 

Drag objective function definition.

LIFT_COEFFICIENT 

Lift objective function definition.

SIDEFORCE_COEFFICIENT 

Side force objective function definition.

EFFICIENCY 

Efficiency objective function definition.

INVERSE_DESIGN_PRESSURE 

Pressure objective function definition (inverse design).

INVERSE_DESIGN_HEATFLUX 

Heat flux objective function definition (inverse design).

TOTAL_HEATFLUX 

Total heat flux.

MAXIMUM_HEATFLUX 

Maximum heat flux.

AVG_TEMPERATURE 

Total averaged temperature.

MOMENT_X_COEFFICIENT 

Pitching moment objective function definition.

MOMENT_Y_COEFFICIENT 

Rolling moment objective function definition.

MOMENT_Z_COEFFICIENT 

Yawing objective function definition.

EQUIVALENT_AREA 

Equivalent area objective function definition.

NEARFIELD_PRESSURE 

NearField Pressure objective function definition.

FORCE_X_COEFFICIENT 

X-direction force objective function definition.

FORCE_Y_COEFFICIENT 

Y-direction force objective function definition.

FORCE_Z_COEFFICIENT 

Z-direction force objective function definition.

THRUST_COEFFICIENT 

Thrust objective function definition.

TORQUE_COEFFICIENT 

Torque objective function definition.

FIGURE_OF_MERIT 

Rotor Figure of Merit objective function definition.

BUFFET_SENSOR 

Sensor for detecting separation.

SURFACE_TOTAL_PRESSURE 

Total Pressure objective function definition.

SURFACE_STATIC_PRESSURE 

Static Pressure objective function definition.

SURFACE_STATIC_TEMPERATURE 

Static Temperature objective function definition.

SURFACE_MASSFLOW 

Mass Flow Rate objective function definition.

SURFACE_MACH 

Mach number objective function definition.

SURFACE_UNIFORMITY 

Flow uniformity objective function definition.

SURFACE_SECONDARY 

Secondary flow strength objective function definition.

SURFACE_MOM_DISTORTION 

Momentum distortion objective function definition.

SURFACE_SECOND_OVER_UNIFORM 

Secondary over uniformity (relative secondary strength) objective function definition.

SURFACE_PRESSURE_DROP 

Pressure drop objective function definition.

SURFACE_SPECIES_0 

Surface Avg. Species_0 objective function definition.

SURFACE_SPECIES_VARIANCE 

Species Variance objective function definition.

CUSTOM_OBJFUNC 

Custom objective function definition.

REFERENCE_GEOMETRY 

Norm of displacements with respect to target geometry.

REFERENCE_NODE 

Objective function defined as the difference of a particular node respect to a reference position.

VOLUME_FRACTION 

Volume average physical density, for material-based topology optimization applications.

TOPOL_DISCRETENESS 

Measure of the discreteness of the current topology.

TOPOL_COMPLIANCE 

Measure of the discreteness of the current topology.

STRESS_PENALTY 

Penalty function of VM stresses above a maximum value.

ENTROPY_GENERATION 

Entropy generation turbomachinery objective function.

TOTAL_PRESSURE_LOSS 

Total pressure loss turbomachinery objective function.

KINETIC_ENERGY_LOSS 

\breif Kinetic energy loss coefficient turbomachinery objective function.

◆ ENUM_PARAM

enum ENUM_PARAM

Types of design parameterizations.

Enumerator
NO_DEFORMATION 

No deformation.

TRANSLATION 

Surface movement as design variable.

ROTATION 

Surface rotation as design variable.

SCALE 

Surface rotation as design variable.

FFD_SETTING 

No surface deformation.

FFD_CONTROL_POINT 

Free form deformation for 3D design (change a control point).

FFD_NACELLE 

Free form deformation for 3D design (change a control point).

FFD_GULL 

Free form deformation for 3D design (change a control point).

FFD_CAMBER 

Free form deformation for 3D design (camber change).

FFD_TWIST 

Free form deformation for 3D design (change the twist angle of a section).

FFD_THICKNESS 

Free form deformation for 3D design (thickness change).

FFD_ROTATION 

Free form deformation for 3D design (rotation around a line).

FFD_CONTROL_POINT_2D 

Free form deformation for 2D design (change a control point).

FFD_CAMBER_2D 

Free form deformation for 3D design (camber change).

FFD_THICKNESS_2D 

Free form deformation for 3D design (thickness change).

FFD_CONTROL_SURFACE 

Free form deformation for 3D design (control surface).

FFD_ANGLE_OF_ATTACK 

Angle of attack for FFD problem.

HICKS_HENNE 

Hicks-Henne bump function for airfoil deformation.

PARABOLIC 

Parabolic airfoil definition as design variables.

NACA_4DIGITS 

The four digits NACA airfoil family as design variables.

AIRFOIL 

Airfoil definition as design variables.

CST 

CST method with Kulfan parameters for airfoil deformation.

SURFACE_BUMP 

Surfacebump function for flat surfaces deformation.

SURFACE_FILE 

Nodal coordinates for surface set using a file (external parameterization).

HICKS_HENNE_CAMBER 

Hicks-Henne bump function for camber line deformation.

DV_EFIELD 

Electric field in deformable membranes.

DV_YOUNG 
DV_POISSON 
DV_RHO 
DV_RHO_DL 
TRANSLATE_GRID 

Translate the volume grid.

ROTATE_GRID 

Rotate the volume grid.

SCALE_GRID 

Scale the volume grid.

ANGLE_OF_ATTACK 

Angle of attack for airfoils.

◆ ENUM_PROJECTION_FUNCTION

enum class ENUM_PROJECTION_FUNCTION
strong

Types of projection function, initially intended for structural topology optimization applications.

Enumerator
NONE 

No projection.

HEAVISIDE_UP 

Project values towards 1.

HEAVISIDE_DOWN 

Project values towards 0.

◆ ENUM_REGIME

enum class ENUM_REGIME
strong

different regime modes

Enumerator
COMPRESSIBLE 

Definition of compressible solver.

INCOMPRESSIBLE 

Definition of incompressible solver.

NO_FLOW 

◆ ENUM_ROELOWDISS

Types of Roe Low Dissipation Schemes.

Enumerator
NO_ROELOWDISS 

No Roe Low Dissipation model.

FD 

Numerical Blending based on DDES's F_d function.

NTS 

Numerical Blending of Travin and Shur.

NTS_DUCROS 

Numerical Blending of Travin and Shur + Ducros' Shock Sensor.

FD_DUCROS 

Numerical Blending based on DDES's F_d function + Ducros' Shock Sensor.

◆ ENUM_SENS_SMOOTHING

Types of sensitivity smoothing.

Enumerator
NO_SMOOTH 

No smoothing.

SOBOLEV 

Sobolev gradient smoothing.

BIGRID 

Bi-grid technique smoothing.

◆ ENUM_SENSITIVITY

Type of volume sensitivity file formats (inout to SU2_DOT)

Enumerator
SU2_NATIVE 

SU2 native binary format for the volume sensitivity input.

UNORDERED_ASCII 

Unordered ASCII list (x,y,z,dJ/dx,dJ/dy/dJ/dz) format for the volume sensitivity input.

◆ ENUM_SOBOLEV_MODUS

enum class ENUM_SOBOLEV_MODUS
strong

mode of operation for the sobolev smoothing solver.

Enumerator
NONE 

Default option if none is choosen.

PARAM_LEVEL_COMPLETE 

Operate on parameter level.

MESH_LEVEL 

Operate on mesh level.

ONLY_GRAD 

Flag to only compute the original gradient.

◆ ENUM_SPACE

enum ENUM_SPACE

Types of spatial discretizations.

Enumerator
NO_CONVECTIVE 

No convective scheme is used.

SPACE_CENTERED 

Space centered convective numerical method.

SPACE_UPWIND 

Upwind convective numerical method.

FINITE_ELEMENT 

Finite element convective numerical method.

◆ ENUM_STREAMWISE_PERIODIC

enum class ENUM_STREAMWISE_PERIODIC
strong

Types of streamwise periodicity.

Enumerator
NONE 

No streamwise periodic flow.

PRESSURE_DROP 

Prescribed pressure drop.

MASSFLOW 

Prescribed massflow.

◆ ENUM_SURFACEMOVEMENT

Enumerator
DEFORMING 

Simulation with deformation.

MOVING_WALL 

Simulation with moving wall.

AEROELASTIC 

Simulation with aeroelastic motion.

AEROELASTIC_RIGID_MOTION 

Simulation with rotation and aeroelastic motion.

EXTERNAL 

Simulation with external motion.

EXTERNAL_ROTATION 

Simulation with external rotation motion.

◆ ENUM_TIME_INT

Type of time integration schemes.

Enumerator
RUNGE_KUTTA_EXPLICIT 

Explicit Runge-Kutta time integration definition.

EULER_EXPLICIT 

Explicit Euler time integration definition.

EULER_IMPLICIT 

Implicit Euler time integration definition.

CLASSICAL_RK4_EXPLICIT 

Classical RK4 time integration definition.

ADER_DG 

ADER-DG time integration definition.

◆ ENUM_TRANSFER

types of (coupling) transfers between distinct physical zones

Enumerator
ZONES_ARE_EQUAL 

Zones are equal - no transfer.

NO_COMMON_INTERFACE 

No common interface between the zones (geometrical).

NO_TRANSFER 

Zones may share a boundary, but still no coupling desired.

FLOW_TRACTION 

Flow traction coupling (between fluids and solids).

BOUNDARY_DISPLACEMENTS 

Boundary displacements (between fluids and solids)

SLIDING_INTERFACE 

Sliding interface (between fluids).

CONSERVATIVE_VARIABLES 

General coupling that simply transfers the conservative variables (between same solvers).

MIXING_PLANE 

Mixing plane between fluids.

CONJUGATE_HEAT_FS 

Conjugate heat transfer (between compressible fluids and solids).

CONJUGATE_HEAT_WEAKLY_FS 

Conjugate heat transfer (between incompressible fluids and solids).

CONJUGATE_HEAT_SF 

Conjugate heat transfer (between solids and compressible fluids).

CONJUGATE_HEAT_WEAKLY_SF 

Conjugate heat transfer (between solids and incompressible fluids).

CONJUGATE_HEAT_SS 

Conjugate heat transfer (between two solids).

◆ FEM_SHOCK_CAPTURING_DG

enum class FEM_SHOCK_CAPTURING_DG
strong

Types of shock capturing method in Discontinuous Galerkin numerical method.

Enumerator
NONE 

Shock capturing is not used.

PERSSON 

Per-Olof Persson's sub-cell shock capturing method.

◆ FLAMELET_ENTHALPY_BC

enum class FLAMELET_ENTHALPY_BC
strong

Selects the source of wall/inlet enthalpy boundary conditions for the flamelet solver. SPECIES_MARKERS (default): inlet H is taken directly from MARKER_INLET_SPECIES; wall enthalpy BC is obtained from MARKER_WALL_SPECIES. FLOW_MARKERS: inlet H is derived from the MARKER_INLET temperature via a Newton iteration on the LUT (reverse lookup using Z,T) from MARKER_ISOTHERMAL or MARKER_HEATFLUX.

Enumerator
FLOW_MARKERS 

Derive inlet H from MARKER_INLET T (LUT Newton); walls from MARKER_ISOTHERMAL/MARKER_HEATFLUX.

SPECIES_MARKERS 

Take inlet H directly from MARKER_INLET_SPECIES; walls from MARKER_WALL_SPECIES (default).

◆ FLAMELET_INIT_TYPE

enum class FLAMELET_INIT_TYPE
strong

Flame initialization options for the flamelet solver.

Enumerator
FLAME_FRONT 

Straight flame front.

SPARK 

Species reaction rate in a set location.

NONE 

No ignition, cold flow only.

◆ FLAMELET_LOOKUP_OPS

Look-up operations for the flamelet scalar solver.

Enumerator
THERMO 

Thermochemical properties (temperature, density, diffusivity, etc.).

PREFDIF 

Preferential diffusion scalars.

SOURCES 

Scalar source terms (controlling variables, passive species).

LOOKUP 

Passive look-up variables specified in config.

◆ FLAMELET_PREF_DIFF_SCALARS

The preferential diffusion scalar indices for the preferential diffusion model.

Enumerator
I_BETA_PROGVAR 

Preferential diffusion scalar for the progress variable.

I_BETA_ENTH_THERMAL 

Preferential diffusion scalar for temperature.

I_BETA_ENTH 

Preferential diffusion scalar for total enthalpy.

I_BETA_MIXFRAC 

Preferential diffusion scalar for mixture fraction.

N_BETA_TERMS 

Total number of preferential diffusion scalars.

◆ FLAMELET_SCALAR_SOURCES

the source terms for the flamelet method. At the moment only progress variable

Enumerator
I_SRC_TOT_PROGVAR 

◆ FLAMELET_SCALAR_VARIABLES

Progress variable and enthalpy are the first and second entries in the lookup table.

Note
The order matters.
Enumerator
I_PROGVAR 
I_ENTH 
I_MIXFRAC 

◆ FREESTREAM_OPTION

enum class FREESTREAM_OPTION
strong

Types of freestream specification.

Enumerator
TEMPERATURE_FS 

Temperature initialization.

DENSITY_FS 

Density initalization.

◆ GEO_TYPE

enum GEO_TYPE

Types of geometric entities based on VTK nomenclature.

Enumerator
VERTEX 

VTK nomenclature for defining a vertex element.

LINE 

VTK nomenclature for defining a line element.

TRIANGLE 

VTK nomenclature for defining a triangle element.

QUADRILATERAL 

VTK nomenclature for defining a quadrilateral element.

TETRAHEDRON 

VTK nomenclature for defining a tetrahedron element.

HEXAHEDRON 

VTK nomenclature for defining a hexahedron element.

PRISM 

VTK nomenclature for defining a prism element.

PYRAMID 

VTK nomenclature for defining a pyramid element.

◆ GEOMETRY_ACTION

Types of action to take on a geometry structure.

Enumerator
ALLOCATE 

Allocate geometry structure.

UPDATE 

Update geometry structure (grid moving, adaptation, etc.).

◆ GEOMETRY_MODE

Types of action to perform when doing the geometry evaluation.

Enumerator
FUNCTION 

Geometrical analysis.

GRADIENT 

Geometrical analysis and gradient using finite differences.

◆ INC_DENSITYMODEL

enum class INC_DENSITYMODEL
strong

Types of density models.

Enumerator
CONSTANT 

Constant density.

BOUSSINESQ 

Boussinesq density model.

VARIABLE 

Variable density model.

FLAMELET 

Density according to flamelet manifold.

◆ INC_OUTLET_TYPE

enum class INC_OUTLET_TYPE
strong

Types outlet boundary treatments.

Enumerator
PRESSURE_OUTLET 

Gauge pressure outlet for incompressible flow.

MASS_FLOW_OUTLET 

Mass flow outlet for incompressible flow.

◆ INCOMP_SYSTEM

enum class INCOMP_SYSTEM
strong

Type of incompressible solver.

Enumerator
DENSITY_BASED 

Density-based.

PRESSURE_BASED 

Pressure-based.

◆ INIT_OPTION_INC

enum class INIT_OPTION_INC
strong

Types of initialization of the incompressible solver.

Enumerator
DENSITY_INIT 

Initialization with the initial density.

OPERATING_PRESSURE 

Initialization with the operating (thermodynamic) pressure.

◆ INLET_INTERP_TYPE

enum class INLET_INTERP_TYPE
strong

type of radial spanwise interpolation data type for the inlet face

Enumerator
VR_VTHETA 
ALPHA_PHI 

◆ INLET_SPANWISE_INTERP

enum class INLET_SPANWISE_INTERP
strong

type of radial spanwise interpolation function for the inlet face

Enumerator
NONE 
LINEAR_1D 
AKIMA_1D 
CUBIC_1D 

◆ INLET_TYPE

enum class INLET_TYPE
strong

Types inlet boundary treatments.

Enumerator
TOTAL_CONDITIONS 

User specifies total pressure, total temperature, and flow direction.

MASS_FLOW 

User specifies density and velocity (mass flow).

INPUT_FILE 

User specifies an input file.

VELOCITY_INLET 

Velocity inlet for an incompressible flow.

PRESSURE_INLET 

Total pressure inlet for an incompressible flow.

◆ INTERFACE_INTERPOLATOR

enum class INTERFACE_INTERPOLATOR
strong

Types of interpolators.

Enumerator
NEAREST_NEIGHBOR 

Nearest Neigbhor interpolation.

ISOPARAMETRIC 

Isoparametric interpolation, use CONSERVATIVE_INTERPOLATION=YES for conservative interpolation (S.A. Brown 1997).

WEIGHTED_AVERAGE 

Sliding Mesh Approach E. Rinaldi 2015.

RADIAL_BASIS_FUNCTION 

Radial basis function interpolation.

◆ JUMP_DEFINITION

Type of jump definition.

Enumerator
DIFFERENCE 

Jump given by a difference in values.

RATIO 

Jump given by a ratio.

◆ LIMITER

enum class LIMITER
strong

Types of slope limiters.

Enumerator
NONE 

No limiter.

VENKATAKRISHNAN 

Slope limiter using Venkatakrisnan method (stencil formulation).

NISHIKAWA_R3 

Slope limiter using Nishikawa's R3 method (stencil formulation).

NISHIKAWA_R4 

Slope limiter using Nishikawa's R4 method (stencil formulation).

NISHIKAWA_R5 

Slope limiter using Nishikawa's R5 method (stencil formulation).

VENKATAKRISHNAN_WANG 

Slope limiter using Venkatakrisnan method, eps based on solution (stencil formulation).

BARTH_JESPERSEN 

Slope limiter using Barth-Jespersen method (stencil formulation).

VAN_ALBADA_EDGE 

Slope limiter using Van Albada method (edge formulation).

SHARP_EDGES 

Slope limiter using sharp edges.

WALL_DISTANCE 

Slope limiter using wall distance.

◆ LINEAR_SOLVER_INNER

enum class LINEAR_SOLVER_INNER
strong

Inner solver for nested linear solver, only compatible with "flexible" linear solvers.

Enumerator
NONE 

Do not use a nested linear solver.

BCGSTAB 

Use BCGSTAB as the preconditioning linear solver.

SMOOTHER 

Iterative smoother.

◆ LINEAR_SOLVER_MODE

enum class LINEAR_SOLVER_MODE
strong

Type of operation for the linear system solver, changes the source of solver options.

Enumerator
STANDARD 

Operate in standard mode.

MESH_DEFORM 

Operate in mesh deformation mode.

GRADIENT_MODE 

Operate in gradient smoothing mode.

POISSON 

Operate in poisson solver mode.

◆ LM_OPTIONS

enum class LM_OPTIONS
strong

LM Options.

Enumerator
NONE 

No option / default.

LM2015 

Cross-flow corrections.

MALAN 

Kind of transition correlation model (Malan).

SULUKSNA 

Kind of transition correlation model (Suluksna).

KRAUSE 

Kind of transition correlation model (Krause).

KRAUSE_HYPER 

Kind of transition correlation model (Krause hypersonic).

MEDIDA_BAEDER 

Kind of transition correlation model (Medida-Baeder).

MEDIDA 

Kind of transition correlation model (Medida).

MENTER_LANGTRY 

Kind of transition correlation model (Menter-Langtry).

DEFAULT 

Kind of transition correlation model (Menter-Langtry if SST, MALAN if SA).

◆ MAIN_SOLVER

enum class MAIN_SOLVER
strong

different solver types for the CFD component

Enumerator
NONE 

Definition of no solver.

EULER 

Definition of the Euler's solver.

NAVIER_STOKES 

Definition of the Navier-Stokes' solver.

RANS 

Definition of the Reynolds-averaged Navier-Stokes' (RANS) solver.

INC_EULER 

Definition of the incompressible Euler's solver.

INC_NAVIER_STOKES 

Definition of the incompressible Navier-Stokes' solver.

INC_RANS 

Definition of the incompressible Reynolds-averaged Navier-Stokes' (RANS) solver.

HEAT_EQUATION 

Definition of the finite volume heat solver.

FEM_ELASTICITY 

Definition of a FEM solver.

ADJ_EULER 

Definition of the continuous adjoint Euler's solver.

ADJ_NAVIER_STOKES 

Definition of the continuous adjoint Navier-Stokes' solver.

ADJ_RANS 

Definition of the continuous adjoint Reynolds-averaged Navier-Stokes' (RANS) solver.

TEMPLATE_SOLVER 

Definition of template solver.

DISC_ADJ_EULER 

Definition of the discrete adjoint Euler solver.

DISC_ADJ_RANS 

Definition of the discrete adjoint Reynolds-averaged Navier-Stokes' (RANS) solver.

DISC_ADJ_NAVIER_STOKES 

Definition of the discrete adjoint Navier-Stokes' solver.

DISC_ADJ_INC_EULER 

Definition of the discrete adjoint incompressible Euler solver.

DISC_ADJ_INC_RANS 

Definition of the discrete adjoint incompressible Reynolds-averaged Navier-Stokes' (RANS) solver.

DISC_ADJ_INC_NAVIER_STOKES 

Definition of the discrete adjoint incompressible Navier-Stokes'.

DISC_ADJ_HEAT 

Definition of the discrete adjoint heat solver.

DISC_ADJ_FEM_EULER 

Definition of the discrete adjoint FEM Euler solver.

DISC_ADJ_FEM_RANS 

Definition of the discrete adjoint FEM Reynolds-averaged Navier-Stokes' (RANS) solver.

DISC_ADJ_FEM_NS 

Definition of the discrete adjoint FEM Navier-Stokes' solver.

DISC_ADJ_FEM 

Definition of the discrete adjoint FEM solver.

FEM_EULER 

Definition of the finite element Euler's solver.

FEM_NAVIER_STOKES 

Definition of the finite element Navier-Stokes' solver.

FEM_RANS 

Definition of the finite element Reynolds-averaged Navier-Stokes' (RANS) solver.

FEM_LES 

Definition of the finite element Large Eddy Simulation Navier-Stokes' (LES) solver.

MULTIPHYSICS 
POISSON_EQUATION 

Definition of the Poisson equation solver.

NEMO_EULER 

Definition of the NEMO Euler solver.

NEMO_NAVIER_STOKES 

Definition of the NEMO NS solver.

◆ MG_CYCLE

enum class MG_CYCLE
strong

Type of multigrid cycle.

Enumerator
V 

V-cycle multigrid solver.

W 

W-cycle multigrid solver.

FULL 

Full multigrid (FMG) solver.

◆ MIXINGPLANE_INTERFACE_TYPE

Types of mixing process for averaging quantities at the boundaries.

Enumerator
MATCHING 

an algebraic average is computed at the boundary of interest.

NEAREST_SPAN 

an area average is computed at the boundary of interest.

LINEAR_INTERPOLATION 

an mixed-out average is computed at the boundary of interest.

◆ MIXINGVISCOSITYMODEL

enum class MIXINGVISCOSITYMODEL
strong

Types of Mixing viscosity model.

Enumerator
WILKE 

Wilke mixing viscosity model.

DAVIDSON 

Davidson mixing viscosity model.

◆ MPI_QUANTITIES

enum class MPI_QUANTITIES
strong

Vertex-based quantities exchanged in MPI point-to-point communications.

Enumerator
SOLUTION 

Conservative solution communication.

SOLUTION_OLD 

Conservative solution old communication.

SOLUTION_GRADIENT 

Conservative solution gradient communication.

SOLUTION_GRAD_REC 

Conservative solution reconstruction gradient communication.

SOLUTION_LIMITER 

Conservative solution limiter communication.

SOLUTION_GEOMETRY 

Geometry solution communication.

PRIMITIVE_GRADIENT 

Primitive gradient communication.

PRIMITIVE_GRAD_REC 

Primitive reconstruction gradient communication.

PRIMITIVE_LIMITER 

Primitive limiter communication.

UNDIVIDED_LAPLACIAN 

Undivided Laplacian communication.

MAX_EIGENVALUE 

Maximum eigenvalue communication.

SENSOR 

Dissipation sensor communication.

AUXVAR_GRADIENT 

Auxiliary variable gradient communication.

COORDINATES 

Vertex coordinates communication.

COORDINATES_OLD 

Old vertex coordinates communication.

MAX_LENGTH 

Maximum length communication.

GRID_VELOCITY 

Grid velocity communication.

SOLUTION_EDDY 

Turbulent solution plus eddy viscosity communication.

STOCH_SOURCE_LANG 

Stochastic source term for Langevin equations communication.

DES_LENGTHSCALE 

DES length scale communication.

SOLUTION_MATRIX 

Matrix solution communication.

SOLUTION_MATRIXTRANS 

Matrix transposed solution communication.

NEIGHBORS 

Neighbor point count communication (for JST).

SOLUTION_FEA 

FEA solution communication.

MESH_DISPLACEMENTS 

Mesh displacements at the interface.

SOLUTION_TIME_N 

Solution at time n.

SOLUTION_TIME_N1 

Solution at time n-1.

MOM_COEFF 

Momentum coefficient for the Rhie-Chow scheme.

MOM_CORRECTION 

Momentum correction for the pressure-based poisson solver (used when computing HbyA).

HBYA_CORRECTION 

HbyA correction for the pressure-based poisson solver.

◆ MUSCL_RAMP_TYPE

enum class MUSCL_RAMP_TYPE
strong
Enumerator
ITERATION 

flag for linear iteration-based ramp

SMOOTH_FUNCTION 

flag for smooth cosine ramp

◆ OUTPUT_TYPE

enum class OUTPUT_TYPE
strong

Type of solution output file formats.

Enumerator
TECPLOT_ASCII 

Tecplot format for the solution output.

TECPLOT_BINARY 

Tecplot binary format for the solution output.

SURFACE_TECPLOT_ASCII 

Tecplot format for the solution output.

SURFACE_TECPLOT_BINARY 

Tecplot binary format for the solution output.

CSV 

Comma-separated values format for the solution output.

SURFACE_CSV 

Comma-separated values format for the solution output.

PARAVIEW_ASCII 

Paraview ASCII format for the solution output.

PARAVIEW_LEGACY_BINARY 

Paraview binary format for the solution output.

SURFACE_PARAVIEW_ASCII 

Paraview ASCII format for the solution output.

SURFACE_PARAVIEW_LEGACY_BINARY 

Paraview binary format for the solution output.

MESH 

SU2 ASCII mesh format.

MESH_BINARY 

SU2 binary mesh format.

RESTART_BINARY 

SU2 binary restart format.

RESTART_ASCII 

SU2 ASCII restart format.

PARAVIEW_XML 

Paraview XML with binary data format.

SURFACE_PARAVIEW_XML 

Surface Paraview XML with binary data format.

PARAVIEW_MULTIBLOCK 

Paraview XML Multiblock.

CGNS 

CGNS format.

SURFACE_CGNS 

CGNS format.

STL_ASCII 

STL ASCII format for surface solution output.

STL_BINARY 

STL binary format for surface solution output. Not implemented yet.

◆ P1_INIT

enum class P1_INIT
strong

Kinds of P1 initialization.

Enumerator
ZERO 

Initialize the P1 model from zero values.

TEMPERATURE 

Initialize the P1 model from blackbody energy computed from the initial temperature.

◆ PBITER

enum class PBITER
strong

Type of iteration.

Enumerator
SIMPLE 

SIMPLE algorithm.

SIMPLEC 

SIMPLEC algorithm.

◆ PERIODIC_QUANTITIES

Vertex-based quantities exchanged during periodic marker communications.

Enumerator
PERIODIC_NONE 

No periodic communication required.

PERIODIC_VOLUME 

Volume communication for summing total CV (periodic only).

PERIODIC_NEIGHBORS 

Communication of the number of neighbors for centered schemes (periodic only).

PERIODIC_RESIDUAL 

Residual and Jacobian communication (periodic only).

PERIODIC_LAPLACIAN 

Undivided Laplacian communication for JST (periodic only).

PERIODIC_MAX_EIG 

Maximum eigenvalue communication (periodic only).

PERIODIC_SENSOR 

Dissipation sensor communication (periodic only).

PERIODIC_SOL_GG 

Solution gradient communication for Green-Gauss (periodic only).

PERIODIC_PRIM_GG 

Primitive gradient communication for Green-Gauss (periodic only).

PERIODIC_SOL_LS 

Solution gradient communication for weighted Least Squares (periodic only).

PERIODIC_PRIM_LS 

Primitive gradient communication for weighted Least Squares (periodic only).

PERIODIC_SOL_ULS 

Solution gradient communication for unwieghted Least Squares (periodic only).

PERIODIC_PRIM_ULS 

Primitive gradient communication for unweighted Least Squares (periodic only).

PERIODIC_SOL_GG_R 

Same but reconstruction.

PERIODIC_PRIM_GG_R 

Same but reconstruction.

PERIODIC_SOL_LS_R 

Same but reconstruction.

PERIODIC_PRIM_LS_R 

Same but reconstruction.

PERIODIC_SOL_ULS_R 

Same but reconstruction.

PERIODIC_PRIM_ULS_R 

Same but reconstruction.

PERIODIC_LIM_SOL_1 

Solution limiter communication phase 1 of 2 (periodic only).

PERIODIC_LIM_SOL_2 

Solution limiter communication phase 2 of 2 (periodic only).

PERIODIC_LIM_PRIM_1 

Primitive limiter communication phase 1 of 2 (periodic only).

PERIODIC_LIM_PRIM_2 

Primitive limiter communication phase 2 of 2 (periodic only).

PERIODIC_IMPLICIT 

Implicit update communication to ensure consistency across periodic boundaries.

◆ POD_KIND

enum class POD_KIND
strong

Type of POD basis generation (for use with libROM)

Enumerator
STATIC 

Use static SVD for POD basis generation.

INCREMENTAL 

Use incremental SVD for POD basis generation.

◆ RADIAL_BASIS

enum class RADIAL_BASIS
strong

Types of radial basis functions.

Enumerator
WENDLAND_C2 

Wendland C2 radial basis function.

INV_MULTI_QUADRIC 

Inversed multi quartic biharmonic spline.

GAUSSIAN 

Gaussian basis function.

THIN_PLATE_SPLINE 

Thin plate spline.

MULTI_QUADRIC 

Multi quartic biharmonic spline.

◆ RADIATION_MODEL

enum class RADIATION_MODEL
strong

Kinds of radiation models.

Enumerator
NONE 

No radiation model.

P1 

P1 Radiation model.

◆ RAMP_COEFF

enum RAMP_COEFF

Coefficients of the ramp specified in the config, ordered by index in the config.

Enumerator
INITIAL_VALUE 

intial value of the ramp

UPDATE_FREQ 
FINAL_ITER 

◆ RAMP_TYPE

enum class RAMP_TYPE
strong
Enumerator
GRID 

flag for rotational/translational ramps

BOUNDARY 

flag for pressure/mass flow ramps

MUSCL 

flag for MUSCL ramps

◆ RECORDING

enum class RECORDING
strong
Enumerator
CLEAR_INDICES 
SOLUTION_VARIABLES 
MESH_COORDS 
MESH_DEFORM 
SOLUTION_AND_MESH 

◆ RIEMANN_TYPE

Types Riemann boundary treatments.

Enumerator
TOTAL_CONDITIONS_PT 

User specifies total pressure, total temperature, and flow direction.

DENSITY_VELOCITY 

User specifies density and velocity, and flow direction.

STATIC_PRESSURE 

User specifies static pressure.

TOTAL_SUPERSONIC_INFLOW 

User specifies total pressure, total temperature and Velocity components.

STATIC_SUPERSONIC_INFLOW_PT 

User specifies static pressure, static temperature, and Mach components.

STATIC_SUPERSONIC_INFLOW_PD 

User specifies static pressure, static temperature, and Mach components.

MIXING_IN 

User does not specify anything; information is retrieved from the other domain.

MIXING_OUT 

User does not specify anything; information is retrieved from the other domain.

SUPERSONIC_OUTFLOW 
RADIAL_EQUILIBRIUM 
TOTAL_CONDITIONS_PT_1D 
STATIC_PRESSURE_1D 
MIXING_IN_1D 
MIXING_OUT_1D 
MASS_FLOW_OUTLET 

◆ ROUGHSST_MODEL

enum class ROUGHSST_MODEL
strong

SST rough-wall boundary conditions Options.

Enumerator
WILCOX1998 

Wilcox 1998 boundary conditions for rough walls.

WILCOX2006 

Wilcox 2006 boundary conditions for rough walls / default version if roughness is applied.

LIMITER_KNOPP 

Knopp eddy viscosity limiter.

LIMITER_AUPOIX 

Aupoix eddy viscosity limiter.

◆ RUNTIME_TYPE

different types of systems

Enumerator
RUNTIME_FLOW_SYS 

One-physics case, the code is solving the flow equations(Euler and Navier-Stokes).

RUNTIME_TURB_SYS 

One-physics case, the code is solving the turbulence model.

RUNTIME_ADJFLOW_SYS 

One-physics case, the code is solving the adjoint equations is being solved (Euler and Navier-Stokes).

RUNTIME_ADJTURB_SYS 

One-physics case, the code is solving the adjoint turbulence model.

RUNTIME_MULTIGRID_SYS 

Full Approximation Storage Multigrid system of equations.

RUNTIME_FEA_SYS 

One-physics case, the code is solving the FEA equation.

RUNTIME_ADJFEA_SYS 

One-physics case, the code is solving the adjoint FEA equation.

RUNTIME_HEAT_SYS 

One-physics case, the code is solving the heat equation.

RUNTIME_ADJHEAT_SYS 

One-physics case, the code is solving the adjoint heat equation.

RUNTIME_TRANS_SYS 

One-physics case, the code is solving the transition model.

RUNTIME_RADIATION_SYS 

One-physics case, the code is solving the radiation model.

RUNTIME_ADJRAD_SYS 

One-physics case, the code is solving the adjoint radiation model.

RUNTIME_SPECIES_SYS 

One-physics case, the code is solving the species model.

RUNTIME_ADJSPECIES_SYS 

One-physics case, the code is solving the adjoint species model.

RUNTIME_POISSON_SYS 

One-physics case, the code is solving the poisson equation.

◆ SA_OPTIONS

enum class SA_OPTIONS
strong

SA Options.

Enumerator
NONE 

No option / default.

NEG 

Negative SA.

EDW 

Edwards version.

FT2 

Use FT2 term.

QCR2000 

Quadratic constitutive relation.

COMP 

Compressibility correction.

ROT 

Rotation correction.

BC 

Bas-Cakmakcioclu transition.

EXP 

Allow experimental combinations of options (according to TMR).

◆ SOLVER_TYPE

enum SOLVER_TYPE : const int
Enumerator
FLOW_SOL 

Position of the mean flow solution in the solver container array.

ADJFLOW_SOL 

Position of the continuous adjoint flow solution in the solver container array.

TURB_SOL 

Position of the turbulence model solution in the solver container array.

ADJTURB_SOL 

Position of the continuous adjoint turbulence solution in the solver container array.

TRANS_SOL 

Position of the transition model solution in the solver container array.

HEAT_SOL 

Position of the heat equation in the solution solver array.

ADJHEAT_SOL 

Position of the adjoint heat equation in the solution solver array.

RAD_SOL 

Position of the radiation equation in the solution solver array.

ADJRAD_SOL 

Position of the continuous adjoint turbulence solution in the solver container array.

MESH_SOL 

Position of the mesh solver.

ADJMESH_SOL 

Position of the adjoint of the mesh solver.

SPECIES_SOL 

Position of the species solver.

ADJSPECIES_SOL 

Position of the adjoint of the species solver.

FEA_SOL 

Position of the Finite Element flow solution in the solver container array.

ADJFEA_SOL 

Position of the continuous adjoint Finite Element flow solution in the solver container array.

POISSON_SOL 

Position of the poisson solution in the solver container array.

TEMPLATE_SOL 

Position of the template solution.

◆ SPANWISE_TYPE

this option allow to compute the span-wise section in different ways.

Enumerator
AUTOMATIC 

number of span-wise section are computed automatically

EQUISPACED 

number of span-wise section are specified from the user

◆ SPECIES_MODEL

enum class SPECIES_MODEL
strong

types of species transport models

Enumerator
NONE 

No scalar transport model.

SPECIES_TRANSPORT 

species transport model.

FLAMELET 

flamelet model.

◆ SST_OPTIONS

enum class SST_OPTIONS
strong

SST Options.

Enumerator
NONE 

No SST Turb model.

V1994 

1994 Menter k-w SST model.

V2003 

2003 Menter k-w SST model.

V1994m 

1994m Menter k-w SST model.

V2003m 

2003m Menter k-w SST model.

SUST 

Menter k-w SST model with sustaining terms.

V 

Menter k-w SST model with vorticity production terms.

KL 

Menter k-w SST model with Kato-Launder production terms.

UQ 

Menter k-w SST model with uncertainty quantification modifications.

COMP_Wilcox 

Menter k-w SST model with Compressibility correction of Wilcox.

COMP_Sarkar 

Menter k-w SST model with Compressibility correction of Sarkar.

DLL 

Menter k-w SST model with dimensionless lower limit clipping of turbulence variables.

◆ STRUCT_2DFORM

enum class STRUCT_2DFORM
strong

2D Formulation for structural problems

Enumerator
PLANE_STRESS 

Definition of plane stress solver.

PLANE_STRAIN 

Definition of plane strain solver.

◆ STRUCT_COMPRESS

enum class STRUCT_COMPRESS
strong

Material compressibility.

Enumerator
COMPRESSIBLE 

Definition of compressible material.

NEARLY_INCOMP 

Definition of nearly incompressible material.

◆ STRUCT_DEFORMATION

enum class STRUCT_DEFORMATION
strong

Material geometric conditions.

Enumerator
SMALL 

Definition of linear elastic material.

LARGE 

Definition of Neo-Hookean material.

◆ STRUCT_MODEL

enum class STRUCT_MODEL
strong

Material model.

Enumerator
LINEAR_ELASTIC 

Definition of linear elastic material.

NEO_HOOKEAN 

Definition of Neo-Hookean material.

KNOWLES 

Definition of Knowles stored-energy potential.

IDEAL_DE 

Definition of ideal Dielectric Elastomer.

◆ STRUCT_SPACE_ITE

enum class STRUCT_SPACE_ITE
strong

Type of time integration schemes.

Enumerator
NEWTON 

Full Newton-Rapshon method.

MOD_NEWTON 

Modified Newton-Raphson method.

◆ STRUCT_TIME_INT

enum class STRUCT_TIME_INT
strong

Type of time integration schemes.

Enumerator
NEWMARK_IMPLICIT 

Implicit Newmark integration definition.

GENERALIZED_ALPHA 

Support for implementing another implicit method.

◆ SU2_COMPONENT

enum class SU2_COMPONENT
strong

Different software components of SU2.

Enumerator
SU2_CFD 

Running the SU2_CFD software.

SU2_DEF 

Running the SU2_DEF software.

SU2_DOT 

Running the SU2_DOT software.

SU2_GEO 

Running the SU2_GEO software.

SU2_SOL 

Running the SU2_SOL software.

◆ TAB_OUTPUT

enum class TAB_OUTPUT
strong

Type of solution output file formats.

Enumerator
TAB_CSV 

Comma-separated values format for the solution output.

TAB_TECPLOT 

Tecplot format for the solution output.

◆ TIME_MARCHING

enum class TIME_MARCHING
strong

Types of schemes for unsteady computations.

Enumerator
STEADY 

A steady computation.

TIME_STEPPING 

Use a time stepping strategy for unsteady computations.

DT_STEPPING_1ST 

Use a dual time stepping strategy for unsteady computations (1st order).

DT_STEPPING_2ND 

Use a dual time stepping strategy for unsteady computations (2nd order).

ROTATIONAL_FRAME 

Use a rotational source term.

HARMONIC_BALANCE 

Use a harmonic balance source term.

◆ TRANSCOEFFMODEL

enum class TRANSCOEFFMODEL
strong

types of coefficient transport model

Enumerator
SUTHERLAND 
WILKE 
GUPTAYOS 
CHAPMANN_ENSKOG 

◆ TURB_FAMILY

enum class TURB_FAMILY
strong

Families of turbulence models.

Enumerator
NONE 

No turbulence model.

SA 

Spalart-Allmaras variants.

KW 

k-w models.

◆ TURB_MODEL

enum class TURB_MODEL
strong

Types of turbulent models.

Enumerator
NONE 

No turbulence model.

SA 

Kind of Turbulent model (Spalart-Allmaras).

SST 

Kind of Turbulence model (Menter SST).

◆ TURB_SGS_MODEL

enum class TURB_SGS_MODEL
strong

Types of subgrid scale models.

Enumerator
NONE 

No subgrid scale model.

IMPLICIT_LES 

Implicit LES, i.e. no explicit SGS model.

SMAGORINSKY 

Smagorinsky SGS model.

WALE 

Wall-Adapting Local Eddy-viscosity SGS model.

VREMAN 

Vreman SGS model.

◆ TURB_TRANS_CORRELATION

enum class TURB_TRANS_CORRELATION
strong

Types of transition correlations.

Enumerator
MALAN 

Kind of transition correlation model (Malan).

SULUKSNA 

Kind of transition correlation model (Suluksna).

KRAUSE 

Kind of transition correlation model (Krause).

KRAUSE_HYPER 

Kind of transition correlation model (Krause hypersonic).

MEDIDA_BAEDER 

Kind of transition correlation model (Medida-Baeder).

MEDIDA 

Kind of transition correlation model (Medida).

MENTER_LANGTRY 

Kind of transition correlation model (Menter-Langtry).

DEFAULT 

Kind of transition correlation model (Menter-Langtry if SST, MALAN if SA).

◆ TURB_TRANS_MODEL

enum class TURB_TRANS_MODEL
strong

Types of transition models.

Enumerator
NONE 

No transition model.

LM 

Kind of transition model (Langtry-Menter (LM) for SST and Spalart-Allmaras).

◆ TURBO_INTERFACE_KIND

enum class TURBO_INTERFACE_KIND
strong

Types of Turbomachinery interfaces.

Enumerator
MIXING_PLANE 
FROZEN_ROTOR 

◆ TURBO_MARKER_TYPE

Types of Turbomachinery performance flag.

Enumerator
INFLOW 

flag for inflow marker for compute turboperformance.

OUTFLOW 

flag for outflow marker for compute turboperformance.

◆ TURBO_PERF_KIND

enum class TURBO_PERF_KIND
strong

Types of Turbomachinery performance Type.

Enumerator
TURBINE 

Turbine Performance.

COMPRESSOR 

Compressor Performance.

PROPELLOR 

Propellor Performance.

◆ TURBOMACHINERY_TYPE

enum class TURBOMACHINERY_TYPE
strong

Types of mixing process for averaging quantities at the boundaries.

Enumerator
AXIAL 

axial turbomachinery.

CENTRIFUGAL 

centrifugal turbomachinery.

CENTRIPETAL 

centripetal turbomachinery.

CENTRIPETAL_AXIAL 

mixed flow turbine.

AXIAL_CENTRIFUGAL 

mixed flow turbine.

◆ UPWIND

enum class UPWIND
strong

Types of upwind spatial discretizations.

Enumerator
NONE 

No upwind scheme is used.

ROE 

Roe's upwind numerical method.

SCALAR_UPWIND 

Scalar upwind numerical method.

AUSM 

AUSM numerical method.

HLLC 

HLLC numerical method.

SW 

Steger-Warming method.

MSW 

Modified Steger-Warming method.

TURKEL 

Roe-Turkel's upwind numerical method.

SLAU 

Simple Low-Dissipation AUSM numerical method.

CONVECTIVE_TEMPLATE 

Template for new numerical method .

L2ROE 

L2ROE numerical method .

LMROE 

Rieper's Low Mach ROE numerical method .

SLAU2 

Simple Low-Dissipation AUSM 2 numerical method.

FDS 

Flux difference splitting upwind method (incompressible flows).

LAX_FRIEDRICH 

Lax-Friedrich numerical method.

AUSMPLUSUP 

AUSM+ -up numerical method (All Speed)

AUSMPLUSUP2 

AUSM+ -up2 numerical method (All Speed)

AUSMPLUSM 

\breif AUSM+M numerical method. (NEMO Only)

BOUNDED_SCALAR 

Scalar advection numerical method.

UDS 

Upwind Difference Scheme used for pressure based solver.

◆ VERIFICATION_SOLUTION

enum class VERIFICATION_SOLUTION
strong

the different validation solution

Enumerator
NONE 

No verification solution, standard solver mode.

INVISCID_VORTEX 

Inviscid vortex. Exact solution of the unsteady Euler equations.

RINGLEB 

Ringleb flow. Exact solution of the steady Euler equations.

NS_UNIT_QUAD 

Exact solution of the laminar Navier Stokes equations without heat conduction.

TAYLOR_GREEN_VORTEX 

Taylor Green Vortex.

INC_TAYLOR_GREEN_VORTEX 

Incompressible Taylor Green Vortex (2D).

MMS_NS_UNIT_QUAD 

Manufactured solution of the laminar Navier Stokes equations on a unit quad.

MMS_NS_UNIT_QUAD_WALL_BC 

Manufactured solution of the laminar Navier Stokes equations on a unit quad with wall BC's.

MMS_NS_TWO_HALF_CIRCLES 

Manufactured solution of the laminar Navier Stokes equations between two half circles.

MMS_NS_TWO_HALF_SPHERES 

Manufactured solution of the laminar Navier Stokes equations between two half spheres.

MMS_INC_EULER 

Manufactured solution of the incompressible Euler equations.

MMS_INC_NS 

Manufactured solution of the laminar incompressible Navier Stokes equations.

USER_DEFINED_SOLUTION 

User defined solution.

◆ VISCOSITYMODEL

enum class VISCOSITYMODEL
strong

Types of viscosity model.

Enumerator
CONSTANT 

Constant viscosity.

SUTHERLAND 

Sutherlands Law viscosity.

POLYNOMIAL 

Polynomial viscosity.

FLAMELET 

LUT method for flamelets.

COOLPROP 

CoolProp viscosity.

◆ VOLUME_OUTPUT_PRECISION

enum class VOLUME_OUTPUT_PRECISION
strong

Floating-point type of the fields of the volume and surface files (CGNS and Paraview XML).

Enumerator
SINGLE 

Single precision (float).

DOUBLE 

Double precision (double).

◆ WALL_FUNCTIONS

enum class WALL_FUNCTIONS
strong

Types of wall functions.

Enumerator
NONE 

No wall function treatment, integration to the wall. Default behavior.

STANDARD_FUNCTION 

Standard wall function.

ADAPTIVE_FUNCTION 

Adaptive wall function. Formulation depends on y+.

SCALABLE_FUNCTION 

Scalable wall function.

EQUILIBRIUM_MODEL 

Equilibrium wall model for LES.

NONEQUILIBRIUM_MODEL 

Non-equilibrium wall model for LES.

LOGARITHMIC_MODEL 

Logarithmic law-of-the-wall model for LES.

◆ WALL_SPECIES_TYPE

enum class WALL_SPECIES_TYPE
strong

Types of wall species boundary conditions.

Enumerator
FLUX 

Neumann flux boundary condition for wall species.

VALUE 

Dirichlet value boundary condition for wall species.

◆ WALL_TYPE

enum class WALL_TYPE
strong

types of wall boundary condition - smooth or rough

Enumerator
SMOOTH 

Smooth wall.

ROUGH 

Rough wall.

◆ WINDOW_FUNCTION

enum class WINDOW_FUNCTION
strong

Types of window (weight) functions for cost functional.

Enumerator
SQUARE 

No weight function (order 1)

HANN 

Hann-type weight function (order 3)

HANN_SQUARE 

Hann-squared type weight function (order 5)

BUMP 

bump type weight function (exponential order of convergence)

Function Documentation

◆ GetSU2BinaryMetadataSize()

int GetSU2BinaryMetadataSize ( int  precisionField,
int  metadataField 
)
inline

Number of metadata scalars in the trailer of a native SU2 binary solution file.

Parameters
[in]precisionField- The SU2_RESTART_PRECISION_IDX entry of the file header.
[in]metadataField- The SU2_RESTART_METADATA_IDX entry of the file header.
Returns
Number of scalars of the trailer, preceded by one int (the iteration number), or 0 for the files that do not have one.
Note
Only files that still use the two ints as trailer counts have a trailer, and in those the precision field is the number of trailer ints, which was always 1 (see above).

◆ GetSU2BinaryScalarSize()

int GetSU2BinaryScalarSize ( int  precisionField)
inline

Size in bytes of the floating point data of a native SU2 binary solution file.

Parameters
[in]precisionField- The SU2_RESTART_PRECISION_IDX entry of the file header.
Returns
8 for double precision, 4 for single precision.
Note
Files written before the field had this meaning have a 0 or a 1 there (see above) and were always double precision.

◆ isParaview()

bool isParaview ( OUTPUT_TYPE  format)
inline

Return true if format is one of the Paraview options.

◆ isTecplot()

bool isTecplot ( OUTPUT_TYPE  format)
inline

Return true if format is one of the Tecplot options.

◆ nFacesOfElementType()

unsigned short nFacesOfElementType ( unsigned short  elementType)
inline

Get the number of faces of the element.

Parameters
[in]elementType- element type
Returns
number of faces

◆ nPointsOfElementType()

unsigned short nPointsOfElementType ( unsigned short  elementType)
inline

Get the number of points of the element.

Parameters
[in]elementType- element type
Returns
number of points

◆ ParseLMOptions()

LM_ParsedOptions ParseLMOptions ( const LM_OPTIONS *  LM_Options,
unsigned short  nLM_Options,
int  rank,
TURB_MODEL  Kind_Turb_Model 
)
inline

Function to parse LM options.

Parameters
[in]LM_Options- Selected LM option from config.
[in]nLM_Options- Number of options selected.
[in]rank- MPI rank.
Returns
Struct with SA options.

◆ ParseSAOptions()

SA_ParsedOptions ParseSAOptions ( const SA_OPTIONS *  SA_Options,
unsigned short  nSA_Options,
int  rank 
)
inline

Function to parse SA options.

Parameters
[in]SA_Options- Selected SA option from config.
[in]nSA_Options- Number of options selected.
[in]rank- MPI rank.
Returns
Struct with SA options.

◆ ParseSSTOptions()

SST_ParsedOptions ParseSSTOptions ( const SST_OPTIONS *  SST_Options,
unsigned short  nSST_Options,
int  rank 
)
inline

Function to parse SST options.

Parameters
[in]SST_Options- Selected SST option from config.
[in]nSST_Options- Number of options selected.
[in]rank- MPI rank.
Returns
Struct with SST options.

◆ SU2BinaryDataToPassive()

void SU2BinaryDataToPassive ( const void *  buffer,
int  scalarSize,
unsigned long  count,
passivedouble *  data 
)
inline

Convert floating point data read from a native SU2 binary solution file, which may have been written by a build of different precision, to the precision of this build.

Parameters
[in]buffer- Raw data as read from the file, of size count*scalarSize bytes.
[in]scalarSize- Size in bytes of the scalars in the file, see GetSU2BinaryScalarSize.
[in]count- Number of scalars.
[out]data- Converted data, must not overlap with buffer.

◆ TurbModelFamily()

TURB_FAMILY TurbModelFamily ( TURB_MODEL  model)
inline

Associate turb models with their family.

Variable Documentation

◆ AVOGAD_CONSTANT

constexpr passivedouble AVOGAD_CONSTANT = 6.0221415E26
constexpr

Avogadro's constant, number of particles in one kmole.

◆ BOLTZMANN_CONSTANT

constexpr passivedouble BOLTZMANN_CONSTANT = 1.3806503E-23
constexpr

Boltzmann's constant [J K^-1].

◆ CGNS_STRING_SIZE

const int CGNS_STRING_SIZE = 33

Length of strings used in the CGNS format.

◆ COLORING_EFF_THRESH

constexpr passivedouble COLORING_EFF_THRESH = 0.875
constexpr

Below this value fallback strategies are used instead.

◆ CONV_BOUND_TERM

const int CONV_BOUND_TERM = 4

Position of the convective boundary terms in the numerics container array.

◆ CONV_TERM

const int CONV_TERM = 0

Position of the convective terms in the numerics container array.

◆ DE_TERM

const int DE_TERM = 1

Position of the dielectric terms in the numerics container array.

◆ EL_HEXA

const int EL_HEXA = 1

Elements of eight nodes (3D).

◆ EL_LINE

const int EL_LINE = 6

Types of finite elements (in 1D or 2D or 3D)

Elements of two nodes, with second order gauss quadrature (1D).

◆ EL_PRISM

const int EL_PRISM = 3

Elements of six nodes (3D).

◆ EL_PYRAM

const int EL_PYRAM = 2

Elements of five nodes (3D).

◆ EL_PYRAM2

const int EL_PYRAM2 = 5

Elements of five nodes, with third order gauss quadrature (3D).

◆ EL_QUAD

const int EL_QUAD = 1

Elements of four nodes (2D).

◆ EL_TETRA

const int EL_TETRA = 0

Elements of four nodes (3D).

◆ EL_TETRA2

const int EL_TETRA2 = 4

Elements of four nodes, with second order gauss quadrature (3D).

◆ EL_TRIA

const int EL_TRIA = 0

Elements of three nodes (2D).

◆ EL_TRIA2

const int EL_TRIA2 = 2

Elements of three nodes (2D), with second order gauss quadrature.

◆ EPS

constexpr passivedouble EPS = 1.0E-16
constexpr

Error scale.

◆ EXIT_DIVERGENCE

const unsigned int EXIT_DIVERGENCE = 2

Exit code (divergence).

◆ FEA_TERM

const int FEA_TERM = 0

Position of the finite element analysis terms in the numerics container array.

◆ FOUR3

constexpr passivedouble FOUR3 = 4.0 / 3.0
constexpr

Four divided by three.

◆ FUND_ELEC_CHARGE_CGS

constexpr passivedouble FUND_ELEC_CHARGE_CGS = 4.8032047E-10
constexpr

Fundamental electric charge in CGS units, cm^(3/2) g^(1/2) s^(-1).

◆ GRAD_TERM

const int GRAD_TERM = 6

Position of the gradient smoothing terms in the numerics container array.

◆ INST_0

const unsigned int INST_0 = 0

Definition of the first instance per grid level.

◆ MASTER_NODE

const int MASTER_NODE = 0

Master node for MPI parallelization.

◆ MAT_IDEALDE

const int MAT_IDEALDE = 3

Position of the Ideal-DE material model.

◆ MAT_KNOWLES

const int MAT_KNOWLES = 4

Position of the Knowles material model.

◆ MAT_NHCOMP

const int MAT_NHCOMP = 2

Position of the Neo-Hookean compressible material model.

◆ MAX_FE_KINDS

const unsigned int MAX_FE_KINDS = 7

Maximum number of Finite Elements.

◆ MAX_NUMBER_FFD

const unsigned int MAX_NUMBER_FFD = 15

Maximum number of FFDBoxes for the FFD.

◆ MAX_NUMBER_PERIODIC

const unsigned int MAX_NUMBER_PERIODIC = 10

Maximum number of periodic boundary conditions.

◆ MAX_PARAMETERS

const unsigned int MAX_PARAMETERS = 10

Maximum number of parameters for a design variable definition.

◆ MAX_STRING_SIZE

const unsigned int MAX_STRING_SIZE = 400

Maximum size of a generic string.

◆ MAX_TERMS

const unsigned int MAX_TERMS = 7

Maximum number of terms in the numerical equations (dimension of solver container array).

◆ MAX_ZONES

const unsigned int MAX_ZONES = 3

Maximum number of zones.

◆ MESH_0

const unsigned int MESH_0 = 0

Definition of the finest grid level.

◆ MESH_1

const unsigned int MESH_1 = 1

Definition of the finest grid level.

◆ N_ELEM_TYPES

constexpr unsigned short N_ELEM_TYPES = 7
constexpr

General output & CGNS defines.

◆ N_FACES_HEXAHEDRON

constexpr unsigned short N_FACES_HEXAHEDRON = 6
constexpr

General output & CGNS defines.

◆ N_FACES_LINE

constexpr unsigned short N_FACES_LINE = 1
constexpr

General output & CGNS defines.

◆ N_FACES_MAXIMUM

constexpr unsigned short N_FACES_MAXIMUM = 6
constexpr

Max. out of the above, used for static arrays, keep it up to date.

◆ N_FACES_PRISM

constexpr unsigned short N_FACES_PRISM = 5
constexpr

General output & CGNS defines.

◆ N_FACES_PYRAMID

constexpr unsigned short N_FACES_PYRAMID = 5
constexpr

General output & CGNS defines.

◆ N_FACES_QUADRILATERAL

constexpr unsigned short N_FACES_QUADRILATERAL = 4
constexpr

General output & CGNS defines.

◆ N_FACES_TETRAHEDRON

constexpr unsigned short N_FACES_TETRAHEDRON = 4
constexpr

General output & CGNS defines.

◆ N_FACES_TRIANGLE

constexpr unsigned short N_FACES_TRIANGLE = 3
constexpr

General output & CGNS defines.

◆ N_POINTS_HEXAHEDRON

constexpr unsigned short N_POINTS_HEXAHEDRON = 8
constexpr

General output & CGNS defines.

◆ N_POINTS_LINE

constexpr unsigned short N_POINTS_LINE = 2
constexpr

General output & CGNS defines.

◆ N_POINTS_MAXIMUM

constexpr unsigned short N_POINTS_MAXIMUM = 8
constexpr

Max. out of the above, used for static arrays, keep it up to date.

◆ N_POINTS_PRISM

constexpr unsigned short N_POINTS_PRISM = 6
constexpr

General output & CGNS defines.

◆ N_POINTS_PYRAMID

constexpr unsigned short N_POINTS_PYRAMID = 5
constexpr

General output & CGNS defines.

◆ N_POINTS_QUADRILATERAL

constexpr unsigned short N_POINTS_QUADRILATERAL = 4
constexpr

General output & CGNS defines.

◆ N_POINTS_TETRAHEDRON

constexpr unsigned short N_POINTS_TETRAHEDRON = 4
constexpr

General output & CGNS defines.

◆ N_POINTS_TRIANGLE

constexpr unsigned short N_POINTS_TRIANGLE = 3
constexpr

General output & CGNS defines.

◆ N_POLY_COEFFS

constexpr int N_POLY_COEFFS = 5
constexpr

Number of coefficients in temperature polynomial fits for fluid models.

◆ NO_RK_ITER

const unsigned int NO_RK_ITER = 0

No Runge-Kutta iteration.

◆ ONE2

constexpr passivedouble ONE2 = 0.5
constexpr

One divided by two.

◆ ONE3

constexpr passivedouble ONE3 = 1.0 / 3.0
constexpr

One divided by three.

◆ OVERHEAD

const unsigned int OVERHEAD = 4

Overhead space above nMarker when allocating space for boundary elems (MPI + periodic).

◆ PI_NUMBER

constexpr passivedouble PI_NUMBER = 3.14159265358979323846
constexpr

Pi number (not using M_PI to avoid Windows issues).

◆ SINGLE_NODE

const int SINGLE_NODE = 1

There is only a node in the MPI parallelization.

◆ SINGLE_ZONE

const int SINGLE_ZONE = 1

There is only a zone.

◆ SOURCE_FIRST_TERM

const int SOURCE_FIRST_TERM = 2

Position of the first source term in the numerics container array.

◆ SOURCE_SECOND_TERM

const int SOURCE_SECOND_TERM = 3

Position of the second source term in the numerics container array.

◆ STANDARD_GRAVITY

constexpr passivedouble STANDARD_GRAVITY = 9.80665
constexpr

Acceleration due to gravity at surface of earth.

◆ STD_REF_TEMP

constexpr passivedouble STD_REF_TEMP = 298.15
constexpr

Standard reference temperature for enthalpy in Kelvin.

◆ STEFAN_BOLTZMANN

constexpr passivedouble STEFAN_BOLTZMANN = 5.670367E-08
constexpr

Stefan-Boltzmann constant in W/(m^2*K^4).

◆ SU2_BINARY_STRING_SIZE

const int SU2_BINARY_STRING_SIZE = 65

Length of strings (e.g. marker names) used in the native SU2 binary mesh format. Shared by CSU2BinaryMeshReaderBase and CSU2MeshBinaryFileWriter so they cannot drift apart.

◆ SU2_CONN_SIZE

const int SU2_CONN_SIZE = 10

Size of the connectivity array that is allocated for each element that we read from a mesh file in the format [[globalID vtkType n0 n1 n2 n3 n4 n5 n6 n7 n8].

◆ SU2_CONN_SKIP

const int SU2_CONN_SKIP = 2

Offset to skip the globalID and VTK type at the start of the element connectivity list for each CGNS element.

◆ SU2_RESTART_HEADER_SIZE

const int SU2_RESTART_HEADER_SIZE = 5

Number of ints in the header.

◆ SU2_RESTART_MAGIC_NUMBER

const int SU2_RESTART_MAGIC_NUMBER = 535532

Hex representation of "SU2".

◆ SU2_RESTART_MAX_METADATA

const int SU2_RESTART_MAX_METADATA = 8

Most metadata doubles a trailer ever had.

◆ SU2_RESTART_METADATA_IDX

const int SU2_RESTART_METADATA_IDX = 4

Position of the legacy metadata count.

◆ SU2_RESTART_PRECISION_IDX

const int SU2_RESTART_PRECISION_IDX = 3

Position of the precision field.

◆ TURB_EPS

constexpr passivedouble TURB_EPS = 1.0E-16
constexpr

Turbulent Error scale.

◆ TWO3

constexpr passivedouble TWO3 = 2.0 / 3.0
constexpr

Two divided by three.

◆ UNIVERSAL_GAS_CONSTANT

constexpr passivedouble UNIVERSAL_GAS_CONSTANT = 8.3144598
constexpr

Universal gas constant in J/(mol*K)

◆ VISC_BOUND_TERM

const int VISC_BOUND_TERM = 5

Position of the viscous boundary terms in the numerics container array.

◆ VISC_TERM

const int VISC_TERM = 1

Position of the viscous terms in the numerics container array.

◆ ZONE_0

const unsigned int ZONE_0 = 0

Definition of the first grid domain.

◆ ZONE_1

const unsigned int ZONE_1 = 1

Definition of the second grid domain.