New Nonlinear Iteration Controller for Improved Fluid Solver Robustness & Convergence

.github/workflows/regression.yml

@@ -87,5 +87,5 @@ jobs:
       - name: Run Tests in Container
         uses: docker://su2code/test-su2:20191031
         with:
-          args: -b ${{github.ref}} -t develop -c develop -s ${{matrix.testscript}}
+          args: -b ${{github.ref}} -t release_v7.0.0 -c develop -s ${{matrix.testscript}}
 

Common/include/config_structure.hpp

@@ -1,4 +1,4 @@
-/*!
+/*!
  * \file config_structure.hpp
  * \brief All the information about the definition of the physical problem.
  *        The subroutines and functions are in the <i>config_structure.cpp</i> file.
@@ -479,6 +479,7 @@ class CConfig {
   *Kind_SurfaceMovement,           /*!< \brief Kind of the static mesh movement. */
   nKind_SurfaceMovement,           /*!< \brief Kind of the dynamic mesh movement. */
   Kind_Gradient_Method,		       /*!< \brief Numerical method for computation of spatial gradients. */
+  Kind_Gradient_Method_Recon,    /*!< \brief Numerical method for computation of spatial gradients used for upwind reconstruction. */
   Kind_Deform_Linear_Solver,             /*!< Numerical method to deform the grid */
   Kind_Deform_Linear_Solver_Prec,        /*!< \brief Preconditioner of the linear solver. */
   Kind_Linear_Solver,		             /*!< \brief Numerical solver for the implicit scheme. */
@@ -533,7 +534,9 @@ class CConfig {
   Kind_Matrix_Coloring,         /*!< \brief Type of matrix coloring for sparse Jacobian computation. */
   Kind_Solver_Fluid_FSI,		/*!< \brief Kind of solver for the fluid in FSI applications. */
   Kind_Solver_Struc_FSI,		/*!< \brief Kind of solver for the structure in FSI applications. */
-  Kind_BGS_RelaxMethod;			/*!< \brief Kind of relaxation method for Block Gauss Seidel method in FSI problems. */
+  Kind_BGS_RelaxMethod;				/*!< \brief Kind of relaxation method for Block Gauss Seidel method in FSI problems. */
+  bool ReconstructionGradientRequired; /*!< \brief Enable or disable a second gradient calculation for upwind reconstruction only. */
+  bool LeastSquaresRequired;  /*!< \brief Enable or disable memory allocation for least-squares gradient methods. */
   bool Energy_Equation;         /*!< \brief Solve the energy equation for incompressible flows. */
 
   bool MUSCL,		       /*!< \brief MUSCL scheme .*/
@@ -580,8 +583,6 @@ class CConfig {
   unsigned short Linear_Solver_ILU_n;		      /*!< \brief ILU fill=in level. */
   su2double SemiSpan;		          /*!< \brief Wing Semi span. */
   su2double Roe_Kappa;		          /*!< \brief Relaxation of the Roe scheme. */
-  su2double Relaxation_Factor_Flow;		/*!< \brief Relaxation coefficient of the linear solver mean flow. */
-  su2double Relaxation_Factor_Turb;		/*!< \brief Relaxation coefficient of the linear solver turbulence. */
   su2double Relaxation_Factor_AdjFlow;  /*!< \brief Relaxation coefficient of the linear solver adjoint mean flow. */
   su2double Relaxation_Factor_CHT;      /*!< \brief Relaxation coefficient for the update of conjugate heat variables. */
   su2double AdjTurb_Linear_Error;		/*!< \brief Min error of the turbulent adjoint linear solver for the implicit formulation. */
@@ -789,7 +790,6 @@ class CConfig {
   Wrt_Performance,           /*!< \brief Write the performance summary at the end of a calculation.  */
   Wrt_AD_Statistics,         /*!< \brief Write the tape statistics (discrete adjoint).  */
   Wrt_MeshQuality,           /*!< \brief Write the mesh quality statistics to the visualization files.  */
-  Wrt_InletFile,             /*!< \brief Write a template inlet profile file */
   Wrt_Slice,                 /*!< \brief Write 1D slice of a 2D cartesian solution */
   Wrt_Projected_Sensitivity, /*!< \brief Write projected sensitivities (dJ/dx) on surfaces to ASCII file. */
   Plot_Section_Forces;       /*!< \brief Write sectional forces for specified markers. */
@@ -1657,14 +1657,21 @@ class CConfig {
   su2double GetGamma(void);
 
   /*!
-   * \brief Get the values of the CFL adapation.
-   * \return Value of CFL adapation
+   * \brief Get the values of the CFL adaption parameters.
+   * \return Value of CFL adaption parameter
    */
   su2double GetCFL_AdaptParam(unsigned short val_index);
 
   /*!
-   * \brief Get the values of the CFL adapation.
-   * \return Value of CFL adapation
+   * \brief Set the values of the CFL adaption parameters.
+   * \param[in] val_index     - Index of the particular CFL adaption parameter
+   * \param[in] val_cfl_param - Value of the CFL adaption parameter
+   */
+  inline void SetCFL_AdaptParam(unsigned short val_index, su2double val_cfl_param) { CFL_AdaptParam[val_index] = val_cfl_param; }
+
+  /*!
+   * \brief Get the value of the CFL adaption flag.
+   * \return <code>TRUE</code> if CFL adaption is active; otherwise <code>FALSE</code>.
    */
   bool GetCFL_Adapt(void);
 
@@ -3284,18 +3291,6 @@ class CConfig {
    * \return <code>TRUE</code> means that the mesh quality metrics will be written to the visualization files.
    */
   bool GetWrt_MeshQuality(void);
-
-  /*!
-   * \brief Get information about writing a template inlet profile file.
-   * \return <code>TRUE</code> means that a template inlet profile file will be written.
-   */
-  bool GetWrt_InletFile(void);
-
-  /*!
-   * \brief Set information about writing a template inlet profile file.
-   * \param[in] val_wrt_inletfile - flag for whether to write a template inlet profile file.
-   */
-  void SetWrt_InletFile(bool val_wrt_inletfile);
 
   /*!
    * \brief Get information about writing a 1D slice of a 2D cartesian solution.
@@ -4016,11 +4011,29 @@ class CConfig {
   void SetKt_PolyCoeffND(su2double val_coeff, unsigned short val_index);
 
   /*!
-   * \brief Get the kind of method for computation of spatial gradients.
-   * \return Numerical method for computation of spatial gradients.
+   * \brief Get the kind of method for computation of spatial gradients used for viscous and source terms.
+   * \return Numerical method for computation of spatial gradients used for viscous and source terms.
    */
   unsigned short GetKind_Gradient_Method(void);
 
+  /*!
+   * \brief Get the kind of method for computation of spatial gradients used for upwind reconstruction.
+   * \return Numerical method for computation of spatial gradients used for upwind reconstruction.
+   */
+  unsigned short GetKind_Gradient_Method_Recon(void);
+
+  /*!
+   * \brief Get flag for whether a second gradient calculation is required for upwind reconstruction alone.
+   * \return <code>TRUE</code> means that a second gradient will be calculated for upwind reconstruction.
+   */
+  bool GetReconstructionGradientRequired(void);
+
+  /*!
+   * \brief Get flag for whether a least-squares gradient method is being applied.
+   * \return <code>TRUE</code> means that a least-squares gradient method is being applied.
+   */
+  bool GetLeastSquaresRequired(void);
+
   /*!
    * \brief Get the kind of solver for the implicit solver.
    * \return Numerical solver for implicit formulation (solving the linear system).
@@ -4094,23 +4107,11 @@ class CConfig {
    */
   su2double GetLinear_Solver_Smoother_Relaxation(void) const;
 
-  /*!
-   * \brief Get the relaxation coefficient of the linear solver for the implicit formulation.
-   * \return relaxation coefficient of the linear solver for the implicit formulation.
-   */
-  su2double GetRelaxation_Factor_Flow(void);
-
   /*!
    * \brief Get the relaxation coefficient of the linear solver for the implicit formulation.
    * \return relaxation coefficient of the linear solver for the implicit formulation.
    */
   su2double GetRelaxation_Factor_AdjFlow(void);
-
-  /*!
-   * \brief Get the relaxation coefficient of the linear solver for the implicit formulation.
-   * \return relaxation coefficient of the linear solver for the implicit formulation.
-   */
-  su2double GetRelaxation_Factor_Turb(void);
 
   /*!
    * \brief Get the relaxation coefficient of the CHT coupling.
@@ -9222,14 +9223,14 @@ class CConfig {
   unsigned short GetnConv_Field();  
 
   /*!
-   * \brief Set_StartTime
-   * \param starttime
+   * \brief Set the start time to track a phase of the code (preprocessing, compute, output).
+   * \param[in] Value of the start time to track a phase of the code.
    */
   void Set_StartTime(su2double starttime);
 
   /*!
-   * \brief Get_StartTime
-   * \return 
+   * \brief Get the start time to track a phase of the code (preprocessing, compute, output).
+   * \return Value of the start time to track a phase of the code.
    */
   su2double Get_StartTime();
 

Common/include/config_structure.inl

@@ -988,6 +988,12 @@ inline su2double CConfig::GetmaxTurkelBeta() { return  Max_Beta_RoeTurkel; }
 
 inline unsigned short CConfig::GetKind_Gradient_Method(void) { return Kind_Gradient_Method; }
 
+inline unsigned short CConfig::GetKind_Gradient_Method_Recon(void) { return Kind_Gradient_Method_Recon; }
+
+inline bool CConfig::GetReconstructionGradientRequired(void) { return ReconstructionGradientRequired; }
+
+inline bool CConfig::GetLeastSquaresRequired(void) { return LeastSquaresRequired; }
+
 inline unsigned short CConfig::GetKind_Linear_Solver(void) { return Kind_Linear_Solver; }
 
 inline unsigned short CConfig::GetKind_Deform_Linear_Solver(void) { return Kind_Deform_Linear_Solver; }
@@ -1012,12 +1018,8 @@ inline unsigned long CConfig::GetLinear_Solver_Restart_Frequency(void) { return
 
 inline su2double CConfig::GetLinear_Solver_Smoother_Relaxation(void) const { return Linear_Solver_Smoother_Relaxation; }
 
-inline su2double CConfig::GetRelaxation_Factor_Flow(void) { return Relaxation_Factor_Flow; }
-
 inline su2double CConfig::GetRelaxation_Factor_AdjFlow(void) { return Relaxation_Factor_AdjFlow; }
 
-inline su2double CConfig::GetRelaxation_Factor_Turb(void) { return Relaxation_Factor_Turb; }
-
 inline su2double CConfig::GetRelaxation_Factor_CHT(void) { return Relaxation_Factor_CHT; }
 
 inline su2double CConfig::GetRoe_Kappa(void) { return Roe_Kappa; }
@@ -1667,10 +1669,6 @@ inline bool CConfig::GetWrt_AD_Statistics(void) { return Wrt_AD_Statistics; }
 
 inline bool CConfig::GetWrt_MeshQuality(void) { return Wrt_MeshQuality; }
 
-inline bool CConfig::GetWrt_InletFile(void) { return Wrt_InletFile; }
-
-inline void CConfig::SetWrt_InletFile(bool val_wrt_inletfile) { Wrt_InletFile = val_wrt_inletfile; }
-
 inline bool CConfig::GetWrt_Slice(void) { return Wrt_Slice; }
 
 inline bool CConfig::GetWrt_Projected_Sensitivity(void) { return Wrt_Projected_Sensitivity; }

Common/include/option_structure.hpp

@@ -1,4 +1,4 @@
-/*!
+/*!
  * \file option_structure.hpp
  * \brief Defines classes for referencing options for easy input in CConfig
  * \author J. Hicken, B. Tracey
@@ -971,11 +971,15 @@ static const map<string, ENUM_SPACE_ITE_FEA> Space_Ite_Map_FEA = CCreateMap<stri
  * \brief types of schemes to compute the flow gradient
  */
 enum ENUM_FLOW_GRADIENT {
-  GREEN_GAUSS = 1,		      /*!< \brief Gradients computation using Green Gauss theorem. */
-  WEIGHTED_LEAST_SQUARES = 2  /*!< \brief Gradients computation using Weighted Least Squares. */
+  NO_GRADIENT            = 0, /*!< \brief No gradient method. Only possible for reconstruction gradient, in which case, the option chosen for NUM_METHOD_GRAD is used. */
+  GREEN_GAUSS            = 1,	/*!< \brief Gradient computation using Green-Gauss theorem. */
+  LEAST_SQUARES          = 2, /*!< \brief Gradient computation using unweighted least squares. */
+  WEIGHTED_LEAST_SQUARES = 3	/*!< \brief Gradients computation using inverse-distance weighted least squares. */
 };
 static const map<string, ENUM_FLOW_GRADIENT> Gradient_Map = CCreateMap<string, ENUM_FLOW_GRADIENT>
+("NONE", NO_GRADIENT)
 ("GREEN_GAUSS", GREEN_GAUSS)
+("LEAST_SQUARES", LEAST_SQUARES)
 ("WEIGHTED_LEAST_SQUARES", WEIGHTED_LEAST_SQUARES);
 
 /*!
@@ -1930,13 +1934,15 @@ enum PERIODIC_QUANTITIES {
   PERIODIC_SENSOR     =  6,  /*!< \brief Dissipation sensor communication (periodic only). */
   PERIODIC_SOL_GG     =  7,  /*!< \brief Solution gradient communication for Green-Gauss (periodic only). */
   PERIODIC_PRIM_GG    =  8,  /*!< \brief Primitive gradient communication for Green-Gauss (periodic only). */
-  PERIODIC_SOL_LS     =  9,  /*!< \brief Solution gradient communication for Least Squares (periodic only). */
-  PERIODIC_PRIM_LS    = 10,  /*!< \brief Primitive gradient communication for Least Squares (periodic only). */
+  PERIODIC_SOL_LS     =  9,  /*!< \brief Solution gradient communication for weighted Least Squares (periodic only). */
+  PERIODIC_PRIM_LS    = 10,  /*!< \brief Primitive gradient communication for weighted Least Squares (periodic only). */
   PERIODIC_LIM_SOL_1  = 11,  /*!< \brief Solution limiter communication phase 1 of 2 (periodic only). */
   PERIODIC_LIM_SOL_2  = 12,  /*!< \brief Solution limiter communication phase 2 of 2 (periodic only). */
   PERIODIC_LIM_PRIM_1 = 13,  /*!< \brief Primitive limiter communication phase 1 of 2 (periodic only). */
   PERIODIC_LIM_PRIM_2 = 14,  /*!< \brief Primitive limiter communication phase 2 of 2 (periodic only). */
-  PERIODIC_IMPLICIT   = 15   /*!< \brief Implicit update communication to ensure consistency across periodic boundaries. */
+  PERIODIC_IMPLICIT   = 15,   /*!< \brief Implicit update communication to ensure consistency across periodic boundaries. */
+  PERIODIC_SOL_ULS    = 16,  /*!< \brief Solution gradient communication for unwieghted Least Squares (periodic only). */
+  PERIODIC_PRIM_ULS   = 17  /*!< \brief Primitive gradient communication for unweighted Least Squares (periodic only). */
 };
 
 /*!