Base class for transported scalars

SU2_CFD/include/numerics/CNumerics.hpp

@@ -130,8 +130,8 @@ class CNumerics {
   *Psi_i,    /*!< \brief Vector of adjoint variables at point i. */
   *Psi_j;    /*!< \brief Vector of adjoint variables at point j. */
   const su2double
-  *TurbVar_i,   /*!< \brief Vector of turbulent variables at point i. */
-  *TurbVar_j;   /*!< \brief Vector of turbulent variables at point j. */
+  *ScalarVar_i,   /*!< \brief Vector of scalar variables at point i. */
+  *ScalarVar_j;   /*!< \brief Vector of scalar variables at point j. */
   const su2double
   *TransVar_i,  /*!< \brief Vector of turbulent variables at point i. */
   *TransVar_j;  /*!< \brief Vector of turbulent variables at point j. */
@@ -146,8 +146,8 @@ class CNumerics {
   PrimVar_Grad_j,  /*!< \brief Gradient of primitive variables at point j. */
   PsiVar_Grad_i,   /*!< \brief Gradient of adjoint variables at point i. */
   PsiVar_Grad_j,   /*!< \brief Gradient of adjoint variables at point j. */
-  TurbVar_Grad_i,  /*!< \brief Gradient of turbulent variables at point i. */
-  TurbVar_Grad_j,  /*!< \brief Gradient of turbulent variables at point j. */
+  ScalarVar_Grad_i,  /*!< \brief Gradient of scalar variables at point i. */
+  ScalarVar_Grad_j,  /*!< \brief Gradient of scalar variables at point j. */
   TransVar_Grad_i, /*!< \brief Gradient of turbulent variables at point i. */
   TransVar_Grad_j, /*!< \brief Gradient of turbulent variables at point j. */
   TurbPsi_Grad_i,  /*!< \brief Gradient of adjoint turbulent variables at point i. */
@@ -347,13 +347,13 @@ class CNumerics {
   }
 
   /*!
-   * \brief Set the value of the turbulent variable.
-   * \param[in] val_turbvar_i - Value of the turbulent variable at point i.
-   * \param[in] val_turbvar_j - Value of the turbulent variable at point j.
+   * \brief Set the value of the scalar variable.
+   * \param[in] val_scalarvar_i - Value of the scalar variable at point i.
+   * \param[in] val_scalarvar_j - Value of the scalar variable at point j.
    */
-  inline void SetTurbVar(const su2double *val_turbvar_i, const su2double *val_turbvar_j) {
-    TurbVar_i = val_turbvar_i;
-    TurbVar_j = val_turbvar_j;
+  inline void SetScalarVar(const su2double *val_scalarvar_i, const su2double *val_scalarvar_j) {
+    ScalarVar_i = val_scalarvar_i;
+    ScalarVar_j = val_scalarvar_j;
   }
 
   /*!
@@ -367,14 +367,14 @@ class CNumerics {
   }
 
   /*!
-   * \brief Set the gradient of the turbulent variables.
-   * \param[in] val_turbvar_grad_i - Gradient of the turbulent variable at point i.
-   * \param[in] val_turbvar_grad_j - Gradient of the turbulent variable at point j.
+   * \brief Set the gradient of the scalar variables.
+   * \param[in] val_scalarvar_grad_i - Gradient of the scalar variable at point i.
+   * \param[in] val_scalarvar_grad_j - Gradient of the scalar variable at point j.
    */
-  inline void SetTurbVarGradient(CMatrixView<const su2double> val_turbvar_grad_i,
-                                 CMatrixView<const su2double> val_turbvar_grad_j) {
-    TurbVar_Grad_i = val_turbvar_grad_i;
-    TurbVar_Grad_j = val_turbvar_grad_j;
+  inline void SetScalarVarGradient(CMatrixView<const su2double> val_scalarvar_grad_i,
+                                   CMatrixView<const su2double> val_scalarvar_grad_j) {
+    ScalarVar_Grad_i = val_scalarvar_grad_i;
+    ScalarVar_Grad_j = val_scalarvar_grad_j;
   }
 
   /*!

SU2_CFD/include/numerics/scalar/scalar_convection.hpp

@@ -0,0 +1,89 @@
+/*!
+ * \file scalar_convection.hpp
+ * \brief Delarations of numerics classes for discretization of
+ *        convective fluxes in scalar problems.
+ * \author F. Palacios, T. Economon
+ * \version 7.2.0 "Blackbird"
+ *
+ * SU2 Project Website: https://su2code.github.io
+ *
+ * The SU2 Project is maintained by the SU2 Foundation
+ * (http://su2foundation.org)
+ *
+ * Copyright 2012-2021, SU2 Contributors (cf. AUTHORS.md)
+ *
+ * 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/>.
+ */
+
+#pragma once
+
+#include "../CNumerics.hpp"
+
+/*!
+ * \class CUpwScalar
+ * \brief Template class for scalar upwind fluxes between nodes i and j.
+ * \details This class serves as a template for the scalar upwinding residual
+ *   classes.  The general structure of a scalar upwinding calculation is the
+ *   same for many different  models, which leads to a lot of repeated code.
+ *   By using the template design pattern, these sections of repeated code are
+ *   moved to this shared base class, and the specifics of each model
+ *   are implemented by derived classes.  In order to add a new residual
+ *   calculation for a convection residual, extend this class and implement
+ *   the pure virtual functions with model-specific behavior.
+ * \ingroup ConvDiscr
+ * \author C. Pederson, A. Bueno., and A. Campos.
+ */
+class CUpwScalar : public CNumerics {
+ protected:
+  su2double a0 = 0.0;               /*!< \brief The maximum of the face-normal velocity and 0 */
+  su2double a1 = 0.0;               /*!< \brief The minimum of the face-normal velocity and 0 */
+  su2double* Flux = nullptr;        /*!< \brief Final result, diffusive flux/residual. */
+  su2double** Jacobian_i = nullptr; /*!< \brief Flux Jacobian w.r.t. node i. */
+  su2double** Jacobian_j = nullptr; /*!< \brief Flux Jacobian w.r.t. node j. */
+
+  const bool implicit = false, incompressible = false, dynamic_grid = false;
+
+  /*!
+   * \brief A pure virtual function; Adds any extra variables to AD
+   */
+  virtual void ExtraADPreaccIn() = 0;
+
+  /*!
+   * \brief Model-specific steps in the ComputeResidual method, derived classes
+   *        compute the Flux and its Jacobians via this method.
+   * \param[in] config - Definition of the particular problem.
+   */
+  virtual void FinishResidualCalc(const CConfig* config) = 0;
+
+ public:
+  /*!
+   * \brief Constructor of the class.
+   * \param[in] val_nDim - Number of dimensions of the problem.
+   * \param[in] val_nVar - Number of variables of the problem.
+   * \param[in] config - Definition of the particular problem.
+   */
+  CUpwScalar(unsigned short val_nDim, unsigned short val_nVar, const CConfig* config);
+
+  /*!
+   * \brief Destructor of the class.
+   */
+  ~CUpwScalar(void) override;
+
+  /*!
+   * \brief Compute the scalar upwind flux between two nodes i and j.
+   * \param[in] config - Definition of the particular problem.
+   * \return A lightweight const-view (read-only) of the residual/flux and Jacobians.
+   */
+  ResidualType<> ComputeResidual(const CConfig* config) override;
+};

SU2_CFD/include/numerics/scalar/scalar_diffusion.hpp

@@ -0,0 +1,91 @@
+/*!
+ * \file scalar_diffusion.hpp
+ * \brief Declarations of numerics classes for discretization of
+ *        viscous fluxes in scalar problems.
+ * \author F. Palacios, T. Economon
+ * \version 7.2.0 "Blackbird"
+ *
+ * SU2 Project Website: https://su2code.github.io
+ *
+ * The SU2 Project is maintained by the SU2 Foundation
+ * (http://su2foundation.org)
+ *
+ * Copyright 2012-2021, SU2 Contributors (cf. AUTHORS.md)
+ *
+ * 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/>.
+ */
+
+#pragma once
+
+#include "../CNumerics.hpp"
+
+/*!
+ * \class CAvgGrad_Scalar
+ * \brief Template class for computing viscous residual of scalar values
+ * \details This class serves as a template for the scalar viscous residual
+ *   classes.  The general structure of a viscous residual calculation is the
+ *   same for many different  models, which leads to a lot of repeated code.
+ *   By using the template design pattern, these sections of repeated code are
+ *   moved to a shared base class, and the specifics of each model
+ *   are implemented by derived classes.  In order to add a new residual
+ *   calculation for a viscous residual, extend this class and implement
+ *   the pure virtual functions with model-specific behavior.
+ * \ingroup ViscDiscr
+ * \author C. Pederson, A. Bueno, and F. Palacios
+ */
+class CAvgGrad_Scalar : public CNumerics {
+ protected:
+  su2double* Proj_Mean_GradScalarVar_Normal = nullptr; /*!< \brief Mean_gradScalarVar DOT normal. */
+  su2double* Proj_Mean_GradScalarVar = nullptr; /*!< \brief Mean_gradScalarVar DOT normal, corrected if required. */
+  su2double proj_vector_ij = 0.0;               /*!< \brief (Edge_Vector DOT normal)/|Edge_Vector|^2 */
+  su2double* Flux = nullptr;                    /*!< \brief Final result, diffusive flux/residual. */
+  su2double** Jacobian_i = nullptr;             /*!< \brief Flux Jacobian w.r.t. node i. */
+  su2double** Jacobian_j = nullptr;             /*!< \brief Flux Jacobian w.r.t. node j. */
+
+  const bool correct_gradient = false, implicit = false, incompressible = false;
+
+  /*!
+   * \brief A pure virtual function; Adds any extra variables to AD
+   */
+  virtual void ExtraADPreaccIn() = 0;
+
+  /*!
+   * \brief Model-specific steps in the ComputeResidual method, derived classes
+   *        should compute the Flux and Jacobians (i/j) inside this method.
+   * \param[in] config - Definition of the particular problem.
+   */
+  virtual void FinishResidualCalc(const CConfig* config) = 0;
+
+ public:
+  /*!
+   * \brief Constructor of the class.
+   * \param[in] val_nDim - Number of dimensions of the problem.
+   * \param[in] val_nVar - Number of variables of the problem.
+   * \param[in] correct_gradient - Whether to correct gradient for skewness.
+   * \param[in] config - Definition of the particular problem.
+   */
+  CAvgGrad_Scalar(unsigned short val_nDim, unsigned short val_nVar, bool correct_gradient, const CConfig* config);
+
+  /*!
+   * \brief Destructor of the class.
+   */
+  ~CAvgGrad_Scalar(void) override;
+
+  /*!
+   * \brief Compute the viscous residual using an average of gradients without correction.
+   * \param[in] config - Definition of the particular problem.
+   * \return A lightweight const-view (read-only) of the residual/flux and Jacobians.
+   */
+  ResidualType<> ComputeResidual(const CConfig* config) override;
+};

SU2_CFD/include/numerics/scalar/scalar_sources.hpp

@@ -0,0 +1,29 @@
+/*!
+ * \file scalar_sources.hpp
+ * \brief Delarations of numerics classes for integration of source terms in scalar problems.
+ * \version 7.2.0 "Blackbird"
+ *
+ * SU2 Project Website: https://su2code.github.io
+ *
+ * The SU2 Project is maintained by the SU2 Foundation
+ * (http://su2foundation.org)
+ *
+ * Copyright 2012-2021, SU2 Contributors (cf. AUTHORS.md)
+ *
+ * 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/>.
+ */
+
+#pragma once
+
+#include "../CNumerics.hpp"

SU2_CFD/include/numerics/turbulent/turb_convection.hpp

@@ -28,67 +28,7 @@
 
 #pragma once
 
-#include "../CNumerics.hpp"
-
-/*!
- * \class CUpwScalar
- * \brief Template class for scalar upwind fluxes between nodes i and j.
- * \details This class serves as a template for the scalar upwinding residual
- *   classes.  The general structure of a scalar upwinding calculation is the
- *   same for many different  models, which leads to a lot of repeated code.
- *   By using the template design pattern, these sections of repeated code are
- *   moved to this shared base class, and the specifics of each model
- *   are implemented by derived classes.  In order to add a new residual
- *   calculation for a convection residual, extend this class and implement
- *   the pure virtual functions with model-specific behavior.
- * \ingroup ConvDiscr
- * \author C. Pederson, A. Bueno., and A. Campos.
- */
-class CUpwScalar : public CNumerics {
-protected:
-  su2double
-  a0 = 0.0,                    /*!< \brief The maximum of the face-normal velocity and 0 */
-  a1 = 0.0,                    /*!< \brief The minimum of the face-normal velocity and 0 */
-  *Flux = nullptr,             /*!< \brief Final result, diffusive flux/residual. */
-  **Jacobian_i = nullptr,      /*!< \brief Flux Jacobian w.r.t. node i. */
-  **Jacobian_j = nullptr;      /*!< \brief Flux Jacobian w.r.t. node j. */
-
-  const bool implicit = false, incompressible = false, dynamic_grid = false;
-
-  /*!
-   * \brief A pure virtual function; Adds any extra variables to AD
-   */
-  virtual void ExtraADPreaccIn() = 0;
-
-  /*!
-   * \brief Model-specific steps in the ComputeResidual method, derived classes
-   *        compute the Flux and its Jacobians via this method.
-   * \param[in] config - Definition of the particular problem.
-   */
-  virtual void FinishResidualCalc(const CConfig* config) = 0;
-
-public:
-  /*!
-   * \brief Constructor of the class.
-   * \param[in] val_nDim - Number of dimensions of the problem.
-   * \param[in] val_nVar - Number of variables of the problem.
-   * \param[in] config - Definition of the particular problem.
-   */
-  CUpwScalar(unsigned short val_nDim, unsigned short val_nVar, const CConfig* config);
-
-  /*!
-   * \brief Destructor of the class.
-   */
-  ~CUpwScalar(void) override;
-
-  /*!
-   * \brief Compute the scalar upwind flux between two nodes i and j.
-   * \param[in] config - Definition of the particular problem.
-   * \return A lightweight const-view (read-only) of the residual/flux and Jacobians.
-   */
-  ResidualType<> ComputeResidual(const CConfig* config) override;
-
-};
+#include "../scalar/scalar_convection.hpp"
 
 /*!
  * \class CUpwSca_TurbSA