Cleanup of headers of iteration classes

talbring · talbring · commit c991178ca6de · 2020-06-04T20:35:57.000+02:00
diff --git a/SU2_CFD/include/iteration/CAdjFluidIteration.hpp b/SU2_CFD/include/iteration/CAdjFluidIteration.hpp
@@ -41,12 +41,7 @@ class CAdjFluidIteration : public CFluidIteration {
    * \brief Constructor of the class.
    * \param[in] config - Definition of the particular problem.
    */
-  CAdjFluidIteration(const CConfig* config);
-
-  /*!
-   * \brief Destructor of the class.
-   */
-  ~CAdjFluidIteration(void) override;
+  explicit CAdjFluidIteration(const CConfig *config) : CFluidIteration(config) {}
 
   /*!
    * \brief Preprocessing to prepare for an iteration of the physics.
diff --git a/SU2_CFD/include/iteration/CDiscAdjFEAIteration.hpp b/SU2_CFD/include/iteration/CDiscAdjFEAIteration.hpp
@@ -47,7 +47,7 @@ class CDiscAdjFEAIteration : public CIteration {
    * \brief Constructor of the class.
    * \param[in] config - Definition of the particular problem.
    */
-  CDiscAdjFEAIteration(const CConfig* config);
+  explicit CDiscAdjFEAIteration(const CConfig* config);
 
   /*!
    * \brief Destructor of the class.
diff --git a/SU2_CFD/include/iteration/CDiscAdjFluidIteration.hpp b/SU2_CFD/include/iteration/CDiscAdjFluidIteration.hpp
@@ -39,16 +39,15 @@ class CFluidIteration;
  */
 class CDiscAdjFluidIteration : public CIteration {
  private:
-  CFluidIteration* meanflow_iteration; /*!< \brief Pointer to the mean flow iteration class. */
-  unsigned short CurrentRecording;     /*!< \brief Stores the current status of the recording. */
-  bool turbulent;                      /*!< \brief Stores the turbulent flag. */
+  const bool turbulent;                      /*!< \brief Stores the turbulent flag. */
 
  public:
   /*!
    * \brief Constructor of the class.
    * \param[in] config - Definition of the particular problem.
    */
-  CDiscAdjFluidIteration(const CConfig* config);
+  explicit CDiscAdjFluidIteration(const CConfig *config) : CIteration(config),
+    turbulent(config->GetKind_Solver() == DISC_ADJ_RANS || config->GetKind_Solver() == DISC_ADJ_INC_RANS) {}
 
   /*!
    * \brief Destructor of the class.
@@ -185,26 +184,6 @@ class CDiscAdjFluidIteration : public CIteration {
   void RegisterOutput(CSolver***** solver, CGeometry**** geometry, CConfig** config, COutput* output,
                       unsigned short iZone, unsigned short iInst) override;
 
-  /*!
-   * \brief Record a single iteration of the direct mean flow system.
-   * \param[in] output - Pointer to the COutput class.
-   * \param[in] integration - Container vector with all the integration methods.
-   * \param[in] geometry - Geometrical definition of the problem.
-   * \param[in] solver - Container vector with all the solutions.
-   * \param[in] numerics - Description of the numerical method (the way in which the equations are solved).
-   * \param[in] config - Definition of the particular problem.
-   * \param[in] surface_movement - Surface movement classes of the problem.
-   * \param[in] grid_movement - Volume grid movement classes of the problem.
-   * \param[in] FFDBox - FFD FFDBoxes of the problem.
-   * \param[in] val_iZone - Index of the zone.
-   * \param[in] val_iInst - Index of the instance.
-   * \param[in] kind_recording - The kind of recording (geometry or flow).
-   */
-  void SetRecording(COutput* output, CIntegration**** integration, CGeometry**** geometry, CSolver***** solver,
-                    CNumerics****** numerics, CConfig** config, CSurfaceMovement** surface_movement,
-                    CVolumetricMovement*** grid_movement, CFreeFormDefBox*** FFDBox, unsigned short val_iZone,
-                    unsigned short val_iInst, unsigned short kind_recording);
-
   /*!
    * \brief Record a single iteration of the direct mean flow system.
    * \param[in] solver - Container vector with all the solutions.
diff --git a/SU2_CFD/include/iteration/CDiscAdjHeatIteration.hpp b/SU2_CFD/include/iteration/CDiscAdjHeatIteration.hpp
@@ -30,24 +30,18 @@
 
 #include "CIteration.hpp"
 
-class CHeatIteration;
-
 /*!
  * \class CDiscAdjHeatIteration
  * \brief Class for driving an iteration of the discrete adjoint heat equation.
  * \author O. Burghardt
  */
 class CDiscAdjHeatIteration : public CIteration {
- private:
-  CHeatIteration* mean_iteration;  /*!< \brief Pointer to the mean flow iteration class. */
-  unsigned short CurrentRecording; /*!< \brief Stores the current status of the recording. */
-
  public:
   /*!
    * \brief Constructor of the class.
    * \param[in] config - Definition of the particular problem.
    */
-  CDiscAdjHeatIteration(const CConfig* config);
+  explicit CDiscAdjHeatIteration(const CConfig *config) : CIteration(config) {}
 
   /*!
    * \brief Destructor of the class.
@@ -178,38 +172,6 @@ class CDiscAdjHeatIteration : public CIteration {
   void RegisterOutput(CSolver***** solver, CGeometry**** geometry, CConfig** config, COutput* output,
                       unsigned short iZone, unsigned short iInst) override;
 
-  /*!
-   * \brief Record a single iteration of the direct heat system.
-   * \param[in] output - Pointer to the COutput class.
-   * \param[in] integration - Container vector with all the integration methods.
-   * \param[in] geometry - Geometrical definition of the problem.
-   * \param[in] solver - Container vector with all the solutions.
-   * \param[in] numerics - Description of the numerical method (the way in which the equations are solved).
-   * \param[in] config - Definition of the particular problem.
-   * \param[in] surface_movement - Surface movement classes of the problem.
-   * \param[in] grid_movement - Volume grid movement classes of the problem.
-   * \param[in] FFDBox - FFD FFDBoxes of the problem.
-   * \param[in] val_iZone - Index of the zone.
-   * \param[in] kind_recording - The kind of recording.
-   */
-  void SetRecording(COutput* output, CIntegration*** integration, CGeometry*** geometry, CSolver**** solver,
-                    CNumerics***** numerics, CConfig** config, CSurfaceMovement** surface_movement,
-                    CVolumetricMovement*** grid_movement, CFreeFormDefBox*** FFDBox, unsigned short val_iZone,
-                    unsigned short kind_recording);
-
-  /*!
-   * \brief Record a single iteration of the direct heat system.
-   * \param[in] geometry - Geometrical definition of the problem.
-   * \param[in] solver - Container vector with all the solutions.
-   * \param[in] config - Definition of the particular problem.
-   * \param[in] val_iZone - Index of the zone.
-   * \param[in] val_iZone - Index of the instance.
-   * \param[in] kind_recording - The kind of recording (geometry or flow).
-   */
-
-  void SetRecording(CSolver***** solver, CGeometry**** geometry, CConfig** config, unsigned short val_iZone,
-                    unsigned short val_iInst, unsigned short kind_recording) override {}
-
   /*!
    * \brief Compute necessary variables that depend on the conservative variables or the mesh node positions
    * (e.g. turbulent variables, normals, volumes).
diff --git a/SU2_CFD/include/iteration/CFEAIteration.hpp b/SU2_CFD/include/iteration/CFEAIteration.hpp
@@ -42,19 +42,7 @@ class CFEAIteration : public CIteration {
    * \brief Constructor of the class.
    * \param[in] config - Definition of the particular problem.
    */
-  CFEAIteration(const CConfig* config);
-
-  /*!
-   * \brief Destructor of the class.
-   */
-  ~CFEAIteration(void) override;
-
-  /*!
-   * \brief Preprocessing to prepare for an iteration of the physics.
-   * \param[in] ??? - Description here.
-   */
-  void Preprocess();
-  using CIteration::Preprocess;
+  explicit CFEAIteration(const CConfig* config) : CIteration(config) {}
 
   /*!
    * \brief Perform a single iteration for structural analysis using the Finite Element Method.
diff --git a/SU2_CFD/include/iteration/CFEMFluidIteration.hpp b/SU2_CFD/include/iteration/CFEMFluidIteration.hpp
@@ -42,12 +42,7 @@ class CFEMFluidIteration : public CFluidIteration {
    * \brief Constructor of the class.
    * \param[in] config - Definition of the particular problem.
    */
-  CFEMFluidIteration(const CConfig* config);
-
-  /*!
-   * \brief Destructor of the class.
-   */
-  ~CFEMFluidIteration(void) override;
+  explicit CFEMFluidIteration(const CConfig* config) : CFluidIteration(config) {}
 
   /*!
    * \brief Preprocessing to prepare for an iteration of the physics.
diff --git a/SU2_CFD/include/iteration/CFluidIteration.hpp b/SU2_CFD/include/iteration/CFluidIteration.hpp
@@ -41,12 +41,7 @@ class CFluidIteration : public CIteration {
    * \brief Constructor of the class.
    * \param[in] config - Definition of the particular problem.
    */
-  CFluidIteration(const CConfig* config);
-
-  /*!
-   * \brief Destructor of the class.
-   */
-  ~CFluidIteration(void) override;
+  explicit CFluidIteration(const CConfig* config) : CIteration(config) {}
 
   /*!
    * \brief Preprocessing to prepare for an iteration of the physics.
diff --git a/SU2_CFD/include/iteration/CHeatIteration.hpp b/SU2_CFD/include/iteration/CHeatIteration.hpp
@@ -41,12 +41,7 @@ class CHeatIteration : public CFluidIteration {
    * \brief Constructor of the class.
    * \param[in] config - Definition of the particular problem.
    */
-  CHeatIteration(const CConfig* config);
-
-  /*!
-   * \brief Destructor of the class.
-   */
-  ~CHeatIteration(void) override;
+  explicit CHeatIteration(const CConfig* config) : CFluidIteration(config) {}
 
   /*!
    * \brief Perform a single iteration of the heat system.
diff --git a/SU2_CFD/include/iteration/CIteration.hpp b/SU2_CFD/include/iteration/CIteration.hpp
@@ -45,27 +45,33 @@ class COutput;
  */
 class CIteration {
  protected:
-  int rank,             /*!< \brief MPI Rank. */
-      size;             /*!< \brief MPI Size. */
-  unsigned short nZone; /*!< \brief Total number of zones in the problem. */
-  unsigned short nInst; /*!< \brief Total number of instances in the problem. */
+  const int rank,             /*!< \brief MPI Rank. */
+      size;                   /*!< \brief MPI Size. */
+  const unsigned short nZone; /*!< \brief Total number of zones in the problem. */
+  const unsigned short nInst; /*!< \brief Total number of instances in the problem. */
 
-  bool multizone, /*!< \brief Flag for multizone problems. */
-      singlezone; /*!< \brief Flag for singlezone problems. */
+  const bool multizone, /*!< \brief Flag for multizone problems. */
+      singlezone;       /*!< \brief Flag for singlezone problems. */
 
-  su2double StartTime, /*!< \brief Tracking wall time. */
-      StopTime, UsedTime;
+  su2double StartTime{0.0}, /*!< \brief Tracking wall time. */
+      StopTime{0.0}, UsedTime{0.0};
 
  public:
   /*!
    * \brief Constructor of the class.
    */
-  CIteration(const CConfig *config);
+  explicit CIteration(const CConfig* config)
+      : rank(SU2_MPI::GetRank()),
+        size(SU2_MPI::GetSize()),
+        nZone(config->GetnZone()),
+        nInst(config->GetnTimeInstances()),
+        multizone(config->GetMultizone_Problem()),
+        singlezone(!multizone) {}
 
   /*!
    * \brief Destructor of the class.
    */
-  virtual ~CIteration(void);
+  virtual ~CIteration(void) = default;
 
   /*!
    * \brief Updates the positions and grid velocities for dynamic meshes between physical time steps.
@@ -110,7 +116,7 @@ class CIteration {
   virtual void Preprocess(COutput* output, CIntegration**** integration, CGeometry**** geometry, CSolver***** solver,
                           CNumerics****** numerics, CConfig** config, CSurfaceMovement** surface_movement,
                           CVolumetricMovement*** grid_movement, CFreeFormDefBox*** FFDBox, unsigned short val_iZone,
-                          unsigned short val_iInst);
+                          unsigned short val_iInst){};
 
   /*!
    * \brief A virtual member.
@@ -127,7 +133,7 @@ class CIteration {
   virtual void Iterate(COutput* output, CIntegration**** integration, CGeometry**** geometry, CSolver***** solver,
                        CNumerics****** numerics, CConfig** config, CSurfaceMovement** surface_movement,
                        CVolumetricMovement*** grid_movement, CFreeFormDefBox*** FFDBox, unsigned short val_iZone,
-                       unsigned short val_iInst);
+                       unsigned short val_iInst){};
 
   /*!
    * \brief A virtual member.
@@ -144,7 +150,7 @@ class CIteration {
   virtual void Solve(COutput* output, CIntegration**** integration, CGeometry**** geometry, CSolver***** solver,
                      CNumerics****** numerics, CConfig** config, CSurfaceMovement** surface_movement,
                      CVolumetricMovement*** grid_movement, CFreeFormDefBox*** FFDBox, unsigned short val_iZone,
-                     unsigned short val_iInst);
+                     unsigned short val_iInst){};
 
   /*!
    * \brief A virtual member.
@@ -161,7 +167,7 @@ class CIteration {
   virtual void Update(COutput* output, CIntegration**** integration, CGeometry**** geometry, CSolver***** solver,
                       CNumerics****** numerics, CConfig** config, CSurfaceMovement** surface_movement,
                       CVolumetricMovement*** grid_movement, CFreeFormDefBox*** FFDBox, unsigned short val_iZone,
-                      unsigned short val_iInst);
+                      unsigned short val_iInst){};
 
   /*!
    * \brief A virtual member.
@@ -178,7 +184,7 @@ class CIteration {
   virtual void Predictor(COutput* output, CIntegration**** integration, CGeometry**** geometry, CSolver***** solver,
                          CNumerics****** numerics, CConfig** config, CSurfaceMovement** surface_movement,
                          CVolumetricMovement*** grid_movement, CFreeFormDefBox*** FFDBox, unsigned short val_iZone,
-                         unsigned short val_iInst);
+                         unsigned short val_iInst){};
 
   /*!
    * \brief A virtual member.
@@ -195,7 +201,7 @@ class CIteration {
   virtual void Relaxation(COutput* output, CIntegration**** integration, CGeometry**** geometry, CSolver***** solver,
                           CNumerics****** numerics, CConfig** config, CSurfaceMovement** surface_movement,
                           CVolumetricMovement*** grid_movement, CFreeFormDefBox*** FFDBox, unsigned short val_iZone,
-                          unsigned short val_iInst);
+                          unsigned short val_iInst){};
 
   /*!
    * \brief A virtual member.
@@ -204,7 +210,9 @@ class CIteration {
   virtual bool Monitor(COutput* output, CIntegration**** integration, CGeometry**** geometry, CSolver***** solver,
                        CNumerics****** numerics, CConfig** config, CSurfaceMovement** surface_movement,
                        CVolumetricMovement*** grid_movement, CFreeFormDefBox*** FFDBox, unsigned short val_iZone,
-                       unsigned short val_iInst);
+                       unsigned short val_iInst) {
+    return false;
+  };
 
   /*!
    * \brief A virtual member.
@@ -228,7 +236,7 @@ class CIteration {
   virtual void Postprocess(COutput* output, CIntegration**** integration, CGeometry**** geometry, CSolver***** solver,
                            CNumerics****** numerics, CConfig** config, CSurfaceMovement** surface_movement,
                            CVolumetricMovement*** grid_movement, CFreeFormDefBox*** FFDBox, unsigned short val_iZone,
-                           unsigned short val_iInst);
+                           unsigned short val_iInst){};
 
   virtual void InitializeAdjoint(CSolver***** solver, CGeometry**** geometry, CConfig** config, unsigned short iZone,
                                  unsigned short iInst) {}
diff --git a/SU2_CFD/include/iteration/CIterationFactory.hpp b/SU2_CFD/include/iteration/CIterationFactory.hpp
@@ -31,19 +31,16 @@
 #include "CIteration.hpp"
 
 class CIterationFactory {
-
-public:
-
+ public:
   /*!
    * \brief Deleted constructor to avoid creating instances of this class
    */
   CIterationFactory() = delete;
 
   /*!
-   * \brief Create a new integration instance based on the current sub solver
-   * \param[in] integrationType  - The integration type
-   * \return                     - Pointer to the allocated integration instance
+   * \brief Create a new iteration instance based on the current main solver
+   * \param[in] kindSolver - The kind of main solver we are running
+   * \return               - Pointer to the allocated iteration instance
    */
-  static CIteration* createIteration(ENUM_MAIN_SOLVER kindSolver, const CConfig *config);
-
+  static CIteration* CreateIteration(ENUM_MAIN_SOLVER kindSolver, const CConfig* config);
 };
diff --git a/SU2_CFD/include/iteration/CTurboIteration.hpp b/SU2_CFD/include/iteration/CTurboIteration.hpp
@@ -41,12 +41,7 @@ class CTurboIteration : public CFluidIteration {
    * \brief Constructor of the class.
    * \param[in] config - Definition of the particular problem.
    */
-  CTurboIteration(const CConfig* config);
-
-  /*!
-   * \brief Destructor of the class.
-   */
-  ~CTurboIteration(void) override;
+  explicit CTurboIteration(const CConfig *config) : CFluidIteration(config) {}
 
   /*!
    * \brief Preprocessing to prepare for an iteration of the physics.
diff --git a/SU2_CFD/src/iteration/CAdjFluidIteration.cpp b/SU2_CFD/src/iteration/CAdjFluidIteration.cpp
@@ -28,8 +28,6 @@
 #include "../include/iteration/CAdjFluidIteration.hpp"
 #include "../include/output/COutput.hpp"
 
-CAdjFluidIteration::CAdjFluidIteration(const CConfig *config) : CFluidIteration(config) {}
-CAdjFluidIteration::~CAdjFluidIteration(void) {}
 void CAdjFluidIteration::Preprocess(COutput* output, CIntegration**** integration, CGeometry**** geometry,
                                     CSolver***** solver, CNumerics****** numerics, CConfig** config,
                                     CSurfaceMovement** surface_movement, CVolumetricMovement*** grid_movement,
diff --git a/SU2_CFD/src/iteration/CDiscAdjFluidIteration.cpp b/SU2_CFD/src/iteration/CDiscAdjFluidIteration.cpp
@@ -28,10 +28,6 @@
 #include "../include/iteration/CDiscAdjFluidIteration.hpp"
 #include "../include/output/COutput.hpp"
 
-CDiscAdjFluidIteration::CDiscAdjFluidIteration(const CConfig *config) : CIteration(config) {
-  turbulent = (config->GetKind_Solver() == DISC_ADJ_RANS || config->GetKind_Solver() == DISC_ADJ_INC_RANS);
-}
-
 CDiscAdjFluidIteration::~CDiscAdjFluidIteration(void) {}
 
 void CDiscAdjFluidIteration::Preprocess(COutput* output, CIntegration**** integration, CGeometry**** geometry,
diff --git a/SU2_CFD/src/iteration/CDiscAdjHeatIteration.cpp b/SU2_CFD/src/iteration/CDiscAdjHeatIteration.cpp
@@ -28,8 +28,6 @@
 #include "../include/iteration/CDiscAdjHeatIteration.hpp"
 #include "../include/output/COutput.hpp"
 
-CDiscAdjHeatIteration::CDiscAdjHeatIteration(const CConfig *config) : CIteration(config) {}
-
 CDiscAdjHeatIteration::~CDiscAdjHeatIteration(void) {}
 
 void CDiscAdjHeatIteration::Preprocess(COutput* output, CIntegration**** integration, CGeometry**** geometry,
diff --git a/SU2_CFD/src/iteration/CFEAIteration.cpp b/SU2_CFD/src/iteration/CFEAIteration.cpp
@@ -28,9 +28,6 @@
 #include "../include/iteration/CFEAIteration.hpp"
 #include "../include/output/COutput.hpp"
 
-CFEAIteration::CFEAIteration(const CConfig* config) : CIteration(config) {}
-CFEAIteration::~CFEAIteration(void) {}
-void CFEAIteration::Preprocess() {}
 void CFEAIteration::Iterate(COutput* output, CIntegration**** integration, CGeometry**** geometry, CSolver***** solver,
                             CNumerics****** numerics, CConfig** config, CSurfaceMovement** surface_movement,
                             CVolumetricMovement*** grid_movement, CFreeFormDefBox*** FFDBox, unsigned short val_iZone,
diff --git a/SU2_CFD/src/iteration/CFEMFluidIteration.cpp b/SU2_CFD/src/iteration/CFEMFluidIteration.cpp
diff --git a/SU2_CFD/src/iteration/CFluidIteration.cpp b/SU2_CFD/src/iteration/CFluidIteration.cpp
diff --git a/SU2_CFD/src/iteration/CHeatIteration.cpp b/SU2_CFD/src/iteration/CHeatIteration.cpp
diff --git a/SU2_CFD/src/iteration/CIteration.cpp b/SU2_CFD/src/iteration/CIteration.cpp
diff --git a/SU2_CFD/src/iteration/CTurboIteration.cpp b/SU2_CFD/src/iteration/CTurboIteration.cpp
