Merge pull request #1810 from su2code/feature_LM2015_model

Implementation of LM model for SA and cross-flow corrections (LM2015)

Author: pcarruscag

Common/include/CConfig.hpp

@@ -589,6 +589,8 @@ class CConfig {
   SPECIES_MODEL Kind_Species_Model; /*!< \brief Species model definition. */
   TURB_SGS_MODEL Kind_SGS_Model;    /*!< \brief LES SGS model definition. */
   TURB_TRANS_MODEL Kind_Trans_Model;  /*!< \brief Transition model definition. */
+  TURB_TRANS_CORRELATION Kind_Trans_Correlation;  /*!< \brief Transition correlation model definition. */
+  su2double hRoughness;             /*!< \brief RMS roughness for Transition model. */
   unsigned short Kind_ActDisk, Kind_Engine_Inflow,
   *Kind_Data_Riemann,
   *Kind_Data_Giles;                /*!< \brief Kind of inlet boundary treatment. */
@@ -715,8 +717,10 @@ class CConfig {
   string *Config_Filenames;           /*!< \brief List of names for configuration files. */
   SST_OPTIONS *SST_Options;           /*!< \brief List of modifications/corrections/versions of SST turbulence model.*/
   SA_OPTIONS *SA_Options;             /*!< \brief List of modifications/corrections/versions of SA turbulence model.*/
+  LM_OPTIONS *LM_Options;             /*!< \brief List of modifications/corrections/versions of SA turbulence model.*/
   unsigned short nSST_Options;        /*!< \brief Number of SST options specified. */
   unsigned short nSA_Options;         /*!< \brief Number of SA options specified. */
+  unsigned short nLM_Options;         /*!< \brief Number of SA options specified. */
   WALL_FUNCTIONS  *Kind_WallFunctions;        /*!< \brief The kind of wall function to use for the corresponding markers. */
   unsigned short  **IntInfo_WallFunctions;    /*!< \brief Additional integer information for the wall function markers. */
   su2double       **DoubleInfo_WallFunctions; /*!< \brief Additional double information for the wall function markers. */
@@ -1155,6 +1159,7 @@ class CConfig {
   bool Multizone_Residual;        /*!< \brief Determines if memory should be allocated for the multizone residual. */
   SST_ParsedOptions sstParsedOptions; /*!< \brief Additional parameters for the SST turbulence model. */
   SA_ParsedOptions saParsedOptions;   /*!< \brief Additional parameters for the SA turbulence model. */
+  LM_ParsedOptions lmParsedOptions;   /*!< \brief Additional parameters for the LM transition model. */
   su2double uq_delta_b;         /*!< \brief Parameter used to perturb eigenvalues of Reynolds Stress Matrix */
   unsigned short eig_val_comp;  /*!< \brief Parameter used to determine type of eigenvalue perturbation */
   su2double uq_urlx;            /*!< \brief Under-relaxation factor */
@@ -4316,6 +4321,18 @@ class CConfig {
    */
   TURB_TRANS_MODEL GetKind_Trans_Model(void) const { return Kind_Trans_Model; }
 
+  /*!
+   * \brief Get the kind of the transition correlations.
+   * \return Kind of the transition correlation.
+   */
+  TURB_TRANS_CORRELATION GetKind_Trans_Correlation(void) const { return Kind_Trans_Correlation; }
+
+  /*!
+   * \brief Get RMS roughness for Transtion model from config
+   * \return Value of roughness.
+   */
+  su2double GethRoughness(void) const { return hRoughness; }
+  
   /*!
    * \brief Get the kind of the species model.
    * \return Kind of the species model.
@@ -9685,4 +9702,10 @@ class CConfig {
    */
   SA_ParsedOptions GetSAParsedOptions() const { return saParsedOptions; }
 
+  /*!
+   * \brief Get parsed LM option data structure.
+   * \return LM option data structure.
+   */
+  LM_ParsedOptions GetLMParsedOptions() const { return lmParsedOptions; }
+
 };

Common/include/option_structure.hpp

@@ -1182,6 +1182,119 @@ static const MapType<std::string, TURB_TRANS_MODEL> Trans_Model_Map = {
   MakePair("LM", TURB_TRANS_MODEL::LM)
 };
 
+/*!
+ * \brief LM Options
+ */
+enum class LM_OPTIONS {
+  NONE,         /*!< \brief No option / default. */
+  LM2015,       /*!< \brief Cross-flow corrections. */
+  MALAN,        /*!< \brief Kind of transition correlation model (Malan). */
+  SULUKSNA,     /*!< \brief Kind of transition correlation model (Suluksna). */
+  KRAUSE,       /*!< \brief Kind of transition correlation model (Krause). */
+  KRAUSE_HYPER, /*!< \brief Kind of transition correlation model (Krause hypersonic). */
+  MEDIDA_BAEDER,/*!< \brief Kind of transition correlation model (Medida-Baeder). */
+  MEDIDA,       /*!< \brief Kind of transition correlation model (Medida). */
+  MENTER_LANGTRY,   /*!< \brief Kind of transition correlation model (Menter-Langtry). */
+  DEFAULT       /*!< \brief Kind of transition correlation model (Menter-Langtry if SST, MALAN if SA). */
+};
+
+static const MapType<std::string, LM_OPTIONS> LM_Options_Map = {
+  MakePair("NONE", LM_OPTIONS::NONE)
+  MakePair("LM2015", LM_OPTIONS::LM2015)
+  MakePair("MALAN", LM_OPTIONS::MALAN)
+  MakePair("SULUKSNA", LM_OPTIONS::SULUKSNA)
+  MakePair("KRAUSE", LM_OPTIONS::KRAUSE)
+  MakePair("KRAUSE_HYPER", LM_OPTIONS::KRAUSE_HYPER)
+  MakePair("MEDIDA_BAEDER", LM_OPTIONS::MEDIDA_BAEDER)
+  MakePair("MENTER_LANGTRY", LM_OPTIONS::MENTER_LANGTRY)
+  MakePair("DEFAULT", LM_OPTIONS::DEFAULT)
+};
+
+/*!
+ * \brief Types of transition correlations
+ */
+enum class TURB_TRANS_CORRELATION {
+  MALAN,        /*!< \brief Kind of transition correlation model (Malan). */
+  SULUKSNA,     /*!< \brief Kind of transition correlation model (Suluksna). */
+  KRAUSE,       /*!< \brief Kind of transition correlation model (Krause). */
+  KRAUSE_HYPER, /*!< \brief Kind of transition correlation model (Krause hypersonic). */
+  MEDIDA_BAEDER,/*!< \brief Kind of transition correlation model (Medida-Baeder). */
+  MEDIDA,       /*!< \brief Kind of transition correlation model (Medida). */
+  MENTER_LANGTRY,   /*!< \brief Kind of transition correlation model (Menter-Langtry). */
+  DEFAULT       /*!< \brief Kind of transition correlation model (Menter-Langtry if SST, MALAN if SA). */
+};
+
+/*!
+ * \brief Structure containing parsed LM options.
+ */
+struct LM_ParsedOptions {
+  LM_OPTIONS version = LM_OPTIONS::NONE;  /*!< \brief LM base model. */
+  bool LM2015 = false;                    /*!< \brief Use cross-flow corrections. */
+  TURB_TRANS_CORRELATION Correlation = TURB_TRANS_CORRELATION::DEFAULT;
+};
+
+/*!
+ * \brief Function to parse LM options.
+ * \param[in] LM_Options - Selected LM option from config.
+ * \param[in] nLM_Options - Number of options selected.
+ * \param[in] rank - MPI rank.
+ * \return Struct with SA options.
+ */
+inline LM_ParsedOptions ParseLMOptions(const LM_OPTIONS *LM_Options, unsigned short nLM_Options, int rank, TURB_MODEL Kind_Turb_Model) {
+  LM_ParsedOptions LMParsedOptions;
+
+  auto IsPresent = [&](LM_OPTIONS option) {
+    const auto lm_options_end = LM_Options + nLM_Options;
+    return std::find(LM_Options, lm_options_end, option) != lm_options_end;
+  };
+
+  LMParsedOptions.LM2015 = IsPresent(LM_OPTIONS::LM2015);
+  
+  int NFoundCorrelations = 0;
+  if (IsPresent(LM_OPTIONS::MALAN)) {
+    LMParsedOptions.Correlation = TURB_TRANS_CORRELATION::MALAN;
+    NFoundCorrelations++;
+  }
+  if (IsPresent(LM_OPTIONS::SULUKSNA)) {
+    LMParsedOptions.Correlation = TURB_TRANS_CORRELATION::SULUKSNA;
+    NFoundCorrelations++;
+  }
+  if (IsPresent(LM_OPTIONS::KRAUSE)) {
+    LMParsedOptions.Correlation = TURB_TRANS_CORRELATION::KRAUSE;
+    NFoundCorrelations++;
+  }
+  if (IsPresent(LM_OPTIONS::KRAUSE_HYPER)) {
+    LMParsedOptions.Correlation = TURB_TRANS_CORRELATION::KRAUSE_HYPER;
+    NFoundCorrelations++;
+  }
+  if (IsPresent(LM_OPTIONS::MEDIDA_BAEDER)) {
+    LMParsedOptions.Correlation = TURB_TRANS_CORRELATION::MEDIDA_BAEDER;
+    NFoundCorrelations++;
+  }
+  if (IsPresent(LM_OPTIONS::MEDIDA)) {
+    LMParsedOptions.Correlation = TURB_TRANS_CORRELATION::MEDIDA;
+    NFoundCorrelations++;
+  }
+  if (IsPresent(LM_OPTIONS::MENTER_LANGTRY)) {
+    LMParsedOptions.Correlation = TURB_TRANS_CORRELATION::MENTER_LANGTRY;
+    NFoundCorrelations++;
+  }
+
+  if (NFoundCorrelations > 1) {
+    SU2_MPI::Error("Two correlations selected for LM_OPTIONS. Please choose only one.", CURRENT_FUNCTION);
+  }
+
+  if (LMParsedOptions.Correlation == TURB_TRANS_CORRELATION::DEFAULT){
+    if (Kind_Turb_Model == TURB_MODEL::SST) {
+      LMParsedOptions.Correlation = TURB_TRANS_CORRELATION::MENTER_LANGTRY;
+    } else if (Kind_Turb_Model == TURB_MODEL::SA) {
+      LMParsedOptions.Correlation = TURB_TRANS_CORRELATION::MALAN;
+    }
+  }
+
+  return LMParsedOptions;
+}
+
 /*!
  * \brief types of species transport models
  */

Common/src/CConfig.cpp

@@ -1103,6 +1103,10 @@ void CConfig::SetConfig_Options() {
 
   /*!\brief KIND_TRANS_MODEL \n DESCRIPTION: Specify transition model OPTIONS: see \link Trans_Model_Map \endlink \n DEFAULT: NONE \ingroup Config*/
   addEnumOption("KIND_TRANS_MODEL", Kind_Trans_Model, Trans_Model_Map, TURB_TRANS_MODEL::NONE);
+  /*!\brief SST_OPTIONS \n DESCRIPTION: Specify LM transition model options/correlations. \n Options: see \link LM_Options_Map \endlink \n DEFAULT: NONE \ingroup Config*/
+  addEnumListOption("LM_OPTIONS", nLM_Options, LM_Options, LM_Options_Map);
+  /*!\brief HROUGHNESS \n DESCRIPTION: Value of RMS roughness for transition model \n DEFAULT: 1E-6 \ingroup Config*/
+  addDoubleOption("HROUGHNESS", hRoughness, 1e-6);
 
   /*!\brief KIND_SCALAR_MODEL \n DESCRIPTION: Specify scalar transport model \n Options: see \link Scalar_Model_Map \endlink \n DEFAULT: NONE \ingroup Config*/
   addEnumOption("KIND_SCALAR_MODEL", Kind_Species_Model, Species_Model_Map, SPECIES_MODEL::NONE);
@@ -3455,6 +3459,16 @@ void CConfig::SetPostprocessing(SU2_COMPONENT val_software, unsigned short val_i
     SU2_MPI::Error("Axisymmetry is currently only supported for KIND_TURB_MODEL chosen as SST", CURRENT_FUNCTION);
   }
 
+  /*--- Postprocess LM_OPTIONS into structure. ---*/
+  if (Kind_Trans_Model == TURB_TRANS_MODEL::LM) {
+    lmParsedOptions = ParseLMOptions(LM_Options, nLM_Options, rank, Kind_Turb_Model);
+
+    /*--- Check if problem is 2D and LM2015 has been selected ---*/
+    if (lmParsedOptions.LM2015 && val_nDim == 2) {
+      SU2_MPI::Error("LM2015 is available only for 3D problems", CURRENT_FUNCTION);
+    }
+  }
+
   /*--- Set the boolean Wall_Functions equal to true if there is a
    definition for the wall founctions ---*/
 
@@ -4748,10 +4762,6 @@ 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 != TURB_MODEL::SST) && Kind_Trans_Model == TURB_TRANS_MODEL::LM) {
-    SU2_MPI::Error("LM transition model currently only available in combination with SST turbulence model!", CURRENT_FUNCTION);
-  }
-
   if(Turb_Fixed_Values && !OptionIsSet("TURB_FIXED_VALUES_DOMAIN")){
     SU2_MPI::Error("TURB_FIXED_VALUES activated, but no domain set with TURB_FIXED_VALUES_DOMAIN.", CURRENT_FUNCTION);
   }
@@ -6082,7 +6092,35 @@ void CConfig::SetOutput(SU2_COMPONENT val_software, unsigned short val_izone) {
         }
         switch (Kind_Trans_Model) {
           case TURB_TRANS_MODEL::NONE:  break;
-          case TURB_TRANS_MODEL::LM:    cout << "Transition model: Langtry and Menter's 4 equation model (2009)" << endl; break;
+          case TURB_TRANS_MODEL::LM: {
+            cout << "Transition model: Langtry and Menter's 4 equation model"; 
+            if (lmParsedOptions.LM2015) {
+              cout << " w/ cross-flow corrections (2015)" << endl;
+            } else {
+              cout << " (2009)" << endl;
+            }
+            break; 
+          }          
+        }
+        if (Kind_Trans_Model == TURB_TRANS_MODEL::LM) {
+
+          cout << "Correlation Functions: ";
+          switch (lmParsedOptions.Correlation) {
+            case TURB_TRANS_CORRELATION::MALAN: cout << "Malan et al. (2009)" << endl;  break;
+            case TURB_TRANS_CORRELATION::SULUKSNA: cout << "Suluksna et al. (2009)" << endl;  break;
+            case TURB_TRANS_CORRELATION::KRAUSE: cout << "Krause et al. (2008)" << endl;  break;
+            case TURB_TRANS_CORRELATION::KRAUSE_HYPER: cout << "Krause et al. (2008, paper)" << endl;  break;
+            case TURB_TRANS_CORRELATION::MEDIDA_BAEDER: cout << "Medida and Baeder (2011)" << endl;  break;
+            case TURB_TRANS_CORRELATION::MEDIDA: cout << "Medida PhD (2014)" << endl;  break;
+            case TURB_TRANS_CORRELATION::MENTER_LANGTRY: cout << "Menter and Langtry (2009)" << endl;  break;
+            case TURB_TRANS_CORRELATION::DEFAULT: 
+              switch (Kind_Turb_Model) {
+                case TURB_MODEL::SA: cout << "Malan et al. (2009)" << endl;  break;
+                case TURB_MODEL::SST: cout << "Menter and Langtry (2009)" << endl;  break;
+                case TURB_MODEL::NONE: SU2_MPI::Error("No turbulence model has been selected but LM transition model is active.", CURRENT_FUNCTION); break;
+              }
+              break;
+          }
         }
         cout << "Hybrid RANS/LES: ";
         switch (Kind_HybridRANSLES) {

SU2_CFD/include/numerics/CNumerics.hpp

@@ -83,7 +83,8 @@ class CNumerics {
   turb_ke_i,  /*!< \brief Turbulent kinetic energy at point i. */
   turb_ke_j;  /*!< \brief Turbulent kinetic energy at point j. */
   su2double
-  intermittency_eff_i;  /*!< \brief effective intermittency at point i. */
+  intermittency_eff_i, /*!< \brief effective intermittency at point i. */
+  intermittency_i; /*!< \brief intermittency at point i. */
   su2double
   Pressure_i,  /*!< \brief Pressure at point i. */
   Pressure_j;  /*!< \brief Pressure at point j. */
@@ -157,6 +158,8 @@ class CNumerics {
   TurbPsi_Grad_j,  /*!< \brief Gradient of adjoint turbulent variables at point j. */
   AuxVar_Grad_i,   /*!< \brief Gradient of an auxiliary variable at point i. */
   AuxVar_Grad_j;   /*!< \brief Gradient of an auxiliary variable at point i. */
+  su2double 
+  LocalGridLength_i; /*!< \brief Local grid length at point i. */
   const su2double *RadVar_Source;  /*!< \brief Source term from the radiative heat transfer equation. */
   const su2double
   *Coord_i,      /*!< \brief Cartesians coordinates of point i. */
@@ -392,6 +395,14 @@ class CNumerics {
     TransVar_Grad_j = val_transvar_grad_j;
   }
 
+  /*!
+   * \brief Set the value of the turbulent variable.
+   * \param[in] val_transvar_i - Value of the turbulent variable at point i.
+   */
+  inline void SetLocalGridLength(const su2double val_localGridLength_i) {
+    LocalGridLength_i = val_localGridLength_i;
+  }
+
   /*!
    * \brief Set the value of the adjoint turbulent variable.
    * \param[in] val_turbpsivar_i - Value of the adjoint turbulent variable at point i.
@@ -711,6 +722,20 @@ class CNumerics {
     intermittency_eff_i = val_intermittency_eff_i;
   }
 
+  /*!
+   * \brief Set the value of the intermittency for the LM model.
+   * \param[in] intermittency_i - Value of the intermittency at point i.
+   */
+  void SetIntermittency(su2double val_intermittency_i) {
+    intermittency_i = val_intermittency_i;
+  }
+
+  /*!
+   * \brief Get the value of the effective intermittency for the transition model.
+   * \param[in] intermittency_eff_i - Value of the effective intermittency at point i.
+   */
+  su2double GetIntermittencyEff() const { return intermittency_eff_i; }
+
   /*!
    * \brief Set the gradient of the auxiliary variables.
    * \param[in] val_auxvar_grad_i - Gradient of the auxiliary variable at point i.