Chore in discrete adjoint bits

SU2_CFD/include/drivers/CMultizoneDriver.hpp

@@ -129,6 +129,11 @@ class CMultizoneDriver : public CDriver {
    */
   bool Transfer_Data(unsigned short donorZone, unsigned short targetZone);
 
+  /*!
+   * \brief Check if simulation converged and return appropriate boolean.
+   * \param[in] TimeIter - Current time iteration.
+   * \return Boolean that indicates to stop the iteration loop.
+   */
   bool Monitor(unsigned long TimeIter) override;
 
   /*!

SU2_CFD/include/solvers/CDiscAdjSolver.hpp

@@ -108,7 +108,7 @@ class CDiscAdjSolver final : public CSolver {
 
   /*!
    * \brief Sets the adjoint values of the output of the flow (+turb.) iteration
-   *         before evaluation of the tape.
+   *        before evaluation of the tape.
    * \param[in] geometry - The geometrical definition of the problem.
    * \param[in] config - The particular config.
    */

SU2_CFD/include/variables/CDiscAdjVariable.hpp

@@ -37,16 +37,16 @@
  */
 class CDiscAdjVariable final : public CVariable {
 private:
-  MatrixType Sensitivity; /* Vector holding the derivative of target functional with respect to the coordinates at this node*/
-  MatrixType Solution_Direct; // TK:: Description missing
-  MatrixType DualTime_Derivative; // TK:: Description missing
-  MatrixType DualTime_Derivative_n; // TK:: Description missing
+  MatrixType Sensitivity; /*!< \brief Vector holding the derivative of target functional with respect to the coordinates at this node*/
+  MatrixType Solution_Direct; /*!< \brief  TK:: ?? Stores the primal solution of the current timestep in order to be able to reset. */
+  MatrixType DualTime_Derivative; /*!< \brief Container holding all dual time contributions to the adjoint variable. */
+  MatrixType DualTime_Derivative_n; /*!< \brief Container holding dual time contributions to the adjoint variable used in the next timestep. */
 
-  MatrixType Solution_Geometry; // TK:: Description missing
-  MatrixType Solution_Geometry_Old; // TK:: Description missing
-  MatrixType Geometry_Direct; // TK:: Description missing
+  MatrixType Solution_Geometry; /*!< \brief TK:: Description missing. */
+  MatrixType Solution_Geometry_Old; /*!< \brief TK:: Description missing. */
+  MatrixType Geometry_Direct; /*!< \brief TK:: Description missing. */
 
-  MatrixType Solution_Geometry_BGS_k; // TK:: Description missing
+  MatrixType Solution_Geometry_BGS_k; /*!< \brief TK:: Description missing. */
 
 public:
   /*!
@@ -66,6 +66,7 @@ class CDiscAdjVariable final : public CVariable {
 
   /*!
    * \brief Set the sensitivity at the node
+   * \param[in] iPoint - Point index
    * \param[in] iDim - spacial component
    * \param[in] val - value of the Sensitivity
    */
@@ -75,40 +76,69 @@ class CDiscAdjVariable final : public CVariable {
 
   /*!
    * \brief Get the Sensitivity at the node
+   * \param[in] iPoint - Point index
    * \param[in] iDim - spacial component
    * \return value of the Sensitivity
    */
   inline su2double GetSensitivity(unsigned long iPoint, unsigned long iDim) const override {
     return Sensitivity(iPoint,iDim);
   }
 
-  // TK:: Description missing
+  /*!
+   * \brief Set/store the dual time contributions to the adjoint variable. Contains contributions from 2 timesteps for dual time 2nd order.
+   * \param[in] iPoint - Point index
+   * \param[in] iVar - Index of the variable
+   * \param[in] der - Derivative value
+   */
   inline void SetDual_Time_Derivative(unsigned long iPoint, unsigned long iVar, su2double der) override {
     DualTime_Derivative(iPoint,iVar) = der;
   }
 
-  // TK:: Description missing
+  /*!
+   * \brief Set/store the dual time contributions to the adjoint variable for upcoming timestep.
+   * \param[in] iPoint - Point index
+   * \param[in] iVar - Index of the variable
+   * \param[in] der - Derivative value
+   */
   inline void SetDual_Time_Derivative_n(unsigned long iPoint, unsigned long iVar, su2double der) override {
     DualTime_Derivative_n(iPoint,iVar) = der;
   }
 
-  // TK:: Description missing
+  /*!
+   * \brief Return the dual time contributions to the adjoint variable. Contains contributions from 2 timesteps for dual time 2nd order.
+   * \param[in] iPoint - Point index
+   * \param[in] iVar - Index of the variable
+   * \return Derivative value
+   */
   inline su2double GetDual_Time_Derivative(unsigned long iPoint, unsigned long iVar) const override {
     return DualTime_Derivative(iPoint,iVar);
   }
 
-  // TK:: Description missing
+  /*!
+   * \brief Return the dual time contributions to the adjoint variable for upcoming timestep.
+   * \param[in] iPoint - Point index
+   * \param[in] iVar - Index of the variable
+   * \return Derivative value
+   */
   inline su2double GetDual_Time_Derivative_n(unsigned long iPoint, unsigned long iVar) const override {
     return DualTime_Derivative_n(iPoint,iVar);
   }
 
-  // TK:: Description missing
+  /*!
+   * \brief Set/store the primal solution for all variables of one point.
+   * \param[in] iPoint - Point index
+   * \param[in] *val_solution_direct - pointer to all variables of iPoint
+   */
   inline void SetSolution_Direct(unsigned long iPoint, const su2double *val_solution_direct) override {
     for (unsigned long iVar = 0; iVar < nVar; iVar++)
       Solution_Direct(iPoint,iVar) = val_solution_direct[iVar];
   }
 
-  // TK:: Description missing
+  /*!
+   * \brief Returns the primal solution for all variables of one point.
+   * \param[in] iPoint - Point index
+   * \return Pointer to all variables of iPoint
+   */
   inline su2double* GetSolution_Direct(unsigned long iPoint) override { return Solution_Direct[iPoint]; }
 
   /*!

SU2_CFD/include/variables/CHeatVariable.hpp

@@ -72,4 +72,10 @@ class CHeatVariable final : public CVariable {
   inline CVectorOfMatrix& GetGradient_Reconstruction() final { return Gradient_Reconstruction; }
   inline const CVectorOfMatrix& GetGradient_Reconstruction() const final { return Gradient_Reconstruction; }
 
+  /*!
+   * \brief Get the temperature of the point.
+   * \return Value of the temperature of the point.
+   */
+  inline su2double GetTemperature(unsigned long iPoint) const final { return Solution(iPoint,0); }
+
 };

SU2_CFD/include/variables/CVariable.hpp

@@ -2260,7 +2260,7 @@ class CVariable {
   }
 
   /*!
-   * \brief Set the adjoint values of the solution at time n.
+   * \brief Set the adjoint values of the solution at time n. TK:: unused func
    * \param[in] adj_sol - The adjoint values of the solution.
    */
   inline void SetAdjointSolution_time_n(unsigned long iPoint, const su2double *adj_sol) {
@@ -2278,7 +2278,7 @@ class CVariable {
   }
 
   /*!
-   * \brief Set the adjoint values of the solution at time n-1.
+   * \brief Set the adjoint values of the solution at time n-1. TK:: unused func
    * \param[in] adj_sol - The adjoint values of the solution.
    */
   inline void SetAdjointSolution_time_n1(unsigned long iPoint, const su2double *adj_sol) {

SU2_CFD/src/drivers/CDiscAdjMultizoneDriver.cpp

@@ -134,7 +134,7 @@ void CDiscAdjMultizoneDriver::StartSolver() {
 
     cout << "\nSimulation Run using the Discrete Adjoint Multizone Driver" << endl;
 
-    if (driver_config->GetTime_Domain())
+    if (driver_config->GetTime_Domain()) // TobiKattmann:: Remove the error and introduce time iteration
       SU2_MPI::Error("The discrete adjoint multizone driver is not ready for unsteady computations yet.",
                      CURRENT_FUNCTION);
   }
@@ -173,7 +173,7 @@ bool CDiscAdjMultizoneDriver::Iterate(unsigned short iZone, unsigned long iInner
   ComputeAdjoints(iZone, eval_transfer);
 
   /*--- Extracting adjoints for solvers in iZone w.r.t. to outputs in iZone (diagonal part). ---*/
-
+  // TobiKattmann:: Make sure to extract correct sensitivities here
   iteration_container[iZone][INST_0]->Iterate(output_container[iZone], integration_container, geometry_container,
                                               solver_container, numerics_container, config_container,
                                               surface_movement, grid_movement, FFDBox, iZone, INST_0);
@@ -288,13 +288,13 @@ void CDiscAdjMultizoneDriver::Run() {
      *    if the current recording is different from them.
      *
      *    To set the tape appropriately, the following recording methods are provided:
-     *    (1) NONE: All information from a previous recording is removed.
+     *    (1) CLEAR_INDICES: All information from a previous recording is removed.
      *    (2) SOLUTION_VARIABLES: State variables of all solvers in a zone as input.
      *    (3) MESH_COORDS / MESH_DEFORM: Mesh coordinates as input.
      *    (4) SOLUTION_AND_MESH: Mesh coordinates and state variables as input.
      *
      *    By default, all (state and mesh coordinate variables) will be declared as output,
-     *    since it does not change the computational effort. ---*/
+     *    since it does not change the computational effort, just the memory consumption of the tape. ---*/
 
 
     /*--- If we want to set up zone-specific tapes (retape), we do not need to record
@@ -421,6 +421,8 @@ void CDiscAdjMultizoneDriver::Run() {
         }
       }
 
+      // TobiKattmann:: Add dual time terms dG/du from n+1 and N+2 to external
+
       /*--- Compute residual from Solution and Solution_BGS_k and update the latter. ---*/
 
       SetResidual_BGS(iZone);
@@ -828,18 +830,17 @@ void CDiscAdjMultizoneDriver::SetObjFunction(RECORDING kind_recording) {
 
 void CDiscAdjMultizoneDriver::SetAdj_ObjFunction() {
 
-  bool time_stepping = config_container[ZONE_0]->GetTime_Marching() != TIME_MARCHING::STEADY;
-  unsigned long IterAvg_Obj = config_container[ZONE_0]->GetIter_Avg_Objective();
+  const auto IterAvg_Obj = config_container[ZONE_0]->GetIter_Avg_Objective();
   su2double seeding = 1.0;
 
-  if (time_stepping){
+  if (config_container[ZONE_0]->GetTime_Marching() != TIME_MARCHING::STEADY){
     if (TimeIter < IterAvg_Obj){
       // Default behavior (in case no specific window is chosen) is to use Square-Windowing, i.e. the numerator equals 1.0
       auto windowEvaluator = CWindowingTools();
       su2double weight = windowEvaluator.GetWndWeight(config_container[ZONE_0]->GetKindWindow(), TimeIter, IterAvg_Obj-1);
       seeding = weight / IterAvg_Obj;
     }
-    else{
+    else {
       seeding = 0.0;
     }
   }
@@ -850,8 +851,8 @@ void CDiscAdjMultizoneDriver::SetAdj_ObjFunction() {
 
 void CDiscAdjMultizoneDriver::ComputeAdjoints(unsigned short iZone, bool eval_transfer) {
 
-  unsigned short enter_izone = iZone*2+1 + ITERATION_READY;
-  unsigned short leave_izone = iZone*2 + ITERATION_READY;
+  const unsigned short enter_izone = iZone*2+1 + ITERATION_READY;
+  const unsigned short leave_izone = iZone*2 + ITERATION_READY;
 
   AD::ClearAdjoints();
 
@@ -864,7 +865,7 @@ void CDiscAdjMultizoneDriver::ComputeAdjoints(unsigned short iZone, bool eval_tr
 
   AD::ComputeAdjoint(enter_izone, leave_izone);
 
-  /*--- Compute adjoints of transfer and mesh deformation routines, only stricktly needed
+  /*--- Compute adjoints of transfer and mesh deformation routines, only strictly needed
    *    on the last inner iteration. Structural problems have some minor issue and we
    *    need to evaluate this section on every iteration. ---*/