[WIP] Inconsistencies and improvements to SST model

Common/include/CConfig.hpp

@@ -876,6 +876,7 @@ class CConfig {
   array<su2double, N_POLY_COEFFS> MuPolyCoefficientsND{{0.0}};  /*!< \brief Definition of the non-dimensional temperature polynomial coefficients for viscosity. */
   array<su2double, N_POLY_COEFFS> KtPolyCoefficientsND{{0.0}};  /*!< \brief Definition of the non-dimensional temperature polynomial coefficients for thermal conductivity. */
   su2double TurbIntensityAndViscRatioFreeStream[2]; /*!< \brief Freestream turbulent intensity and viscosity ratio for turbulence and transition models. */
+
   su2double Energy_FreeStream,     /*!< \brief Free-stream total energy of the fluid.  */
   ModVel_FreeStream,               /*!< \brief Magnitude of the free-stream velocity of the fluid.  */
   ModVel_FreeStreamND,             /*!< \brief Non-dimensional magnitude of the free-stream velocity of the fluid.  */
@@ -1178,6 +1179,8 @@ class CConfig {
   nHistoryOutput, nVolumeOutput;  /*!< \brief Number of variables printed to the history file. */
   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. */
+  su2double prodLimConst;
+  su2double LDomain;
   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 */
@@ -9781,6 +9784,9 @@ class CConfig {
    */
   SST_ParsedOptions GetSSTParsedOptions() const { return sstParsedOptions; }
 
+  su2double GetProdLimConst() const { return prodLimConst; }
+  su2double GetLDomain() const { return LDomain; }
+
   /*!
    * \brief Get parsed SA option data structure.
    * \return SA option data structure.

Common/include/option_structure.hpp

@@ -983,33 +983,40 @@ inline TURB_FAMILY TurbModelFamily(TURB_MODEL model) {
  * \brief SST Options
  */
 enum class SST_OPTIONS {
-  NONE,        /*!< \brief No SST Turb model. */
-  V1994,       /*!< \brief 1994 Menter k-w SST model. */
-  V2003,       /*!< \brief 2003 Menter k-w SST model. */
-  V1994m,      /*!< \brief 1994m Menter k-w SST model. */
-  V2003m,      /*!< \brief 2003m Menter k-w SST model. */
-  SUST,        /*!< \brief Menter k-w SST model with sustaining terms. */
-  V,           /*!< \brief Menter k-w SST model with vorticity production terms. */
-  KL,          /*!< \brief Menter k-w SST model with Kato-Launder production terms. */
-  UQ,          /*!< \brief Menter k-w SST model with uncertainty quantification modifications. */
-  COMP_Wilcox, /*!< \brief Menter k-w SST model with Compressibility correction of Wilcox. */
-  COMP_Sarkar, /*!< \brief Menter k-w SST model with Compressibility correction of Sarkar. */
-  DLL,         /*!< \brief Menter k-w SST model with dimensionless lower limit clipping of turbulence variables. */
+  NONE,          /*!< \brief No SST Turb model. */
+  V1994,         /*!< \brief 1994 Menter k-w SST model. */
+  V2003,         /*!< \brief 2003 Menter k-w SST model. */
+  V1994m,        /*!< \brief 1994m Menter k-w SST model. */
+  V2003m,        /*!< \brief 2003m Menter k-w SST model. */
+  SUST,          /*!< \brief Menter k-w SST model with sustaining terms. */
+  V,             /*!< \brief Menter k-w SST model with vorticity production terms. */
+  KL,            /*!< \brief Menter k-w SST model with Kato-Launder production terms. */
+  UQ,            /*!< \brief Menter k-w SST model with uncertainty quantification modifications. */
+  COMP_Wilcox,   /*!< \brief Menter k-w SST model with Compressibility correction of Wilcox. */
+  COMP_Sarkar,   /*!< \brief Menter k-w SST model with Compressibility correction of Sarkar. */
+  COMP_ShuzHoff, /*!< \brief Menter k-w SST model with Compressibility correction of Shuzen and Hoffmann. */
+  DLL,           /*!< \brief Menter k-w SST model with dimensionless lower limit clipping of turbulence variables. */
+  FULLPROD,      /*!< \brief Menter k-w SST model with full production term. */
+  PRODLIM,       /*!< \brief Menter k-w SST model with user-defined production limiter constant. */
+  NEWBC,         /*!< \brief Menter k-w SST model with new boundary conditions. */
 };
 static const MapType<std::string, SST_OPTIONS> SST_Options_Map = {
   MakePair("NONE", SST_OPTIONS::NONE)
   MakePair("V1994m", SST_OPTIONS::V1994m)
   MakePair("V2003m", SST_OPTIONS::V2003m)
-  /// TODO: For now we do not support "unmodified" versions of SST.
-  //MakePair("V1994", SST_OPTIONS::V1994)
-  //MakePair("V2003", SST_OPTIONS::V2003)
+  MakePair("V1994", SST_OPTIONS::V1994)
+  MakePair("V2003", SST_OPTIONS::V2003)
   MakePair("SUSTAINING", SST_OPTIONS::SUST)
   MakePair("VORTICITY", SST_OPTIONS::V)
   MakePair("KATO-LAUNDER", SST_OPTIONS::KL)
   MakePair("UQ", SST_OPTIONS::UQ)
   MakePair("COMPRESSIBILITY-WILCOX", SST_OPTIONS::COMP_Wilcox)
   MakePair("COMPRESSIBILITY-SARKAR", SST_OPTIONS::COMP_Sarkar)
+  MakePair("COMPRESSIBILITY-SH", SST_OPTIONS::COMP_ShuzHoff)
   MakePair("DIMENSIONLESS_LIMIT", SST_OPTIONS::DLL)
+  MakePair("FULLPROD", SST_OPTIONS::FULLPROD)
+  MakePair("PRODLIM", SST_OPTIONS::PRODLIM)
+  MakePair("NEWBC", SST_OPTIONS::NEWBC)
 };
 
 /*!
@@ -1023,7 +1030,11 @@ struct SST_ParsedOptions {
   bool modified = false;                      /*!< \brief Bool for modified (m) SST model. */
   bool compWilcox = false;                    /*!< \brief Bool for compressibility correction of Wilcox. */
   bool compSarkar = false;                    /*!< \brief Bool for compressibility correction of Sarkar. */
+  bool compSH = false;                    /*!< \brief Bool for compressibility correction of Shuzen and Hoffmann. */
   bool dll = false;                           /*!< \brief Bool dimensionless lower limit. */
+  bool fullProd = false;                      /*!< \brief Bool for full production term. */
+  bool prodLim = false;                       /*!< \brief Bool for user-defined production limiter constant. */
+  bool newBC = false;                         /*!< \brief Bool for new boundary conditions. */
 };
 
 /*!
@@ -1041,6 +1052,10 @@ inline SST_ParsedOptions ParseSSTOptions(const SST_OPTIONS *SST_Options, unsigne
     return std::find(SST_Options, sst_options_end, option) != sst_options_end;
   };
 
+  const bool found_fullProd = IsPresent(SST_OPTIONS::FULLPROD);
+  const bool found_prodLim = IsPresent(SST_OPTIONS::PRODLIM);
+  const bool found_newBC = IsPresent(SST_OPTIONS::NEWBC);
+
   const bool found_1994 = IsPresent(SST_OPTIONS::V1994);
   const bool found_2003 = IsPresent(SST_OPTIONS::V2003);
   const bool found_1994m = IsPresent(SST_OPTIONS::V1994m);
@@ -1061,6 +1076,7 @@ inline SST_ParsedOptions ParseSSTOptions(const SST_OPTIONS *SST_Options, unsigne
   const bool sst_uq = IsPresent(SST_OPTIONS::UQ);
   const bool sst_compWilcox = IsPresent(SST_OPTIONS::COMP_Wilcox);
   const bool sst_compSarkar = IsPresent(SST_OPTIONS::COMP_Sarkar);
+  const bool sst_compSH = IsPresent(SST_OPTIONS::COMP_ShuzHoff);
   const bool sst_dll = IsPresent(SST_OPTIONS::DLL);
 
   if (sst_1994 && sst_2003) {
@@ -1083,21 +1099,27 @@ inline SST_ParsedOptions ParseSSTOptions(const SST_OPTIONS *SST_Options, unsigne
   }
 
   // Parse compressibility options
-  if (sst_compWilcox && sst_compSarkar) {
+  if (sst_compWilcox + sst_compSarkar + sst_compSH > 1) {
     SU2_MPI::Error("Please select only one compressibility correction (COMPRESSIBILITY-WILCOX or COMPRESSIBILITY-SARKAR).", CURRENT_FUNCTION);
   } else if (sst_compWilcox) {
     SSTParsedOptions.production = SST_OPTIONS::COMP_Wilcox;
   } else if (sst_compSarkar) {
     SSTParsedOptions.production = SST_OPTIONS::COMP_Sarkar;
+  } else if (sst_compSH) {
+    SSTParsedOptions.production = SST_OPTIONS::COMP_ShuzHoff;
   }
 
   SSTParsedOptions.sust = sst_sust;
   SSTParsedOptions.modified = sst_m;
   SSTParsedOptions.uq = sst_uq;
   SSTParsedOptions.compWilcox = sst_compWilcox;
   SSTParsedOptions.compSarkar = sst_compSarkar;
+  SSTParsedOptions.compSH = sst_compSH;
   SSTParsedOptions.dll = sst_dll;
 
+  SSTParsedOptions.fullProd = found_fullProd;
+  SSTParsedOptions.prodLim = found_prodLim;
+  SSTParsedOptions.newBC = found_newBC;
   return SSTParsedOptions;
 }
 

Common/src/CConfig.cpp

@@ -1122,6 +1122,9 @@ void CConfig::SetConfig_Options() {
   /*!\brief SST_OPTIONS \n DESCRIPTION: Specify SA turbulence model options/corrections. \n Options: see \link SA_Options_Map \endlink \n DEFAULT: NONE \ingroup Config*/
   addEnumListOption("SA_OPTIONS", nSA_Options, SA_Options, SA_Options_Map);
 
+  addDoubleOption("PROD_LIM_CONST", prodLimConst, 20.0);
+  addDoubleOption("L_DOMAIN", LDomain, 1.0);
+
   /*!\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*/
@@ -6307,6 +6310,9 @@ void CConfig::SetOutput(SU2_COMPONENT val_software, unsigned short val_izone) {
             else cout << "\nusing default hard coded lower limit clipping";
 
             cout << "." << endl;
+
+            if (sstParsedOptions.prodLim) cout << "Changing the value of the TKE production limiter constant to " << prodLimConst << endl;
+
             break;
         }
         switch (Kind_Trans_Model) {

SU2_CFD/include/numerics/CNumerics.hpp

@@ -190,6 +190,8 @@ class CNumerics {
 
   bool bounded_scalar = false;    /*!< \brief Flag for bounded scalar problem */
 
+  su2double ProdDistr[5];
+
 public:
   /*!
    * \brief Return type used in some "ComputeResidual" overloads to give a
@@ -1605,6 +1607,8 @@ class CNumerics {
    * \return is_bounded_scalar : scalar solver uses bounded scalar convective transport
    */
   inline bool GetBoundedScalar() const { return bounded_scalar;}
+
+  inline su2double GetProdDest(int index) const {return ProdDistr[index];}
 };
 
 /*!

SU2_CFD/include/numerics/turbulent/turb_sources.hpp

@@ -657,6 +657,8 @@
   /*--- Ambient values for SST-SUST. ---*/
   const su2double kAmb, omegaAmb;
 
+  su2double Pk, Dk, Pw, Dw;
+
   su2double F1_i, F2_i, CDkw_i;
   su2double Residual[2];
   su2double* Jacobian_i[2];
@@ -829,6 +831,8 @@
       su2double P_Base = 0;
       su2double zetaFMt = 0.0;
       const su2double Mt = sqrt(2.0 * ScalarVar_i[0]) / V_i[idx.SoundSpeed()];
+      su2double PDTerm = 0.0;
+      const su2double alpha1 = 1.0;
 
       /*--- Apply production term modifications ---*/
       switch (sstParsedOptions.production) {
@@ -860,6 +864,25 @@
           }
           break;
 
+        case SST_OPTIONS::COMP_ShuzHoff:{
+
+          // su2double MeanReynoldsStress[3][3];
+          // ComputeStressTensor(nDim, MeanReynoldsStress, PrimVar_Grad_i + idx.Velocity(), Eddy_Viscosity_i, 
+          //                     Density_i, ScalarVar_i[0]);
+
+          // for (size_t iDim = 0.0; iDim < nDim; iDim++){
+          //   for (size_t jDim = 0.0; jDim < nDim; jDim++){
+          //     PDTerm += MeanReynoldsStress[iDim][jDim] * PrimVar_Grad_i[idx.Velocity() + iDim][jDim];
+          //   }
+          // }
+          // PDTerm = (-alpha2*PDTerm + alpha3 * epsilon * Density_i)*Mt*Mt;
+
+          zetaFMt = alpha1 * Mt*Mt * (1-F1_i);
+
+          P_Base = StrainMag_i;
+        }
+          break;
+
         default:
           /*--- Base production term for SST-1994 and SST-2003 ---*/
           P_Base = StrainMag_i;
@@ -870,15 +893,28 @@
       const su2double prod_limit = prod_lim_const * beta_star * Density_i * ScalarVar_i[1] * ScalarVar_i[0];
 
       su2double P = Eddy_Viscosity_i * pow(P_Base, 2);
+      if (sstParsedOptions.fullProd) P -= Eddy_Viscosity_i * diverg*diverg * 2.0/3.0;
+      if (!sstParsedOptions.modified) P -= Density_i * ScalarVar_i[0] * diverg * 2.0/3.0;
+
+      su2double PLim = 0.0;
+      if ( P > prod_limit ) PLim = 1.0;
       su2double pk = max(0.0, min(P, prod_limit));
 
-      const auto& eddy_visc_var = sstParsedOptions.version == SST_OPTIONS::V1994 ? VorticityMag : StrainMag_i;
+      if (sstParsedOptions.production == SST_OPTIONS::COMP_ShuzHoff) {
+        const su2double alpha2 = 0.4;
+        const su2double alpha3 = 0.2;
+        const su2double epsilon = beta_star * ScalarVar_i[1] * ScalarVar_i[0];
+
+        PDTerm = (-alpha2*pk + alpha3*Density_i*epsilon)*Mt*Mt;
+      }
+
+      const su2double eddy_visc_var = sstParsedOptions.version == SST_OPTIONS::V1994 ? VorticityMag : StrainMag_i;
       const su2double zeta = max(ScalarVar_i[1], eddy_visc_var * F2_i / a1);
 
       /*--- Production limiter only for V2003, recompute for V1994. ---*/
       su2double pw;
       if (sstParsedOptions.version == SST_OPTIONS::V1994) {
-        pw = alfa_blended * Density_i * pow(P_Base, 2);
+        pw = alfa_blended * Density_i * P / Eddy_Viscosity_i;
       } else {
         pw = (alfa_blended * Density_i / Eddy_Viscosity_i) * pk;
       }
@@ -901,10 +937,14 @@
         pk += Dilatation_Sarkar;
       }
 
+      if (sstParsedOptions.production == SST_OPTIONS::COMP_ShuzHoff) {
+        pk += (1-F1_i)*PDTerm;
+      }
+
       /*--- Dissipation ---*/
 
       su2double dk = beta_star * Density_i * ScalarVar_i[1] * ScalarVar_i[0] * (1.0 + zetaFMt);
-      su2double dw = beta_blended * Density_i * ScalarVar_i[1] * ScalarVar_i[1] * (1.0 - 0.09/beta_blended * zetaFMt);
+      su2double dw = beta_blended * Density_i * ScalarVar_i[1] * ScalarVar_i[1] * (1.0 - beta_star/beta_blended * zetaFMt);
 
       /*--- LM model coupling with production and dissipation term for k transport equation---*/
       if (config->GetKind_Trans_Model() == TURB_TRANS_MODEL::LM) {
@@ -913,18 +953,27 @@
       }
 
       /*--- Add the production terms to the residuals. ---*/
+      Pk = pk;
+      Pw = pw;
 
       Residual[0] += pk * Volume;
       Residual[1] += pw * Volume;
 
       /*--- Add the dissipation  terms to the residuals.---*/
+      Dk = dk;
+      Dw = dw;
 
       Residual[0] -= dk * Volume;
       Residual[1] -= dw * Volume;
 
-      /*--- Cross diffusion ---*/
+      ProdDistr[0] = Pk;
+      ProdDistr[1] = Dk;
+      ProdDistr[2] = Pw;
+      ProdDistr[3] = Dw;
+      ProdDistr[4] = PLim;
 
-      Residual[1] += (1.0 - F1_i) * CDkw_i * Volume;
+      /*--- Cross diffusion ---*/
+      Residual[1] += (1.0 - F1_i) * (CDkw_i - PDTerm / Eddy_Viscosity_i) * Volume;
 
       /*--- Contribution due to 2D axisymmetric formulation ---*/
 
@@ -933,6 +982,7 @@
       /*--- Implicit part ---*/
 
       Jacobian_i[0][0] = -beta_star * ScalarVar_i[1] * Volume * (1.0 + zetaFMt);
+      if (!sstParsedOptions.modified) Jacobian_i[0][0] -= diverg * Volume*2.0/3.0;
       Jacobian_i[0][1] = -beta_star * ScalarVar_i[0] * Volume * (1.0 + zetaFMt);
       Jacobian_i[1][0] = 0.0;
       Jacobian_i[1][1] = -2.0 * beta_blended * ScalarVar_i[1] * Volume * (1.0 - 0.09/beta_blended * zetaFMt);

SU2_CFD/include/numerics_simd/flow/convection/centered.hpp

@@ -53,6 +53,8 @@ class CCenteredBase : public Base {
   const bool dynamicGrid;
   const su2double stretchParam = 0.3;
 
+  using Base::turbVars;
+
   /*!
    * \brief Constructor, store some constants and forward args to base.
    */
@@ -96,6 +98,8 @@ class CCenteredBase : public Base {
     const bool implicit = (config.GetKind_TimeIntScheme() == EULER_IMPLICIT);
     const auto& solution = static_cast<const CEulerVariable&>(solution_);
 
+    const bool tkeNeeded = config.GetKind_Turb_Model() == TURB_MODEL::SST;
+
     const auto iPoint = geometry.edges->GetNode(iEdge,0);
     const auto jPoint = geometry.edges->GetNode(iEdge,1);
 
@@ -119,6 +123,13 @@ class CCenteredBase : public Base {
       avgV.all(iVar) = 0.5 * (V.i.all(iVar) + V.j.all(iVar));
     }
 
+    if (tkeNeeded) {
+      V.i.allTurb = gatherVariables<1>(iPoint, turbVars->GetSolution());
+      V.j.allTurb = gatherVariables<1>(jPoint, turbVars->GetSolution());
+
+      avgV.allTurb(0) = 0.5*(V.i.allTurb(0)+V.j.allTurb(0));
+    }
+
     /*--- Compute conservative variables. ---*/
 
     CPair<CCompressibleConservatives<nDim> > U;

SU2_CFD/include/numerics_simd/flow/convection/common.hpp

@@ -113,7 +113,8 @@ FORCEINLINE CPair<ReconVarType> reconstructPrimitives(Int iEdge, Int iPoint, Int
                                                       bool muscl, LIMITER limiterType,
                                                       const CPair<PrimVarType>& V1st,
                                                       const VectorDbl<nDim>& vector_ij,
-                                                      const VariableType& solution) {
+                                                      const VariableType& solution,
+                                                      const bool tkeNeeded) {
   static_assert(ReconVarType::nVar <= PrimVarType::nVar,"");
 
   const auto& gradients = solution.GetGradient_Reconstruction();
@@ -125,6 +126,11 @@ FORCEINLINE CPair<ReconVarType> reconstructPrimitives(Int iEdge, Int iPoint, Int
     V.i.all(iVar) = V1st.i.all(iVar);
     V.j.all(iVar) = V1st.j.all(iVar);
   }
+  // Only first order for turbulence
+  if (tkeNeeded) {
+    V.i.allTurb(0) = V1st.i.allTurb(0);
+    V.j.allTurb(0) = V1st.j.allTurb(0);
+  }
 
   if (muscl) {
     /*--- Recompute density and enthalpy instead of reconstructing. ---*/