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

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

Classes
class	CCreateMap< T, U >
	creates a map from a list by overloading operator() More...

class	COptionBase

class	COptionEnum< Tenum >

class	COptionDouble

class	COptionString

class	COptionInt

class	COptionULong

class	COptionUShort

class	COptionLong

class	COptionBool

class	COptionEnumList< Tenum >

class	COptionDoubleArray

class	COptionDoubleList

class	COptionShortList

class	COptionUShortList

class	COptionStringList

class	COptionConvect

class	COptionMathProblem

class	COptionDVParam

class	COptionDVValue

class	COptionFFDDef

class	COptionFFDDegree

class	COptionStringDoubleList

class	COptionInlet

class	COptionRiemann< Tenum >

class	COptionNRBC< Tenum >

class	COptionExhaust

class	COptionPeriodic

class	COptionMixingPlane

class	COptionTurboPerformance< Tenum >

class	COptionPython

class	COptionActDisk

Enumerations
enum	SU2_COMPONENT { SU2_CFD = 1, SU2_DEF = 2, SU2_DOT = 3, SU2_MSH = 4, SU2_GEO = 5, SU2_SOL = 6 }
	different software components of SU2 More...

enum	ANSWER { NONE = 0, NO = 0, YES = 1 }
	Boolean answers. More...

enum	VERB_LEVEL { VERB_NONE = 0, VERB_MEDIUM = 1, VERB_HIGH = 2 }
	Verbosity level. More...

enum	ENUM_SOLVER { NO_SOLVER = 0, EULER = 1, NAVIER_STOKES = 2, RANS = 3, POISSON_EQUATION = 4, WAVE_EQUATION = 10, HEAT_EQUATION = 29, FLUID_STRUCTURE_INTERACTION = 12, FEM_ELASTICITY = 13, ADJ_EULER = 18, ADJ_NAVIER_STOKES = 19, ADJ_RANS = 20, TEMPLATE_SOLVER = 30, DISC_ADJ_EULER = 35, DISC_ADJ_RANS = 36, DISC_ADJ_NAVIER_STOKES = 37 }
	different solver types for the CFD component More...

enum	ENUM_FSI_FLUID_PROBLEM { NO_SOLVER_FFSI = 0, EULER_FFSI = 1, NAVIER_STOKES_FFSI = 2, RANS_FFSI = 3 }
	types of fluid solvers More...

enum	ENUM_FSI_STRUC_PROBLEM { NO_SOLVER_SFSI = 0, FEM_ELASTICITY_SFSI = 13 }
	types of structural solvers More...

enum	ENUM_STRUCT_SOLVER { SMALL_DEFORMATIONS = 0, LARGE_DEFORMATIONS = 1 }
	Material geometric conditions. More...

enum	ENUM_MATERIAL_MODEL { LINEAR_ELASTIC = 0, NEO_HOOKEAN = 1 }
	Material model. More...

enum	ENUM_MAT_COMPRESS { COMPRESSIBLE_MAT = 0, INCOMPRESSIBLE_MAT = 1 }
	Material compressibility. More...

enum	ENUM_INTERPOLATOR { NEAREST_NEIGHBOR = 0, ISOPARAMETRIC = 1, CONSISTCONSERVE = 2 }
	types of interpolators More...

enum	ENUM_REGIME { COMPRESSIBLE = 0, INCOMPRESSIBLE = 1 }
	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 }
	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_POISSON_SYS = 4, RUNTIME_ADJPOT_SYS = 5, RUNTIME_ADJFLOW_SYS = 6, RUNTIME_ADJTURB_SYS = 7, RUNTIME_WAVE_SYS = 8, RUNTIME_MULTIGRID_SYS = 14, RUNTIME_FEA_SYS = 20, RUNTIME_HEAT_SYS = 21, RUNTIME_TRANS_SYS = 22 }
	different types of systems More...

enum	ENUM_MATH_PROBLEM { DIRECT = 0, CONTINUOUS_ADJOINT = 1, DISCRETE_ADJOINT = 2 }
	types of mathematical problem to solve More...

enum	ENUM_SPACE { NO_CONVECTIVE = 0, SPACE_CENTERED = 1, SPACE_UPWIND = 2 }
	types of spatial discretizations More...

enum	ENUM_FLUIDMODEL { STANDARD_AIR = 0, IDEAL_GAS = 1, VW_GAS = 2, PR_GAS = 3 }
	types of fluid model More...

enum	ENUM_INIT_OPTION { REYNOLDS = 0, TD_CONDITIONS = 1 }
	types of initialization option More...

enum	ENUM_FREESTREAM_OPTION { TEMPERATURE_FS = 0, DENSITY_FS = 1 }
	types of initialization option More...

enum	ENUM_VISCOSITYMODEL { CONSTANT_VISCOSITY = 0, SUTHERLAND = 1 }
	types of viscosity model More...

enum	ENUM_CONDUCTIVITYMODEL { CONSTANT_CONDUCTIVITY = 0, CONSTANT_PRANDTL = 1 }
	types of thermal conductivity model More...

enum	ENUM_GRIDMOVEMENT { NO_MOVEMENT = 0, DEFORMING = 1, RIGID_MOTION = 2, FLUID_STRUCTURE = 3, EXTERNAL = 4, EXTERNAL_ROTATION = 5, AEROELASTIC = 6, MOVING_WALL = 7, ROTATING_FRAME = 8, ELASTICITY = 9, AEROELASTIC_RIGID_MOTION = 10, STEADY_TRANSLATION = 11, GUST = 12, MOVING_HTP = 13 }
	types of unsteady mesh motion More...

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 }
	type of wind direction More...

enum	ENUM_CENTERED { NO_CENTERED = 0, JST = 1, LAX = 2, JST_KE = 4 }
	types of centered spatial discretizations More...

enum	ENUM_UPWIND { NO_UPWIND = 0, ROE = 1, SCALAR_UPWIND = 2, AUSM = 3, HLLC = 4, SW = 5, MSW = 6, TURKEL = 7, AUSMPWPLUS = 8, CUSP = 9, CONVECTIVE_TEMPLATE = 10 }
	types of upwind spatial discretizations More...

enum	ENUM_SPATIAL_ORDER { FIRST_ORDER = 0, SECOND_ORDER = 1, SECOND_ORDER_LIMITER = 2 }
	Spatial numerical order integration. More...

enum	ENUM_LIMITER { VENKATAKRISHNAN = 0, BARTH_JESPERSEN = 1, SHARP_EDGES = 2, SOLID_WALL_DISTANCE = 3 }
	types of slope limiters More...

enum	ENUM_TURB_MODEL { NO_TURB_MODEL = 0, SA = 1, SA_NEG = 2, SST = 3 }
	types of turbulent models More...

enum	ENUM_TRANS_MODEL { NO_TRANS_MODEL = 0, LM = 1, BC = 2 }
	types of transition models More...

enum	ENUM_TIME_INT { RUNGE_KUTTA_EXPLICIT = 1, EULER_EXPLICIT = 2, EULER_IMPLICIT = 3 }
	type of time integration schemes More...

enum	ENUM_TIME_INT_FEA { CD_EXPLICIT = 1, NEWMARK_IMPLICIT = 2, GENERALIZED_ALPHA = 3 }
	type of time integration schemes More...

enum	ENUM_SPACE_ITE_FEA { NEWTON_RAPHSON = 1, MODIFIED_NEWTON_RAPHSON = 2 }
	type of time integration schemes More...

enum	ENUM_TRANSFER_METHOD { BROADCAST_DATA = 1, SCATTER_DATA = 2, ALLGATHER_DATA = 3, LEGACY_METHOD = 4 }
	types of transfer methods More...

enum	ENUM_FLOW_GRADIENT { GREEN_GAUSS = 1, WEIGHTED_LEAST_SQUARES = 2 }
	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, ELECTRODE_BOUNDARY = 8, DIELEC_BOUNDARY = 9, CUSTOM_BOUNDARY = 10, INTERFACE_BOUNDARY = 11, DIRICHLET = 12, NEUMANN = 13, 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, PRESSURE_BOUNDARY = 27, ACTDISK_INLET = 32, ACTDISK_OUTLET = 33, CLAMPED_BOUNDARY = 34, LOAD_DIR_BOUNDARY = 35, LOAD_SINE_BOUNDARY = 36, NRBC_BOUNDARY = 37, INTERNAL_BOUNDARY = 38, FLUID_INTERFACE = 39, SEND_RECEIVE = 99 }
	types of boundary conditions More...

enum	ENUM_2DFORM { PLANE_STRESS = 0, PLANE_STRAIN = 1 }
	different regime modes More...

enum	ENUM_AITKEN { NO_RELAXATION = 0, FIXED_PARAMETER = 1, AITKEN_DYNAMIC = 2 }
	different regime modes 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 }
	types Riemann boundary treatments More...

enum	MIXINGPROCESS_TYPE { ALGEBRAIC_AVERAGE = 1, AREA_AVERAGE = 2, MIXEDOUT_AVERAGE = 3 }
	types of mixing process for averaging quantities at the boundaries. More...

enum	TURBO_PERFORMANCE_TYPE { BLADE = 1, STAGE = 2, TURBINE = 3 }
	types of Turbomachinery performance indicators. More...

enum	INLET_TYPE { TOTAL_CONDITIONS = 1, MASS_FLOW = 2, INPUT_FILE = 3 }
	types inlet 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 }
	types actuator disk boundary treatments More...

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	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, 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, MAX_THICKNESS = 21, MIN_THICKNESS = 22, MAX_THICK_SEC1 = 23, MAX_THICK_SEC2 = 24, MAX_THICK_SEC3 = 25, MAX_THICK_SEC4 = 26, MAX_THICK_SEC5 = 27, AVG_TOTAL_PRESSURE = 28, AVG_OUTLET_PRESSURE = 29, MASS_FLOW_RATE = 30, OUTFLOW_GENERALIZED = 31, AERO_DRAG_COEFFICIENT = 35, RADIAL_DISTORTION = 36, CIRCUMFERENTIAL_DISTORTION = 37 }
	types of objective functions More...

enum	ENUM_RESIDUAL { RHO_RESIDUAL = 1, RHO_ENERGY_RESIDUAL = 2 }
	types of residual criteria equations More...

enum	ENUM_SENS { SENS_GEOMETRY = 1, SENS_MACH = 2, SENS_AOA = 3, SENS_AOS = 4 }
	types of sensitivities to compute More...

enum	ENUM_ADAPT { NO_ADAPT = 0, FULL = 1, FULL_FLOW = 2, FULL_ADJOINT = 3, GRAD_FLOW = 5, GRAD_ADJOINT = 6, GRAD_FLOW_ADJ = 7, COMPUTABLE = 9, REMAINING = 10, WAKE = 12, SMOOTHING = 14, SUPERSONIC_SHOCK = 15, PERIODIC = 17 }
	types of grid adaptation/refinement More...

enum	ENUM_INPUT { SU2 = 1, CGNS = 2 }
	types of input file formats More...

enum	ENUM_OUTPUT { TECPLOT = 1, TECPLOT_BINARY = 2, FIELDVIEW = 3, FIELDVIEW_BINARY = 4, CSV = 5, CGNS_SOL = 6, PARAVIEW = 7 }
	type of solution output file formats More...

enum	JUMP_DEFINITION { DIFFERENCE = 1, RATIO = 2 }
	type of jump definition More...

enum	MG_CYCLE { V_CYCLE = 0, W_CYCLE = 1, FULLMG_CYCLE = 2 }
	type of multigrid cycle More...

enum	ENUM_OUTPUT_VARS { DENSITY = 1, VEL_X = 2, VEL_Y = 3, VEL_Z = 4, PRESSURE = 5, MACH = 6, TEMPERATURE = 7, LAM_VISC = 8, EDDY_VISC = 9 }
	type of solution output variables More...

enum	ENUM_PARAM { TRANSLATION = 0, ROTATION = 1, SCALE = 2, FFD_SETTING = 3, FFD_CONTROL_POINT = 4, FFD_NACELLE = 5, FFD_GULL = 6, FFD_CAMBER = 7, FFD_TWIST = 8, FFD_THICKNESS = 9, FFD_DIHEDRAL_ANGLE = 10, FFD_ROTATION = 11, FFD_CONTROL_POINT_2D = 12, FFD_CAMBER_2D = 13, FFD_THICKNESS_2D = 14, FFD_TWIST_2D = 15, FFD_CONTROL_SURFACE = 16, HICKS_HENNE = 17, PARABOLIC = 18, NACA_4DIGITS = 19, AIRFOIL = 20, CST = 21, SURFACE_BUMP = 22, SURFACE_FILE = 23, CUSTOM = 24, NO_DEFORMATION = 25, ANGLE_OF_ATTACK = 101, FFD_ANGLE_OF_ATTACK = 102 }
	types of design parameterizations More...

enum	ENUM_FFD_BLENDING { BSPLINE_UNIFORM = 0, BEZIER = 1 }
	types of FFD Blending function

enum	ENUM_LINEAR_SOLVER { STEEPEST_DESCENT = 1, NEWTON = 2, QUASI_NEWTON = 3, CONJUGATE_GRADIENT = 4, FGMRES = 5, BCGSTAB = 6, RESTARTED_FGMRES = 7, SMOOTHER_LUSGS = 8, SMOOTHER_JACOBI = 9, SMOOTHER_ILU = 10, SMOOTHER_LINELET = 11 }
	types of solvers for solving linear systems 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 }
	types of coordinates systems for the FFD

enum	ENUM_SENS_SMOOTHING { NO_SMOOTH = 0, SOBOLEV = 1, BIGRID = 2 }
	types of sensitivity smoothing More...

enum	ENUM_LINEAR_SOLVER_PREC { JACOBI = 1, LU_SGS = 2, LINELET = 3, ILU = 4 }
	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_AXIS_ORIENTATION { X_AXIS = 0, Y_AXIS = 1, Z_AXIS = 2 }
	types of axis orientation More...

enum	ENUM_UNSTEADY { STEADY = 0, TIME_STEPPING = 1, DT_STEPPING_1ST = 2, DT_STEPPING_2ND = 3, ROTATIONAL_FRAME = 4, HARMONIC_BALANCE = 5 }
	types of schemes for unsteady computations More...

enum	ENUM_CONVERGE_CRIT { CAUCHY = 1, RESIDUAL = 2 }
	types of criteria to determine when the solution is converged More...

enum	ENUM_DEFORM_STIFFNESS { CONSTANT_STIFFNESS = 0, INVERSE_VOLUME = 1, 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 }
	The direct differentation variables. More...

enum	ENUM_DYNAMIC { STATIC = 0, DYNAMIC = 1 }
	types of schemes for dynamic structural computations More...

Functions
void	StringToUpperCase (string &str)
	utility function for converting strings to uppercase More...

string	StringToUpperCase (const string &str)
	utility function for converting strings to uppercase More...

Variables
const unsigned int	EXIT_DIVERGENCE = 2
	Exit code (divergence).

const unsigned int	BUFSIZE = 3000000
	MPI buffer.

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 = 200
	Maximum number of domains.

const unsigned int	MAX_NUMBER_FFD = 10
	Maximum number of FFDBoxes for the FFD.

const unsigned int	MAX_SOLS = 6
	Maximum number of solutions at the same time (dimension of solution container array).

const unsigned int	MAX_TERMS = 6
	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 = 4
	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 first grid domain.

const su2double	STANDART_GRAVITY = 9.80665
	Acceleration due to gravity at surface of earth.

const su2double	EPS = 1.0E-16
	Error scale.

const su2double	TURB_EPS = 1.0E-16
	Turbulent Error scale.

const su2double	ONE2 = 0.5
	One divided by two.

const su2double	TWO3 = 2.0 / 3.0
	Two divided by three.

const su2double	FOUR3 = 4.0 / 3.0
	Four divided by three.

const su2double	PI_NUMBER = 4.0 * atan(1.0)
	Pi number.

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.

const unsigned short	N_ELEM_TYPES = 7
	General output & CGNS defines.

const unsigned short	N_POINTS_LINE = 2
	General output & CGNS defines.

const unsigned short	N_POINTS_TRIANGLE = 3
	General output & CGNS defines.

const unsigned short	N_POINTS_QUADRILATERAL = 4
	General output & CGNS defines.

const unsigned short	N_POINTS_TETRAHEDRON = 4
	General output & CGNS defines.

const unsigned short	N_POINTS_HEXAHEDRON = 8
	General output & CGNS defines.

const unsigned short	N_POINTS_PYRAMID = 5
	General output & CGNS defines.

const unsigned short	N_POINTS_PRISM = 6
	General output & CGNS defines.

const int	FLOW_SOL = 0
	Position of the mean flow solution in the solver container array.

const int	ADJFLOW_SOL = 1
	Position of the continuous adjoint flow solution in the solver container array.

const int	TURB_SOL = 2
	Position of the turbulence model solution in the solver container array.

const int	ADJTURB_SOL = 3
	Position of the continuous adjoint turbulence solution in the solver container array.

const int	TRANS_SOL = 4
	Position of the transition model solution in the solver container array.

const int	POISSON_SOL = 2
	Position of the electronic potential solution in the solver container array.

const int	WAVE_SOL = 1
	Position of the wave equation in the solution solver array.

const int	HEAT_SOL = 2
	Position of the heat equation in the solution solver array.

const int	FEA_SOL = 1
	Position of the FEA equation in the solution solver array.

const int	TEMPLATE_SOL = 0
	Position of the template solution.

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	FEA_TERM = 0
	Position of the finite element analysis terms in the numerics container array.

const int	EL_TRIA = 0
	types of finite elements (in 2D or 3D) More...

const int	EL_QUAD = 1
	Elements of four nodes (2D).

const int	EL_TETRA = 0
	Elements of four nodes (3D).

const int	EL_HEXA = 1
	Elements of eight nodes (3D).

const int	CGNS_STRING_SIZE = 33
	Length of strings used in the CGNS format.

Detailed Description

Defines classes for referencing options for easy input in CConfig.

Author: J. Hicken, B. Tracey

Version: 5.0.0 "Raven"

Many of the classes in this file are templated, and therefore must be declared and defined here; to keep all elements together, there is no corresponding .cpp file at this time.

SU2 Original Developers: Dr. Francisco D. Palacios. Dr. Thomas D. Economon.

SU2 Developers: Prof. Juan J. Alonso's group at Stanford University. Prof. Piero Colonna's group at Delft University of Technology. Prof. Nicolas R. Gauger's group at Kaiserslautern University of Technology. Prof. Alberto Guardone's group at Polytechnic University of Milan. Prof. Rafael Palacios' group at Imperial College London. Prof. Edwin van der Weide's group at the University of Twente. Prof. Vincent Terrapon's group at the University of Liege.

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/.

Enumeration Type Documentation

§ ACTDISK_TYPE

enum 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	ACDC computes the right thrust.
MASSFLOW	ACDC computes the right thrust.
POWER	User specifies the Net thrust.

§ ANSWER

enum ANSWER

Boolean answers.

Enumerator
NO	Boolean definition of no.
YES	Boolean definition of yes.

§ 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.
ELECTRODE_BOUNDARY	Electrode boundary definition.
DIELEC_BOUNDARY	Dipoisson boundary definition.
CUSTOM_BOUNDARY	custom boundary definition.
INTERFACE_BOUNDARY	Domain interface boundary definition.
DIRICHLET	Boundary Euler wall definition.
NEUMANN	Boundary Neumann 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.
PRESSURE_BOUNDARY	Pressure 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.
NRBC_BOUNDARY	NRBC Boundary definition.
INTERNAL_BOUNDARY	Internal Boundary definition.
FLUID_INTERFACE	Domain interface definition.
SEND_RECEIVE	Boundary send-receive definition.

§ ENGINE_INFLOW_TYPE

enum 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_2DFORM

enum ENUM_2DFORM

different regime modes

Enumerator
PLANE_STRESS	Definition of plane stress solver.
PLANE_STRAIN	Definition of plane strain solver.

§ ENUM_ADAPT

enum ENUM_ADAPT

types of grid adaptation/refinement

Enumerator
NO_ADAPT	No grid adaptation.
FULL	Do a complete grid refinement of all the computational grids.
FULL_FLOW	Do a complete grid refinement of the flow grid.
FULL_ADJOINT	Do a complete grid refinement of the adjoint grid.
GRAD_FLOW	Do a gradient based grid adaptation of the flow grid.
GRAD_ADJOINT	Do a gradient based grid adaptation of the adjoint grid.
GRAD_FLOW_ADJ	Do a gradient based grid adaptation of the flow and adjoint grid.
COMPUTABLE	Apply a computable error grid adaptation.
REMAINING	Apply a remaining error grid adaptation.
WAKE	Do a grid refinement on the wake.
SMOOTHING	Do a grid smoothing of the geometry.
SUPERSONIC_SHOCK	Do a grid smoothing.
PERIODIC	Add the periodic halo cells.

§ ENUM_AITKEN

enum ENUM_AITKEN

different regime modes

Enumerator
NO_RELAXATION	No relaxation in the strongly coupled approach.
FIXED_PARAMETER	Relaxation with a fixed parameter.
AITKEN_DYNAMIC	Relaxation using Aitken's dynamic parameter.

§ ENUM_AXIS_ORIENTATION

enum ENUM_AXIS_ORIENTATION

types of axis orientation

Enumerator
X_AXIS	X axis orientation.
Y_AXIS	Y axis orientation.
Z_AXIS	Z axis orientation.

§ ENUM_CENTERED

enum ENUM_CENTERED

types of centered spatial discretizations

Enumerator
NO_CENTERED	No centered scheme is used.
JST	Jameson-Smith-Turkel centered numerical method.
LAX	Lax-Friedrich centered numerical method.
JST_KE	Kinetic Energy preserving Jameson-Smith-Turkel centered numerical method.

§ ENUM_CONDUCTIVITYMODEL

enum ENUM_CONDUCTIVITYMODEL

types of thermal conductivity model

Enumerator
CONSTANT_CONDUCTIVITY	_____.

§ ENUM_CONVERGE_CRIT

enum ENUM_CONVERGE_CRIT

types of criteria to determine when the solution is converged

Enumerator
CAUCHY	Cauchy criteria to establish the convergence of the code.
RESIDUAL	Residual criteria to establish the convergence of the code.

§ ENUM_DEFORM_STIFFNESS

enum 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.
WALL_DISTANCE	Impose a stiffness for each element that is proportional to the distance from the deforming surface.

§ ENUM_DIRECTDIFF_VAR

enum ENUM_DIRECTDIFF_VAR

The direct differentation variables.

Enumerator
D_MACH	Derivative with respect to the mach number.
D_AOA	Derivative with respect to the angle of attack.
D_PRESSURE	Derivative with respect to the freestream pressure.
D_TEMPERATURE	Derivative with respect to the freestream temperature.

§ ENUM_DYNAMIC

enum ENUM_DYNAMIC

types of schemes for dynamic structural computations

Enumerator
STATIC	A static structural computation.
DYNAMIC	Use a time stepping strategy for dynamic computations.

§ ENUM_FFD_CONTINUITY

enum 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_FLOW_GRADIENT

enum ENUM_FLOW_GRADIENT

types of schemes to compute the flow gradient

Enumerator
GREEN_GAUSS	Gradients computation using Green Gauss theorem.
WEIGHTED_LEAST_SQUARES	Gradients computation using Weighted Least Squares.

§ ENUM_FLUIDMODEL

enum ENUM_FLUIDMODEL

types of fluid model

Enumerator
IDEAL_GAS	_____.

§ ENUM_FREESTREAM_OPTION

enum ENUM_FREESTREAM_OPTION

types of initialization option

Enumerator
TEMPERATURE_FS	_____.

§ ENUM_FSI_FLUID_PROBLEM

enum ENUM_FSI_FLUID_PROBLEM

types of fluid solvers

Enumerator
NO_SOLVER_FFSI	Definition of no solver.
EULER_FFSI	Euler equations for the FSI problem.
NAVIER_STOKES_FFSI	NS equations for the FSI problem.
RANS_FFSI	RANS equations for the FSI problem.

§ ENUM_FSI_STRUC_PROBLEM

enum ENUM_FSI_STRUC_PROBLEM

types of structural solvers

Enumerator
NO_SOLVER_SFSI	Definition of no solver.
FEM_ELASTICITY_SFSI	Nonlinear elasticity equations for the FSI problem.

§ ENUM_GEO_ANALYTIC

enum 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_GRIDMOVEMENT

enum ENUM_GRIDMOVEMENT

types of unsteady mesh motion

Enumerator
NO_MOVEMENT	Simulation on a static mesh.
DEFORMING	Simulation with dynamically deforming meshes (plunging/pitching/rotation).
RIGID_MOTION	Simulation with rigid mesh motion (plunging/pitching/rotation).
FLUID_STRUCTURE	Fluid structure defromation.
EXTERNAL	Arbitrary grid motion specified by external files at each time step.
EXTERNAL_ROTATION	Arbitrary grid motion specified by external files at each time step with rigid rotation.
AEROELASTIC	Simulation with aeroelastic motion.
MOVING_WALL	Simulation with moving walls (translation/rotation).
ROTATING_FRAME	Simulation in a rotating frame.
ELASTICITY	Linear Elasticity.
AEROELASTIC_RIGID_MOTION	Simulation with rotation and aeroelastic motion.
STEADY_TRANSLATION	Simulation in a steadily translating frame.
GUST	Simulation on a static mesh with a gust.
MOVING_HTP	Simulation with moving HTP (rotation).

§ ENUM_GUST_DIR

enum ENUM_GUST_DIR

type of wind direction

Enumerator
X_DIR	_______.
Y_DIR	_______.

§ ENUM_GUST_TYPE

enum ENUM_GUST_TYPE

type of wind gusts

Enumerator
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_INIT_OPTION

enum ENUM_INIT_OPTION

types of initialization option

Enumerator
REYNOLDS	_____.

§ ENUM_INPUT

enum ENUM_INPUT

types of input file formats

Enumerator
SU2	SU2 input format.
CGNS	CGNS input format for the computational grid.

§ ENUM_INTERPOLATOR

enum ENUM_INTERPOLATOR

types of interpolators

Enumerator
NEAREST_NEIGHBOR	Nearest Neigbhor interpolation.
ISOPARAMETRIC	Isoparametric interpolation.
CONSISTCONSERVE	Consistent & Conservative interpolation (S.A. Brown 1997). Utilizes Isoparametric interpolation.

§ ENUM_KIND_NONDIM

enum ENUM_KIND_NONDIM

different non-dimensional modes

Enumerator
DIMENSIONAL	Dimensional simulation.
FREESTREAM_PRESS_EQ_ONE	Non-dimensional simulation.
FREESTREAM_VEL_EQ_MACH	Non-dimensional simulation.
FREESTREAM_VEL_EQ_ONE	Non-dimensional simulation.

§ ENUM_LIMITER

enum ENUM_LIMITER

types of slope limiters

Enumerator
VENKATAKRISHNAN	Slope limiter using Venkatakrisnan method.
BARTH_JESPERSEN	Slope limiter using Barth-Jespersen method.
SHARP_EDGES	Slope limiter using sharp edges.
SOLID_WALL_DISTANCE	Slope limiter using wall distance.

§ ENUM_LINEAR_SOLVER

enum ENUM_LINEAR_SOLVER

types of solvers for solving linear systems

Enumerator
STEEPEST_DESCENT	Steepest descent method for point inversion algoritm (Free-Form).
NEWTON	Newton method for point inversion algorithm (Free-Form).
QUASI_NEWTON	Quasi Newton method for point inversion algorithm (Free-Form).
CONJUGATE_GRADIENT	Preconditionated conjugate gradient method for grid deformation.
FGMRES	Flexible Generalized Minimal Residual method.
BCGSTAB	BCGSTAB - Biconjugate Gradient Stabilized Method (main solver).
RESTARTED_FGMRES	Flexible Generalized Minimal Residual method with restart.
SMOOTHER_LUSGS	LU_SGS smoother.
SMOOTHER_JACOBI	Jacobi smoother.
SMOOTHER_ILU	ILU smoother.
SMOOTHER_LINELET	Linelet smoother.

§ ENUM_LINEAR_SOLVER_PREC

enum ENUM_LINEAR_SOLVER_PREC

types of preconditioners for the linear solver

Enumerator
JACOBI	Jacobi preconditioner.
LU_SGS	LU SGS preconditioner.
LINELET	Line implicit preconditioner.
ILU	ILU(0) preconditioner.

§ ENUM_MAT_COMPRESS

enum ENUM_MAT_COMPRESS

Material compressibility.

Enumerator
COMPRESSIBLE_MAT	Definition of compressible material.
INCOMPRESSIBLE_MAT	Definition of incompressible material.

§ ENUM_MATERIAL_MODEL

enum ENUM_MATERIAL_MODEL

Material model.

Enumerator
LINEAR_ELASTIC	Definition of linear elastic material.
NEO_HOOKEAN	Definition of Neo-Hookean material.

§ ENUM_MATH_PROBLEM

enum ENUM_MATH_PROBLEM

types of mathematical problem to solve

Enumerator
DIRECT	Direct problem.
CONTINUOUS_ADJOINT	Continuous adjoint problem.

§ ENUM_MEASUREMENTS

enum ENUM_MEASUREMENTS

different system of measurements

Enumerator
SI	Definition of compressible solver.
US	Definition of incompressible solver.

§ ENUM_OBJECTIVE

enum 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.
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.
MAX_THICKNESS	Maximum thickness.
MIN_THICKNESS	Minimum thickness.
MAX_THICK_SEC1	Maximum thickness in section 1.
MAX_THICK_SEC2	Maximum thickness in section 2.
MAX_THICK_SEC3	Maximum thickness in section 3.
MAX_THICK_SEC4	Maximum thickness in section 4.
MAX_THICK_SEC5	Maximum thickness in section 5.
AVG_TOTAL_PRESSURE	Total Pressure objective function definition.
AVG_OUTLET_PRESSURE	Static Pressure objective function definition.
MASS_FLOW_RATE	Mass Flow Rate objective function definition.
OUTFLOW_GENERALIZED	Objective function defined via chain rule on primitive variable gradients.
AERO_DRAG_COEFFICIENT	Aero Drag objective function definition.
RADIAL_DISTORTION	Radial Distortion objective function definition.
CIRCUMFERENTIAL_DISTORTION	Circumferential Distortion objective function definition.

§ ENUM_OUTPUT

enum ENUM_OUTPUT

type of solution output file formats

Enumerator
TECPLOT	Tecplot format for the solution output.
TECPLOT_BINARY	Tecplot binary format for the solution output.
FIELDVIEW	FieldView format for the solution output.
FIELDVIEW_BINARY	FieldView binary format for the solution output.
CSV	Comma-separated values format for the solution output.
CGNS_SOL	CGNS format for the solution output.
PARAVIEW	Paraview format for the solution output.

§ ENUM_OUTPUT_VARS

enum ENUM_OUTPUT_VARS

type of solution output variables

Enumerator
DENSITY	Density.
VEL_X	X-component of velocity.
VEL_Y	Y-component of velocity.
VEL_Z	Z-component of velocity.
PRESSURE	Static pressure.
MACH	Mach number.
TEMPERATURE	Temperature.
LAM_VISC	Laminar viscosity.
EDDY_VISC	Eddy viscosity.

§ ENUM_PARAM

enum ENUM_PARAM

types of design parameterizations

Enumerator
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_DIHEDRAL_ANGLE	Free form deformation for 3D design (change the dihedral angle).
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_TWIST_2D	Free form deformation for 3D design (camber change).
FFD_CONTROL_SURFACE	Free form deformation for 3D design (control surface).
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 set using a surface file.
CUSTOM	'CUSTOM' for use in external python analysis.
NO_DEFORMATION	No Deformation.
ANGLE_OF_ATTACK	Angle of attack for airfoils.
FFD_ANGLE_OF_ATTACK	Angle of attack for FFD problem.

§ ENUM_REGIME

enum ENUM_REGIME

different regime modes

Enumerator
COMPRESSIBLE	Definition of compressible solver.
INCOMPRESSIBLE	Definition of incompressible solver.

§ ENUM_RESIDUAL

enum ENUM_RESIDUAL

types of residual criteria equations

Enumerator
RHO_RESIDUAL	Rho equation residual criteria equation.
RHO_ENERGY_RESIDUAL	RhoE equation residual criteria equation.

§ ENUM_SENS

enum ENUM_SENS

types of sensitivities to compute

Enumerator
SENS_GEOMETRY	Geometrical sensitivity.
SENS_MACH	Mach number sensitivity.
SENS_AOA	Angle of attack sensitivity.
SENS_AOS	Angle of Sideslip sensitivity.

§ ENUM_SENS_SMOOTHING

enum ENUM_SENS_SMOOTHING

types of sensitivity smoothing

Enumerator
NO_SMOOTH	No smoothing.
SOBOLEV	Sobolev gradient smoothing.
BIGRID	Bi-grid technique smoothing.

§ ENUM_SOLVER

enum ENUM_SOLVER

different solver types for the CFD component

Enumerator
NO_SOLVER	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.
POISSON_EQUATION	Definition of the poisson potential solver.
WAVE_EQUATION	Definition of the wave solver.
HEAT_EQUATION	Definition of the heat solver.
FLUID_STRUCTURE_INTERACTION	Definition of a FSI 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.

§ 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.

§ ENUM_SPACE_ITE_FEA

enum ENUM_SPACE_ITE_FEA

type of time integration schemes

Enumerator
NEWTON_RAPHSON	Full Newton-Rapshon method.
MODIFIED_NEWTON_RAPHSON	Modified Newton-Raphson method.

§ ENUM_SPATIAL_ORDER

enum ENUM_SPATIAL_ORDER

Spatial numerical order integration.

Enumerator
FIRST_ORDER	First order.
SECOND_ORDER	Second order.
SECOND_ORDER_LIMITER	Second order with limiter.

§ ENUM_STRUCT_SOLVER

enum ENUM_STRUCT_SOLVER

Material geometric conditions.

Enumerator
SMALL_DEFORMATIONS	Definition of linear elastic material.
LARGE_DEFORMATIONS	Definition of Neo-Hookean material.

§ ENUM_TIME_INT

enum 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.

§ ENUM_TIME_INT_FEA

enum ENUM_TIME_INT_FEA

type of time integration schemes

Enumerator
CD_EXPLICIT	Support for implementing an explicit method.
NEWMARK_IMPLICIT	Implicit Newmark integration definition.
GENERALIZED_ALPHA	Support for implementing another implicit method.

§ ENUM_TRANS_MODEL

enum ENUM_TRANS_MODEL

types of transition models

Enumerator
NO_TRANS_MODEL	No transition model.
LM	Kind of transition model (LM for Spalart-Allmaras).
BC	Kind of transition model (BAS-CAKMAKCIOGLU (BC) for Spalart-Allmaras).

§ ENUM_TRANSFER_METHOD

enum ENUM_TRANSFER_METHOD

types of transfer methods

Enumerator
BROADCAST_DATA	Gather data on one processor and broadcast it into all of them, relating to global nodes.
SCATTER_DATA	Gather data on one processor and scatter it into the one that needs it.
ALLGATHER_DATA	All processors gather data (this will be useful for operations over a group of data - averaging)
LEGACY_METHOD	Original transfer method, maintained to check .

§ ENUM_TURB_MODEL

enum ENUM_TURB_MODEL

types of turbulent models

Enumerator
NO_TURB_MODEL	No turbulence model.
SA	Kind of Turbulent model (Spalart-Allmaras).
SA_NEG	Kind of Turbulent model (Spalart-Allmaras).
SST	Kind of Turbulence model (Menter SST).

§ ENUM_UNSTEADY

enum ENUM_UNSTEADY

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.

§ ENUM_UPWIND

enum ENUM_UPWIND

types of upwind spatial discretizations

Enumerator
NO_UPWIND	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.
AUSMPWPLUS	AUSMPW+ numerical method.
CUSP	Convective upwind and split pressure numerical method.
CONVECTIVE_TEMPLATE	Template for new numerical method .

§ ENUM_VISCOSITYMODEL

enum ENUM_VISCOSITYMODEL

types of viscosity model

Enumerator
CONSTANT_VISCOSITY	_____.

§ 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

enum 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

enum GEOMETRY_MODE

types of action to perform when doing the geometry evaluation

Enumerator
FUNCTION	Geometrical analysis.
GRADIENT	Geometrical analysis and gradient using finite differences.

§ INLET_TYPE

enum INLET_TYPE

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.

§ JUMP_DEFINITION

enum JUMP_DEFINITION

type of jump definition

Enumerator
DIFFERENCE	Jump given by a difference in values.
RATIO	Jump given by a ratio.

§ MG_CYCLE

enum MG_CYCLE

type of multigrid cycle

Enumerator
V_CYCLE	V cycle.
W_CYCLE	W cycle.
FULLMG_CYCLE	FullMG cycle.

§ MIXINGPROCESS_TYPE

enum MIXINGPROCESS_TYPE

types of mixing process for averaging quantities at the boundaries.

Enumerator
ALGEBRAIC_AVERAGE	an algebraic average is computed at the boundary of interest.
AREA_AVERAGE	an area average is computed at the boundary of interest.
MIXEDOUT_AVERAGE	an mixed-out average is computed at the boundary of interest.

§ RIEMANN_TYPE

enum 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 are retrieved from the other domain.
MIXING_OUT	User does not specify anything information are retrieved from the other domain.

§ RUNTIME_TYPE

enum 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_POISSON_SYS	One-physics case, the code is solving the poissonal potential equation.
RUNTIME_ADJPOT_SYS	One-physics case, the code is solving the adjoint potential flow equation.
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_WAVE_SYS	One-physics case, the code is solving the wave equation.
RUNTIME_MULTIGRID_SYS	Full Approximation Storage Multigrid system of equations.
RUNTIME_FEA_SYS	One-physics case, the code is solving the FEA equation.
RUNTIME_HEAT_SYS	One-physics case, the code is solving the heat equation.
RUNTIME_TRANS_SYS	One-physics case, the code is solving the turbulence model.

§ SU2_COMPONENT

enum SU2_COMPONENT

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_MSH	Running the SU2_MSH software.
SU2_GEO	Running the SU2_GEO software.
SU2_SOL	Running the SU2_SOL software.

§ TURBO_PERFORMANCE_TYPE

enum TURBO_PERFORMANCE_TYPE

types of Turbomachinery performance indicators.

Enumerator
BLADE	Turbomachinery blade performances.
STAGE	Turbomachinery blade stage performances.
TURBINE	Turbomachinery turbine performances.

§ VERB_LEVEL

enum VERB_LEVEL

Verbosity level.

Enumerator
VERB_NONE	No verbosity.
VERB_MEDIUM	Medium level of verbosity.
VERB_HIGH	High level of verbosity.

Function Documentation

§ StringToUpperCase() [1/2]

void StringToUpperCase ( string & str )

inline

utility function for converting strings to uppercase

Parameters

[in,out] str - string we want to convert

§ StringToUpperCase() [2/2]

string StringToUpperCase ( const string & str )

inline

utility function for converting strings to uppercase

Parameters

[in] str - string we want a copy of converted to uppercase

Returns: a copy of str in uppercase

Variable Documentation

§ EL_TRIA

const int EL_TRIA = 0

types of finite elements (in 2D or 3D)

Elements of three nodes (2D).

Classes

Enumerations

Functions

Variables

Detailed Description

Enumeration Type Documentation

§ ACTDISK_TYPE

§ ANSWER

§ BC_TYPE

§ ENGINE_INFLOW_TYPE

§ ENUM_2DFORM

§ ENUM_ADAPT

§ ENUM_AITKEN

§ ENUM_AXIS_ORIENTATION

§ ENUM_CENTERED

§ ENUM_CONDUCTIVITYMODEL

§ ENUM_CONVERGE_CRIT

§ ENUM_DEFORM_STIFFNESS

§ ENUM_DIRECTDIFF_VAR

§ ENUM_DYNAMIC

§ ENUM_FFD_CONTINUITY

§ ENUM_FLOW_GRADIENT

§ ENUM_FLUIDMODEL

§ ENUM_FREESTREAM_OPTION

§ ENUM_FSI_FLUID_PROBLEM

§ ENUM_FSI_STRUC_PROBLEM

§ ENUM_GEO_ANALYTIC

§ ENUM_GRIDMOVEMENT

§ ENUM_GUST_DIR

§ ENUM_GUST_TYPE

§ ENUM_INIT_OPTION

§ ENUM_INPUT

§ ENUM_INTERPOLATOR

§ ENUM_KIND_NONDIM

§ ENUM_LIMITER

§ ENUM_LINEAR_SOLVER

§ ENUM_LINEAR_SOLVER_PREC

§ ENUM_MAT_COMPRESS

§ ENUM_MATERIAL_MODEL

§ ENUM_MATH_PROBLEM

§ ENUM_MEASUREMENTS

§ ENUM_OBJECTIVE

§ ENUM_OUTPUT

§ ENUM_OUTPUT_VARS

§ ENUM_PARAM

§ ENUM_REGIME

§ ENUM_RESIDUAL

§ ENUM_SENS

§ ENUM_SENS_SMOOTHING

§ ENUM_SOLVER

§ ENUM_SPACE

§ ENUM_SPACE_ITE_FEA

§ ENUM_SPATIAL_ORDER

§ ENUM_STRUCT_SOLVER

§ ENUM_TIME_INT

§ ENUM_TIME_INT_FEA

§ ENUM_TRANS_MODEL

§ ENUM_TRANSFER_METHOD

§ ENUM_TURB_MODEL

§ ENUM_UNSTEADY

§ ENUM_UPWIND

§ ENUM_VISCOSITYMODEL

§ GEO_TYPE

§ GEOMETRY_ACTION

§ GEOMETRY_MODE

§ INLET_TYPE

§ JUMP_DEFINITION

§ MG_CYCLE

§ MIXINGPROCESS_TYPE

§ RIEMANN_TYPE

§ RUNTIME_TYPE

§ SU2_COMPONENT

§ TURBO_PERFORMANCE_TYPE

§ VERB_LEVEL

Function Documentation

§ StringToUpperCase() [1/2]

§ StringToUpperCase() [2/2]

Variable Documentation

§ EL_TRIA