Template CScalarSolver on type of CVariable.

TobiKattmann · TobiKattmann · commit ca16276d50b2 · 2021-09-22T14:16:17.000+02:00
Allowing optimized acces to muT of TurbSolvers.
Implementation follows what is done for CFVMFlowSolverBase.
diff --git a/SU2_CFD/include/solvers/CScalarSolver.hpp b/SU2_CFD/include/solvers/CScalarSolver.hpp
@@ -1,7 +1,6 @@
 /*!
  * \file CScalarSolver.hpp
  * \brief Headers of the CScalarSolver class
- * \author A. Bueno.
  * \version 7.2.0 "Blackbird"
  *
  * SU2 Project Website: https://su2code.github.io
@@ -35,10 +34,10 @@
 
 /*!
  * \class CScalarSolver
- * \brief Main class for defining the turbulence model solver.
- * \ingroup Turbulence_Model
- * \author A. Bueno.
+ * \brief Main class for defining a scalar solver.
+ * \tparam TVariable - Class of C*Variable of the specific solver
  */
+template<class TVariable>
 class CScalarSolver : public CSolver {
  protected:
   enum : size_t { MAXNDIM = 3 };      /*!< \brief Max number of space dimensions, used in some static arrays. */
@@ -75,7 +74,7 @@ class CScalarSolver : public CSolver {
   /*!
    * \brief The highest level in the variable hierarchy this solver can safely use.
    */
-  CScalarVariable* nodes = nullptr;
+  TVariable* nodes = nullptr;
 
   /*!
    * \brief Return nodes to allow CSolver::base_nodes to be set.
@@ -85,7 +84,7 @@ class CScalarSolver : public CSolver {
   /*!
    * \brief Compute the viscous flux for the turbulent equation at a particular edge.
    * \tparam SolverSpecificNumericsFunc - lambda-function, that implements solver specific contributions to numerics.
-   * \note The functor has to implement (*geometry, *numerics, *config, *nodes, iPoint, jPoint)
+   * \note The functor has to implement (iPoint, jPoint)
    * \param[in] iEdge - Edge for which we want to compute the flux
    * \param[in] geometry - Geometrical definition of the problem.
    * \param[in] solver_container - Container vector with all the solutions.
diff --git a/SU2_CFD/include/solvers/CScalarSolver.inl b/SU2_CFD/include/solvers/CScalarSolver.inl
@@ -1,7 +1,6 @@
 /*!
- * \file CScalarSolver.cpp
+ * \file CScalarSolver.inl
  * \brief Main subrotuines of CScalarSolver class
- * \author F. Palacios, A. Bueno
  * \version 7.2.0 "Blackbird"
  *
  * SU2 Project Website: https://su2code.github.io
@@ -30,9 +29,11 @@
 #include "../../../Common/include/parallelization/omp_structure.hpp"
 #include "../../../Common/include/toolboxes/geometry_toolbox.hpp"
 
-CScalarSolver::CScalarSolver(bool conservative) : CSolver(), Conservative(conservative) {}
+template<class TVariable>
+CScalarSolver<TVariable>::CScalarSolver(bool conservative) : CSolver(), Conservative(conservative) {}
 
-CScalarSolver::CScalarSolver(CGeometry* geometry, CConfig* config, bool conservative)
+template<class TVariable>
+CScalarSolver<TVariable>::CScalarSolver(CGeometry* geometry, CConfig* config, bool conservative)
     : CSolver(), Conservative(conservative) {
   nMarker = config->GetnMarker_All();
 
@@ -74,9 +75,11 @@ CScalarSolver::CScalarSolver(CGeometry* geometry, CConfig* config, bool conserva
   }
 }
 
-CScalarSolver::~CScalarSolver() { delete nodes; }
+template<class TVariable>
+CScalarSolver<TVariable>::~CScalarSolver() { delete nodes; }
 
-void CScalarSolver::Upwind_Residual(CGeometry* geometry, CSolver** solver_container, CNumerics** numerics_container,
+template<class TVariable>
+void CScalarSolver<TVariable>::Upwind_Residual(CGeometry* geometry, CSolver** solver_container, CNumerics** numerics_container,
                                     CConfig* config, unsigned short iMesh) {
   const bool implicit = (config->GetKind_TimeIntScheme() == EULER_IMPLICIT);
   const bool muscl = config->GetMUSCL_Turb();
@@ -236,7 +239,8 @@ void CScalarSolver::Upwind_Residual(CGeometry* geometry, CSolver** solver_contai
   }
 }
 
-void CScalarSolver::SumEdgeFluxes(CGeometry* geometry) {
+template<class TVariable>
+void CScalarSolver<TVariable>::SumEdgeFluxes(CGeometry* geometry) {
   SU2_OMP_FOR_STAT(omp_chunk_size)
   for (unsigned long iPoint = 0; iPoint < nPoint; ++iPoint) {
     LinSysRes.SetBlock_Zero(iPoint);
@@ -251,7 +255,8 @@ void CScalarSolver::SumEdgeFluxes(CGeometry* geometry) {
   END_SU2_OMP_FOR
 }
 
-void CScalarSolver::BC_Periodic(CGeometry* geometry, CSolver** solver_container, CNumerics* numerics, CConfig* config) {
+template<class TVariable>
+void CScalarSolver<TVariable>::BC_Periodic(CGeometry* geometry, CSolver** solver_container, CNumerics* numerics, CConfig* config) {
   /*--- Complete residuals for periodic boundary conditions. We loop over
    the periodic BCs in matching pairs so that, in the event that there are
    adjacent periodic markers, the repeated points will have their residuals
@@ -264,7 +269,8 @@ void CScalarSolver::BC_Periodic(CGeometry* geometry, CSolver** solver_container,
   }
 }
 
-void CScalarSolver::PrepareImplicitIteration(CGeometry* geometry, CSolver** solver_container, CConfig* config) {
+template<class TVariable>
+void CScalarSolver<TVariable>::PrepareImplicitIteration(CGeometry* geometry, CSolver** solver_container, CConfig* config) {
   const auto flowNodes = solver_container[FLOW_SOL]->GetNodes();
 
   /*--- Set shared residual variables to 0 and declare
@@ -323,7 +329,8 @@ void CScalarSolver::PrepareImplicitIteration(CGeometry* geometry, CSolver** solv
   SetResidual_RMS(geometry, config);
 }
 
-void CScalarSolver::CompleteImplicitIteration(CGeometry* geometry, CSolver** solver_container, CConfig* config) {
+template<class TVariable>
+void CScalarSolver<TVariable>::CompleteImplicitIteration(CGeometry* geometry, CSolver** solver_container, CConfig* config) {
   const bool compressible = (config->GetKind_Regime() == ENUM_REGIME::COMPRESSIBLE);
 
   const auto flowNodes = solver_container[FLOW_SOL]->GetNodes();
@@ -369,7 +376,8 @@ void CScalarSolver::CompleteImplicitIteration(CGeometry* geometry, CSolver** sol
   CompleteComms(geometry, config, SOLUTION_EDDY);
 }
 
-void CScalarSolver::ImplicitEuler_Iteration(CGeometry* geometry, CSolver** solver_container, CConfig* config) {
+template<class TVariable>
+void CScalarSolver<TVariable>::ImplicitEuler_Iteration(CGeometry* geometry, CSolver** solver_container, CConfig* config) {
   PrepareImplicitIteration(geometry, solver_container, config);
 
   /*--- Solve or smooth the linear system. ---*/
@@ -393,7 +401,8 @@ void CScalarSolver::ImplicitEuler_Iteration(CGeometry* geometry, CSolver** solve
   CompleteImplicitIteration(geometry, solver_container, config);
 }
 
-void CScalarSolver::SetResidual_DualTime(CGeometry* geometry, CSolver** solver_container, CConfig* config,
+template<class TVariable>
+void CScalarSolver<TVariable>::SetResidual_DualTime(CGeometry* geometry, CSolver** solver_container, CConfig* config,
                                          unsigned short iRKStep, unsigned short iMesh,
                                          unsigned short RunTime_EqSystem) {
   const bool implicit = (config->GetKind_TimeIntScheme() == EULER_IMPLICIT);
@@ -632,7 +641,8 @@ void CScalarSolver::SetResidual_DualTime(CGeometry* geometry, CSolver** solver_c
   }  // end dynamic grid
 }
 
-void CScalarSolver::LoadRestart(CGeometry** geometry, CSolver*** solver, CConfig* config, int val_iter,
+template<class TVariable>
+void CScalarSolver<TVariable>::LoadRestart(CGeometry** geometry, CSolver*** solver, CConfig* config, int val_iter,
                                 bool val_update_geo) {
   /*--- Restart the solution from file information ---*/
 
diff --git a/SU2_CFD/include/solvers/CTurbSolver.hpp b/SU2_CFD/include/solvers/CTurbSolver.hpp
@@ -37,7 +37,7 @@
  * \ingroup Turbulence_Model
  * \author A. Bueno.
  */
-class CTurbSolver : public CScalarSolver {
+class CTurbSolver : public CScalarSolver<CTurbVariable> {
 protected:
 
   vector<su2activematrix> Inlet_TurbVars;  /*!< \brief Turbulence variables at inlet profiles */
diff --git a/SU2_CFD/obj/Makefile.am b/SU2_CFD/obj/Makefile.am
@@ -179,7 +179,6 @@ libSU2Core_sources = ../src/definition_structure.cpp \
   ../src/solvers/CSolver.cpp \
   ../src/solvers/CTemplateSolver.cpp \
   ../src/solvers/CTransLMSolver.cpp \
-  ../src/solvers/CScalarSolver.cpp \
   ../src/solvers/CTurbSolver.cpp \
   ../src/solvers/CTurbSASolver.cpp \
   ../src/solvers/CTurbSSTSolver.cpp \
diff --git a/SU2_CFD/src/meson.build b/SU2_CFD/src/meson.build
@@ -102,7 +102,6 @@ su2_cfd_src += files(['solvers/CSolverFactory.cpp',
                       'solvers/CSolver.cpp',
                       'solvers/CTemplateSolver.cpp',
                       'solvers/CTransLMSolver.cpp',
-                      'solvers/CScalarSolver.cpp',
                       'solvers/CTurbSolver.cpp',
                       'solvers/CTurbSASolver.cpp',
                       'solvers/CTurbSSTSolver.cpp'])
diff --git a/SU2_CFD/src/solvers/CTransLMSolver.cpp b/SU2_CFD/src/solvers/CTransLMSolver.cpp
@@ -25,11 +25,15 @@
  * License along with SU2. If not, see <http://www.gnu.org/licenses/>.
  */
 
-
+#include "../../include/solvers/CScalarSolver.inl"
 #include "../../include/solvers/CTransLMSolver.hpp"
 #include "../../include/variables/CTransLMVariable.hpp"
 #include "../../include/variables/CTurbSAVariable.hpp"
 
+/*--- Explicit instantiation of the parent class of CTurbSolver,
+ *    to spread the compilation over multiple cpp files. ---*/
+template class CScalarSolver<CTurbVariable>;
+
 /*---  This is the implementation of the Langtry-Menter transition model.
        The main reference for this model is:Langtry, Menter, AIAA J. 47(12) 2009 
        DOI: https://doi.org/10.2514/1.42362 ---*/
diff --git a/SU2_CFD/src/solvers/CTurbSASolver.cpp b/SU2_CFD/src/solvers/CTurbSASolver.cpp
@@ -25,11 +25,15 @@
  * License along with SU2. If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include "../../include/solvers/CScalarSolver.inl"
 #include "../../include/solvers/CTurbSASolver.hpp"
 #include "../../include/variables/CTurbSAVariable.hpp"
 #include "../../../Common/include/parallelization/omp_structure.hpp"
 #include "../../../Common/include/toolboxes/geometry_toolbox.hpp"
 
+/*--- Explicit instantiation of the parent class of CTurbSolver,
+ *    to spread the compilation over multiple cpp files. ---*/
+template class CScalarSolver<CTurbVariable>;
 
 CTurbSASolver::CTurbSASolver(void) : CTurbSolver(false) { }
 
diff --git a/SU2_CFD/src/solvers/CTurbSSTSolver.cpp b/SU2_CFD/src/solvers/CTurbSSTSolver.cpp
@@ -25,11 +25,15 @@
  * License along with SU2. If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include "../../include/solvers/CScalarSolver.inl"
 #include "../../include/solvers/CTurbSSTSolver.hpp"
 #include "../../include/variables/CTurbSSTVariable.hpp"
 #include "../../../Common/include/parallelization/omp_structure.hpp"
 #include "../../../Common/include/toolboxes/geometry_toolbox.hpp"
 
+/*--- Explicit instantiation of the parent class of CTurbSolver,
+ *    to spread the compilation over multiple cpp files. ---*/
+template class CScalarSolver<CTurbVariable>;
 
 CTurbSSTSolver::CTurbSSTSolver(void) : CTurbSolver(true) { }
 
diff --git a/SU2_CFD/src/solvers/CTurbSolver.cpp b/SU2_CFD/src/solvers/CTurbSolver.cpp
@@ -30,9 +30,9 @@
 #include "../../../Common/include/toolboxes/geometry_toolbox.hpp"
 
 
-CTurbSolver::CTurbSolver(bool conservative) : CScalarSolver(conservative) { }
+CTurbSolver::CTurbSolver(bool conservative) : CScalarSolver<CTurbVariable>(conservative) { }
 
-CTurbSolver::CTurbSolver(CGeometry* geometry, CConfig *config, bool conservative) : CScalarSolver(geometry, config, conservative) { }
+CTurbSolver::CTurbSolver(CGeometry* geometry, CConfig *config, bool conservative) : CScalarSolver<CTurbVariable>(geometry, config, conservative) { }
 
 CTurbSolver::~CTurbSolver() {
 
