Merge pull request #1922 from su2code/document_python_wrapper

Doxygen module for python wrapper functions and fixed memory errors

Author: pcarruscag

Docs/docmain.hpp

@@ -25,10 +25,10 @@
  * License along with SU2. If not, see <http://www.gnu.org/licenses/>.
  */
 
-/*! 
+/*!
  * \mainpage SU2 version 7.5.1 "Blackbird"
  * SU2 suite is an open-source collection of C++ based software tools
- * to perform PDE analysis and PDE constrained optimization.  The toolset is designed with 
+ * to perform PDE analysis and PDE constrained optimization.  The toolset is designed with
  * computational fluid dynamics and aerodynamic shape optimization in mind, but is extensible to
  * include other families of governing equations such as potential flow, electrodynamics, chemically reacting
  * flows, and many others.  SU2 is released under an open-source license.
@@ -66,43 +66,43 @@
 
 /*!
  * \defgroup ConvDiscr Discretization of the convective terms
- * \brief Group of classes which define the numerical methods for 
- *		  discretizing the convective terms of a Partial Differential Equation. 
- *		  There are methods for solving the direct, adjoint and linearized 
+ * \brief Group of classes which define the numerical methods for
+ *		  discretizing the convective terms of a Partial Differential Equation.
+ *		  There are methods for solving the direct, adjoint and linearized
  *		  systems of equations.
  */
 
 /*!
  * \defgroup ViscDiscr Discretization of the viscous terms
- * \brief Group of classes which define the numerical methods for 
- *		  discretizing the viscous terms of a Partial Differential Equation. 
- *		  There are methods for solving the direct, adjoint and linearized 
+ * \brief Group of classes which define the numerical methods for
+ *		  discretizing the viscous terms of a Partial Differential Equation.
+ *		  There are methods for solving the direct, adjoint and linearized
  *		  systems of equations.
  */
 
 /*!
  * \defgroup SourceDiscr Discretization of the source terms
- * \brief Group of classes which define the numerical methods for 
- *		  discretizing the source terms of a Partial Differential Equation. 
- *		  There are methods for solving the direct, adjoint and linearized 
+ * \brief Group of classes which define the numerical methods for
+ *		  discretizing the source terms of a Partial Differential Equation.
+ *		  There are methods for solving the direct, adjoint and linearized
  *		  systems of equations.
  */
 
 /*!
  * \defgroup Euler_Equations Solving the Euler equations
- * \brief Group of classes which define the system of Euler equations in 
+ * \brief Group of classes which define the system of Euler equations in
  *		  three formulations: direct, adjoint, and linearized.
  */
 
 /*!
  * \defgroup Navier_Stokes_Equations Solving the Navier-Stokes equations
- * \brief Group of classes which define the system of Navier-Stokes equations in 
+ * \brief Group of classes which define the system of Navier-Stokes equations in
  *		  three formulations: direct, adjoint, and linearized.
  */
 
 /*!
  * \defgroup Turbulence_Model Solving the turbulence model equations
- * \brief Group of classes which define the turbulence model in 
+ * \brief Group of classes which define the turbulence model in
  *		  three formulations: direct, adjoint, and linearized.
  */
 
@@ -130,6 +130,13 @@
  *        space and time integration. The latter use mostly the "Solvers".
  */
 
+/*!
+ * \defgroup PySU2 Python Wrapper functions
+ * \brief Functions of the driver classes (\ref Drivers) that can be used to customize SU2
+ *        via Python. For example, set custom temperature distributions at boundaries,
+ *        deform the mesh, etc.
+ */
+
 /*!
  * \defgroup Variable Storing solution variables
  * \brief Classes used to store and access the solution variables of all types of problems.

SU2_CFD/include/drivers/CDriver.hpp

@@ -74,6 +74,8 @@ class CDriver : public CDriverBase {
       fsi,         /*!< \brief FSI simulation flag.*/
       fem_solver;  /*!< \brief FEM fluid solver simulation flag. */
 
+  CFreeFormDefBox*** FFDBox;            /*!< \brief FFD FFDBoxes of the problem. */
+
   CIteration*** iteration_container;      /*!< \brief Container vector with all the iteration methods. */
   CIntegration**** integration_container; /*!< \brief Container vector with all the integration methods. */
   vector<vector<unique_ptr<CInterpolator>>>
@@ -401,6 +403,9 @@ class CDriver : public CDriverBase {
    */
   virtual void SetInitialMesh() {}
 
+/// \addtogroup PySU2
+/// \{
+
   /*!
    * \brief Process the boundary conditions and update the multi-grid structure.
    */
@@ -642,6 +647,8 @@ class CDriver : public CDriverBase {
    */
   void SetInlet_Angle(unsigned short iMarker, passivedouble alpha);
 
+/// \}
+
   /*!
    * \brief Sum the number of primal or adjoint variables for all solvers in a given zone.
    * \param[in] iZone - Index of the zone.

SU2_CFD/include/drivers/CDriverBase.hpp

@@ -62,8 +62,8 @@ class CDriverBase {
       *nInst,            /*!< \brief Total number of instances in the problem (per zone). */
       **interface_types; /*!< \brief Type of coupling between the distinct (physical) zones. */
 
-  CConfig* driver_config; /*!< \brief Definition of the driver configuration. */
-  COutput* driver_output; /*!< \brief Definition of the driver output. */
+  CConfig* driver_config = nullptr; /*!< \brief Definition of the driver configuration. */
+  COutput* driver_output = nullptr; /*!< \brief Definition of the driver output. */
 
   CConfig** config_container;           /*!< \brief Definition of the particular problem. */
   COutput** output_container;           /*!< \brief Pointer to the COutput class. */
@@ -73,10 +73,9 @@ class CDriverBase {
                                            are solved). */
   CSurfaceMovement** surface_movement;  /*!< \brief Surface movement classes of the problem. */
   CVolumetricMovement*** grid_movement; /*!< \brief Volume grid movement classes of the problem. */
-  CFreeFormDefBox*** FFDBox;            /*!< \brief FFD FFDBoxes of the problem. */
 
-  CConfig* main_config;     /*!< \brief Reference to base (i.e. ZONE 0) configuration (used in driver API). */
-  CGeometry* main_geometry; /*!< \brief Reference to base (i.e. ZONE, INST, MESH 0) geometry (used in driver API). */
+  CConfig* main_config = nullptr;     /*!< \brief Reference to base (i.e. ZONE 0) configuration (used in driver API). */
+  CGeometry* main_geometry = nullptr; /*!< \brief Reference to base (i.e. ZONE, INST, MESH 0) geometry (used in driver API). */
 
  public:
   /*!
@@ -122,6 +121,9 @@ class CDriverBase {
    */
   virtual void Postprocessing(){}
 
+/// \addtogroup PySU2
+/// @{
+
   /*!
    * \brief Get the number of design variables.
    * \return Number of design variables.
@@ -321,13 +323,19 @@ class CDriverBase {
    * \brief Communicate the boundary mesh displacements.
    */
   void CommunicateMeshDisplacements(void);
+/// \}
 
  protected:
   /*!
    * \brief Initialize containers.
    */
   void SetContainers_Null();
 
+  /*!
+   * \brief Delete containers.
+   */
+  void CommonPostprocessing();
+
   /*!
    * \brief Read in the config and mesh files.
    * \param[in] config - Definition of the particular problem.

SU2_CFD/src/drivers/CDriverBase.cpp

@@ -42,36 +42,92 @@ void CDriverBase::SetContainers_Null() {
    * down a hierarchy over all zones, multi-grid levels, equation sets, and equation terms as described in the comments
    * below. ---*/
 
-  config_container = nullptr;
-  output_container = nullptr;
-  geometry_container = nullptr;
-  solver_container = nullptr;
-  numerics_container = nullptr;
-
-  surface_movement = nullptr;
-  grid_movement = nullptr;
-  FFDBox = nullptr;
-
   config_container = new CConfig*[nZone]();
   output_container = new COutput*[nZone]();
   geometry_container = new CGeometry***[nZone]();
   solver_container = new CSolver****[nZone]();
   numerics_container = new CNumerics*****[nZone]();
   surface_movement = new CSurfaceMovement*[nZone]();
   grid_movement = new CVolumetricMovement**[nZone]();
-  FFDBox = new CFreeFormDefBox**[nZone]();
 
   nInst = new unsigned short[nZone];
 
   for (iZone = 0; iZone < nZone; iZone++) {
     nInst[iZone] = 1;
   }
+}
+
+void CDriverBase::CommonPostprocessing() {
+
+  if (numerics_container != nullptr) {
+    for (iZone = 0; iZone < nZone; iZone++) {
+      delete[] numerics_container[iZone];
+    }
+    delete[] numerics_container;
+  }
+  if (rank == MASTER_NODE) cout << "Deleted CNumerics container." << endl;
+
+  if (solver_container != nullptr) {
+    for (iZone = 0; iZone < nZone; iZone++) {
+      delete[] solver_container[iZone];
+    }
+    delete[] solver_container;
+  }
+  if (rank == MASTER_NODE) cout << "Deleted CSolver container." << endl;
+
+  if (geometry_container != nullptr) {
+    for (iZone = 0; iZone < nZone; iZone++) {
+      if (geometry_container[iZone] != nullptr) {
+        for (iInst = 0; iInst < nInst[iZone]; iInst++) {
+          delete geometry_container[iZone][iInst][MESH_0];
+          delete[] geometry_container[iZone][iInst];
+        }
+        delete[] geometry_container[iZone];
+      }
+    }
+    delete[] geometry_container;
+  }
+  if (rank == MASTER_NODE) cout << "Deleted CGeometry container." << endl;
+
+  if (surface_movement != nullptr) {
+    for (iZone = 0; iZone < nZone; iZone++) {
+      delete surface_movement[iZone];
+    }
+    delete[] surface_movement;
+  }
+  if (rank == MASTER_NODE) cout << "Deleted CSurfaceMovement class." << endl;
+
+  if (grid_movement != nullptr) {
+    for (iZone = 0; iZone < nZone; iZone++) {
+      if (grid_movement[iZone] != nullptr) {
+        for (iInst = 0; iInst < nInst[iZone]; iInst++) {
+          delete grid_movement[iZone][iInst];
+        }
+        delete[] grid_movement[iZone];
+      }
+    }
+    delete[] grid_movement;
+  }
+  if (rank == MASTER_NODE) cout << "Deleted CVolumetricMovement class." << endl;
 
-  driver_config = nullptr;
-  driver_output = nullptr;
+  if (config_container != nullptr) {
+    for (iZone = 0; iZone < nZone; iZone++) {
+      delete config_container[iZone];
+    }
+    delete[] config_container;
+  }
+  delete driver_config;
+  if (rank == MASTER_NODE) cout << "Deleted CConfig container." << endl;
+
+  if (output_container != nullptr) {
+    for (iZone = 0; iZone < nZone; iZone++) {
+      delete output_container[iZone];
+    }
+    delete[] output_container;
+  }
+  if (rank == MASTER_NODE) cout << "Deleted COutput class." << endl;
 
-  main_config = nullptr;
-  main_geometry = nullptr;
+  delete[] nInst;
 }
 
 unsigned short CDriverBase::GetNumberDesignVariables() const { return main_config->GetnDV(); }

SU2_DEF/include/SU2_DEF.hpp

@@ -48,11 +48,6 @@ class CDeformationDriver : public CDriverBase {
    */
   CDeformationDriver(char* confFile, SU2_Comm MPICommunicator);
 
-  /*!
-   * \brief Destructor of the class.
-   */
-  ~CDeformationDriver(void);
-
   /*!
    * \brief Preprocess the driver data.
    */