Merge pull request #1404 from su2code/minor_chores

Minor chores: TURB_MODEL now enum class.

Author: TobiKattmann

Common/include/CConfig.hpp

@@ -554,7 +554,7 @@ class CConfig {
   STRUCT_DEFORMATION Kind_Struct_Solver;   /*!< \brief Determines the geometric condition (small or large deformations) for structural analysis. */
   unsigned short Kind_DV_FEA;              /*!< \brief Kind of Design Variable for FEA problems.*/
 
-  unsigned short Kind_Turb_Model;   /*!< \brief Turbulent model definition. */
+  TURB_MODEL Kind_Turb_Model;       /*!< \brief Turbulent model definition. */
   unsigned short Kind_SGS_Model;    /*!< \brief LES SGS model definition. */
   unsigned short Kind_Trans_Model,  /*!< \brief Transition model definition. */
   Kind_ActDisk, Kind_Engine_Inflow,
@@ -4162,7 +4162,7 @@ class CConfig {
    * \brief Get the kind of the turbulence model.
    * \return Kind of the turbulence model.
    */
-  unsigned short GetKind_Turb_Model(void) const { return Kind_Turb_Model; }
+  TURB_MODEL GetKind_Turb_Model(void) const { return Kind_Turb_Model; }
 
   /*!
    * \brief Get the kind of the transition model.

Common/include/option_structure.hpp

@@ -888,25 +888,25 @@ static const MapType<std::string, ENUM_LIMITER> Limiter_Map = {
 /*!
  * \brief Types of turbulent models
  */
-enum ENUM_TURB_MODEL {
-  NO_TURB_MODEL = 0, /*!< \brief No turbulence model. */
-  SA        = 1,     /*!< \brief Kind of Turbulent model (Spalart-Allmaras). */
-  SA_NEG    = 2,     /*!< \brief Kind of Turbulent model (Spalart-Allmaras). */
-  SA_E      = 3,     /*!< \brief Kind of Turbulent model (Spalart-Allmaras Edwards). */
-  SA_COMP   = 4,     /*!< \brief Kind of Turbulent model (Spalart-Allmaras Compressibility Correction). */
-  SA_E_COMP = 5,     /*!< \brief Kind of Turbulent model (Spalart-Allmaras Edwards with Compressibility Correction). */
-  SST       = 6,     /*!< \brief Kind of Turbulence model (Menter SST). */
-  SST_SUST  = 7      /*!< \brief Kind of Turbulence model (Menter SST with sustaining terms for free-stream preservation). */
-};
-static const MapType<std::string, ENUM_TURB_MODEL> Turb_Model_Map = {
-  MakePair("NONE", NO_TURB_MODEL)
-  MakePair("SA", SA)
-  MakePair("SA_NEG", SA_NEG)
-  MakePair("SA_E", SA_E)
-  MakePair("SA_COMP", SA_COMP)
-  MakePair("SA_E_COMP", SA_E_COMP)
-  MakePair("SST", SST)
-  MakePair("SST_SUST", SST_SUST)
+enum class TURB_MODEL {
+  NONE,      /*!< \brief No turbulence model. */
+  SA,        /*!< \brief Kind of Turbulent model (Spalart-Allmaras). */
+  SA_NEG,    /*!< \brief Kind of Turbulent model (Spalart-Allmaras). */
+  SA_E,      /*!< \brief Kind of Turbulent model (Spalart-Allmaras Edwards). */
+  SA_COMP,   /*!< \brief Kind of Turbulent model (Spalart-Allmaras Compressibility Correction). */
+  SA_E_COMP, /*!< \brief Kind of Turbulent model (Spalart-Allmaras Edwards with Compressibility Correction). */
+  SST,       /*!< \brief Kind of Turbulence model (Menter SST). */
+  SST_SUST   /*!< \brief Kind of Turbulence model (Menter SST with sustaining terms for free-stream preservation). */
+};
+static const MapType<std::string, TURB_MODEL> Turb_Model_Map = {
+  MakePair("NONE", TURB_MODEL::NONE)
+  MakePair("SA", TURB_MODEL::SA)
+  MakePair("SA_NEG", TURB_MODEL::SA_NEG)
+  MakePair("SA_E", TURB_MODEL::SA_E)
+  MakePair("SA_COMP", TURB_MODEL::SA_COMP)
+  MakePair("SA_E_COMP", TURB_MODEL::SA_E_COMP)
+  MakePair("SST", TURB_MODEL::SST)
+  MakePair("SST_SUST", TURB_MODEL::SST_SUST)
 };
 
 /*!

Common/include/option_structure.inl

@@ -1889,7 +1889,7 @@ public:
           this->doubleInfo[i] = new su2double[1];
 
           /* Check for a valid RANS turbulence model. */
-          map<string, ENUM_TURB_MODEL>::const_iterator iit;
+          map<string, TURB_MODEL>::const_iterator iit;
           iit = Turb_Model_Map.find(option_value[counter++]);
           if(iit == Turb_Model_Map.end()) {
             string newstring;
@@ -1904,8 +1904,6 @@ public:
             return newstring;
           }
 
-          this->intInfo[i][0] = iit->second;
-
           /* Extract the exchange distance. */
           istringstream ss_1st(option_value[counter++]);
           if (!(ss_1st >> this->doubleInfo[i][0])) {

Common/src/CConfig.cpp

@@ -1076,7 +1076,7 @@ void CConfig::SetConfig_Options() {
   /*!\brief MATH_PROBLEM  \n DESCRIPTION: Mathematical problem \n  Options: DIRECT, ADJOINT \ingroup Config*/
   addMathProblemOption("MATH_PROBLEM", ContinuousAdjoint, false, DiscreteAdjoint, discAdjDefault, Restart_Flow, discAdjDefault);
   /*!\brief KIND_TURB_MODEL \n DESCRIPTION: Specify turbulence model \n Options: see \link Turb_Model_Map \endlink \n DEFAULT: NO_TURB_MODEL \ingroup Config*/
-  addEnumOption("KIND_TURB_MODEL", Kind_Turb_Model, Turb_Model_Map, NO_TURB_MODEL);
+  addEnumOption("KIND_TURB_MODEL", Kind_Turb_Model, Turb_Model_Map, TURB_MODEL::NONE);
   /*!\brief KIND_TRANS_MODEL \n DESCRIPTION: Specify transition model OPTIONS: see \link Trans_Model_Map \endlink \n DEFAULT: NO_TRANS_MODEL \ingroup Config*/
   addEnumOption("KIND_TRANS_MODEL", Kind_Trans_Model, Trans_Model_Map, NO_TRANS_MODEL);
 
@@ -3273,16 +3273,16 @@ void CConfig::SetPostprocessing(SU2_COMPONENT val_software, unsigned short val_i
     }
   }
 
-  if (Kind_Solver == NAVIER_STOKES && Kind_Turb_Model != NONE){
+  if (Kind_Solver == NAVIER_STOKES && Kind_Turb_Model != TURB_MODEL::NONE){
     SU2_MPI::Error("KIND_TURB_MODEL must be NONE if SOLVER= NAVIER_STOKES", CURRENT_FUNCTION);
   }
-  if (Kind_Solver == INC_NAVIER_STOKES && Kind_Turb_Model != NONE){
+  if (Kind_Solver == INC_NAVIER_STOKES && Kind_Turb_Model != TURB_MODEL::NONE){
     SU2_MPI::Error("KIND_TURB_MODEL must be NONE if SOLVER= INC_NAVIER_STOKES", CURRENT_FUNCTION);
   }
-  if (Kind_Solver == RANS && Kind_Turb_Model == NONE){
+  if (Kind_Solver == RANS && Kind_Turb_Model == TURB_MODEL::NONE){
     SU2_MPI::Error("A turbulence model must be specified with KIND_TURB_MODEL if SOLVER= RANS", CURRENT_FUNCTION);
   }
-  if (Kind_Solver == INC_RANS && Kind_Turb_Model == NONE){
+  if (Kind_Solver == INC_RANS && Kind_Turb_Model == TURB_MODEL::NONE){
     SU2_MPI::Error("A turbulence model must be specified with KIND_TURB_MODEL if SOLVER= INC_RANS", CURRENT_FUNCTION);
   }
 
@@ -4043,18 +4043,18 @@ void CConfig::SetPostprocessing(SU2_COMPONENT val_software, unsigned short val_i
   if (MGCycle == FULLMG_CYCLE) FinestMesh = nMGLevels;
 
   if ((Kind_Solver == NAVIER_STOKES) &&
-      (Kind_Turb_Model != NONE))
+      (Kind_Turb_Model != TURB_MODEL::NONE))
     Kind_Solver = RANS;
 
   if ((Kind_Solver == INC_NAVIER_STOKES) &&
-      (Kind_Turb_Model != NONE))
+      (Kind_Turb_Model != TURB_MODEL::NONE))
     Kind_Solver = INC_RANS;
 
   if (Kind_Solver == EULER ||
       Kind_Solver == INC_EULER ||
       Kind_Solver == NEMO_EULER ||
       Kind_Solver == FEM_EULER)
-    Kind_Turb_Model = NONE;
+    Kind_Turb_Model = TURB_MODEL::NONE;
 
   Kappa_2nd_Flow = jst_coeff[0];
   Kappa_4th_Flow = jst_coeff[1];
@@ -4435,7 +4435,7 @@ void CConfig::SetPostprocessing(SU2_COMPONENT val_software, unsigned short val_i
     for (int i=0; i<7; ++i) eng_cyl[i] /= 12.0;
   }
 
-  if ((Kind_Turb_Model != SA) && (Kind_Trans_Model == BC)){
+  if ((Kind_Turb_Model != TURB_MODEL::SA) && (Kind_Trans_Model == BC)){
     SU2_MPI::Error("BC transition model currently only available in combination with SA turbulence model!", CURRENT_FUNCTION);
   }
 
@@ -4533,7 +4533,7 @@ void CConfig::SetPostprocessing(SU2_COMPONENT val_software, unsigned short val_i
 
   /* --- Throw error if UQ used for any turbulence model other that SST --- */
 
-  if (Kind_Solver == RANS && Kind_Turb_Model != SST && Kind_Turb_Model != SST_SUST && using_uq){
+  if (Kind_Solver == RANS && Kind_Turb_Model != TURB_MODEL::SST && Kind_Turb_Model != TURB_MODEL::SST_SUST && using_uq){
     SU2_MPI::Error("UQ capabilities only implemented for NAVIER_STOKES solver SST turbulence model", CURRENT_FUNCTION);
   }
 
@@ -5620,13 +5620,14 @@ void CConfig::SetOutput(SU2_COMPONENT val_software, unsigned short val_izone) {
         if (Kind_Regime == ENUM_REGIME::INCOMPRESSIBLE) cout << "Incompressible RANS equations." << endl;
         cout << "Turbulence model: ";
         switch (Kind_Turb_Model) {
-          case SA:        cout << "Spalart Allmaras" << endl; break;
-          case SA_NEG:    cout << "Negative Spalart Allmaras" << endl; break;
-          case SA_E:      cout << "Edwards Spalart Allmaras" << endl; break;
-          case SA_COMP:   cout << "Compressibility Correction Spalart Allmaras" << endl; break;
-          case SA_E_COMP: cout << "Compressibility Correction Edwards Spalart Allmaras" << endl; break;
-          case SST:       cout << "Menter's SST"     << endl; break;
-          case SST_SUST:  cout << "Menter's SST with sustaining terms" << endl; break;
+          case TURB_MODEL::NONE: break;
+          case TURB_MODEL::SA:        cout << "Spalart Allmaras" << endl; break;
+          case TURB_MODEL::SA_NEG:    cout << "Negative Spalart Allmaras" << endl; break;
+          case TURB_MODEL::SA_E:      cout << "Edwards Spalart Allmaras" << endl; break;
+          case TURB_MODEL::SA_COMP:   cout << "Compressibility Correction Spalart Allmaras" << endl; break;
+          case TURB_MODEL::SA_E_COMP: cout << "Compressibility Correction Edwards Spalart Allmaras" << endl; break;
+          case TURB_MODEL::SST:       cout << "Menter's SST"     << endl; break;
+          case TURB_MODEL::SST_SUST:  cout << "Menter's SST with sustaining terms" << endl; break;
         }
         if (QCR) cout << "Using Quadratic Constitutive Relation, 2000 version (QCR2000)" << endl;
         if (Kind_Trans_Model == BC) cout << "Using the revised BC transition model (2020)" << endl;

SU2_CFD/include/output/CAdjFlowCompOutput.hpp

@@ -39,7 +39,7 @@ class CAdjFlowCompOutput final: public COutput {
 
   bool cont_adj;             /*!< \brief Boolean indicating whether we run a cont. adjoint problem */
   bool frozen_visc;          /*!< \brief Boolean indicating whether frozen viscosity/turbulence is used. */
-  unsigned short turb_model; /*!< \brief The kind of turbulence model*/
+  TURB_MODEL turb_model;     /*!< \brief The kind of turbulence model*/
 
 public:
 

SU2_CFD/include/output/CAdjFlowIncOutput.hpp

@@ -37,7 +37,7 @@
 class CAdjFlowIncOutput final: public COutput {
 private:
 
-  unsigned short turb_model; /*!< \brief The kind of turbulence model*/
+  TURB_MODEL turb_model;     /*!< \brief The kind of turbulence model*/
   RADIATION_MODEL rad_model; /*!< \brief The kind of radiation model */
   bool heat;                 /*!< \brief Boolean indicating whether have a heat problem*/
   bool weakly_coupled_heat;  /*!< \brief Boolean indicating whether have a weakly coupled heat equation*/

SU2_CFD/include/output/CFlowCompFEMOutput.hpp

@@ -39,7 +39,7 @@ class CVariable;
 class CFlowCompFEMOutput final: public CFlowOutput {
 private:
 
-  unsigned short turb_model; //!< Kind of turbulence model
+  TURB_MODEL turb_model; //!< Kind of turbulence model
 
 public:
 

SU2_CFD/include/output/CFlowCompOutput.hpp

@@ -39,7 +39,7 @@ class CVariable;
 class CFlowCompOutput final: public CFlowOutput {
 private:
 
-  unsigned short turb_model; //!< Kind of turbulence model
+  TURB_MODEL turb_model; //!< Kind of turbulence model
 
 public:
 

SU2_CFD/include/output/CFlowIncOutput.hpp

@@ -39,7 +39,7 @@ class CVariable;
 class CFlowIncOutput final: public CFlowOutput {
 private:
 
-  unsigned short turb_model; /*!< \brief The kind of turbulence model*/
+  TURB_MODEL turb_model;     /*!< \brief The kind of turbulence model*/
   bool heat;                 /*!< \brief Boolean indicating whether have a heat problem*/
   bool weakly_coupled_heat;  /*!< \brief Boolean indicating whether have a weakly coupled heat equation*/
   unsigned short streamwisePeriodic;   /*!< \brief Boolean indicating whether it is a streamwise periodic simulation. */

SU2_CFD/include/output/CNEMOCompOutput.hpp

@@ -38,9 +38,9 @@ class CVariable;
 class CNEMOCompOutput final: public CFlowOutput {
 private:
 
-  unsigned short turb_model, /*!< \brief Kind of turbulence model */
-                 iSpecies,   /*!< \brief Species index */
-                 nSpecies;   /*!< \brief Number of species */
+  TURB_MODEL turb_model;   /*!< \brief Kind of turbulence model */
+  unsigned short iSpecies, /*!< \brief Species index */
+                 nSpecies; /*!< \brief Number of species */
 public:
 
   /*!