Discrete adjoint multi-zone for python wrapper (#2787)

* Change nested classes to friend classes

* Include discrete adjoint multizone driver in python wrapper

* Re-define AdjointProduct and Identity as template classes

* address comments

---------

Co-authored-by: Pedro Gomes <pcarruscag@gmail.com>

Author: EvertBunschoten

SU2_CFD/include/drivers/CDiscAdjMultizoneDriver.hpp

@@ -28,45 +28,21 @@
 #pragma once
 #include "CMultizoneDriver.hpp"
 #include "../../../Common/include/toolboxes/CQuasiNewtonInvLeastSquares.hpp"
-#include "../../../Common/include/linear_algebra/CPreconditioner.hpp"
-#include "../../../Common/include/linear_algebra/CMatrixVectorProduct.hpp"
 #include "../../../Common/include/linear_algebra/CSysSolve.hpp"
 
 /*!
  * \brief Block Gauss-Seidel driver for multizone / multiphysics discrete adjoint problems.
  * \ingroup DiscAdj
  */
+
 class CDiscAdjMultizoneDriver : public CMultizoneDriver {
 
 protected:
-#ifdef CODI_FORWARD_TYPE
-  using Scalar = su2double;
-#else
-  using Scalar = passivedouble;
-#endif
-
-  class AdjointProduct : public CMatrixVectorProduct<Scalar> {
-  public:
-    CDiscAdjMultizoneDriver* const driver;
-    const unsigned short iZone = 0;
-    mutable unsigned long iInnerIter = 0;
-
-    AdjointProduct(CDiscAdjMultizoneDriver* d, unsigned short i) : driver(d), iZone(i) {}
-
-    inline void operator()(const CSysVector<Scalar> & u, CSysVector<Scalar> & v) const override {
-      driver->SetAllSolutions(iZone, true, u);
-      driver->Iterate(iZone, iInnerIter, true);
-      driver->GetAllSolutions(iZone, true, v);
-      v -= u;
-      ++iInnerIter;
-    }
-  };
-
-  class Identity : public CPreconditioner<Scalar> {
-  public:
-    inline bool IsIdentity() const override { return true; }
-    inline void operator()(const CSysVector<Scalar> & u, CSysVector<Scalar> & v) const override { v = u; }
-  };
+  #ifdef CODI_FORWARD_TYPE
+    using Scalar = su2double;
+  #else
+    using Scalar = passivedouble;
+  #endif
 
   /*!
    * \brief Kinds of recordings.
@@ -161,14 +137,14 @@ class CDiscAdjMultizoneDriver : public CMultizoneDriver {
    */
   void Run() override;
 
-protected:
-
   /*!
    * \brief Run one inner iteration for a given zone.
    * \return The result of "monitor".
    */
   bool Iterate(unsigned short iZone, unsigned long iInnerIter, bool KrylovMode = false);
 
+protected:
+
   /*!
    * \brief Run inner iterations using a Krylov method (GMRES atm).
    */

SU2_CFD/include/drivers/CDriver.hpp

@@ -352,6 +352,7 @@ class CDriver : public CDriverBase {
    */
   void PrintDirectResidual(RECORDING kind_recording);
 
+ public:
   /*!
    * \brief Set the solution of all solvers (adjoint or primal) in a zone.
    * \param[in] iZone - Index of the zone.
@@ -364,7 +365,7 @@ class CDriver : public CDriverBase {
     const auto nPoint = geometry_container[iZone][INST_0][MESH_0]->GetnPoint();
     for (auto iSol = 0u, offset = 0u; iSol < MAX_SOLS; ++iSol) {
       auto solver = solver_container[iZone][INST_0][MESH_0][iSol];
-      if (!(solver && (solver->GetAdjoint() == adjoint))) continue;
+      if (!solver || solver->GetAdjoint() != adjoint) continue;
       for (auto iPoint = 0ul; iPoint < nPoint; ++iPoint)
         for (auto iVar = 0ul; iVar < solver->GetnVar(); ++iVar)
           if (!Old) {
@@ -395,7 +396,7 @@ class CDriver : public CDriverBase {
     const auto nPoint = geometry_container[iZone][INST_0][MESH_0]->GetnPoint();
     for (auto iSol = 0u, offset = 0u; iSol < MAX_SOLS; ++iSol) {
       auto solver = solver_container[iZone][INST_0][MESH_0][iSol];
-      if (!(solver && (solver->GetAdjoint() == adjoint))) continue;
+      if (!solver || solver->GetAdjoint() != adjoint) continue;
       const auto& sol = solver->GetNodes()->GetSolution();
       for (auto iPoint = 0ul; iPoint < nPoint; ++iPoint)
         for (auto iVar = 0ul; iVar < solver->GetnVar(); ++iVar)
@@ -419,7 +420,6 @@ class CDriver : public CDriverBase {
     return nVar;
   }
 
- public:
   /*!
    * \brief Launch the computation for all zones and all physics.
    */

SU2_CFD/src/drivers/CDiscAdjMultizoneDriver.cpp

@@ -30,6 +30,39 @@
 #include "../../include/output/COutputFactory.hpp"
 #include "../../include/output/COutput.hpp"
 #include "../../include/iteration/CIterationFactory.hpp"
+#include "../../../Common/include/linear_algebra/CPreconditioner.hpp"
+#include "../../../Common/include/linear_algebra/CMatrixVectorProduct.hpp"
+
+namespace {
+#ifdef CODI_FORWARD_TYPE
+  using Scalar = su2double;
+#else
+  using Scalar = passivedouble;
+#endif
+
+class AdjointProduct : public CMatrixVectorProduct<Scalar> {
+public:
+  CDiscAdjMultizoneDriver* const driver;
+  const unsigned short iZone = 0;
+  mutable unsigned long iInnerIter = 0;
+
+  AdjointProduct(CDiscAdjMultizoneDriver* d, unsigned short i) : driver(d), iZone(i) {}
+
+  inline void operator()(const CSysVector<Scalar>& u, CSysVector<Scalar>& v) const override {
+    driver->SetAllSolutions(iZone, true, u);
+    driver->Iterate(iZone, iInnerIter, true);
+    driver->GetAllSolutions(iZone, true, v);
+    v -= u;
+    ++iInnerIter;
+  }
+};
+
+class Identity : public CPreconditioner<Scalar> {
+public:
+  inline bool IsIdentity() const override { return true; }
+  inline void operator()(const CSysVector<Scalar>& u, CSysVector<Scalar>& v) const override { v = u; }
+};
+} // namespace
 
 CDiscAdjMultizoneDriver::CDiscAdjMultizoneDriver(char* confFile,
                                                  unsigned short val_nZone,

SU2_PY/pySU2/pySU2ad.i

@@ -39,6 +39,7 @@ threads="1"
 %{
 #include "../../Common/include/containers/CPyWrapperMatrixView.hpp"
 #include "../../SU2_CFD/include/drivers/CDiscAdjSinglezoneDriver.hpp"
+#include "../../SU2_CFD/include/drivers/CDiscAdjMultizoneDriver.hpp"
 #include "../../SU2_CFD/include/drivers/CDriver.hpp"
 #include "../../SU2_CFD/include/drivers/CDriverBase.hpp"
 #include "../../SU2_CFD/include/drivers/CMultizoneDriver.hpp"
@@ -98,4 +99,5 @@ const unsigned int ZONE_1 = 1; /*!< \brief Definition of the first grid domain.
 %include "../../SU2_CFD/include/drivers/CSinglezoneDriver.hpp"
 %include "../../SU2_CFD/include/drivers/CMultizoneDriver.hpp"
 %include "../../SU2_CFD/include/drivers/CDiscAdjSinglezoneDriver.hpp"
+%include "../../SU2_CFD/include/drivers/CDiscAdjMultizoneDriver.hpp"
 %include "../../SU2_DEF/include/drivers/CDiscAdjDeformationDriver.hpp"