CInterface.hpp

Go to the documentation of this file.

/*!
 * \file CInterface.hpp
 * \brief Declarations and inlines of the transfer structure.
 *        The subroutines and functions are in the physics folders.
 * \author R. Sanchez
 * \version 8.5.0 "Harrier"
 *
 * SU2 Project Website: https://su2code.github.io
 *
 * The SU2 Project is maintained by the SU2 Foundation
 * (http://su2foundation.org)
 *
 * Copyright 2012-2026, SU2 Contributors (cf. AUTHORS.md)
 *
 * SU2 is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * SU2 is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with SU2. If not, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "../../../Common/include/parallelization/mpi_structure.hpp"
#include "../../../Common/include/containers/C2DContainer.hpp"
#include "../../../Common/include/option_structure.hpp"
 
#include <cmath>
#include <string>
#include <fstream>
#include <sstream>
#include <algorithm>
#include <iostream>
#include <vector>
#include <stdlib.h>
#include <stdio.h>
 
class CConfig;
class CGeometry;
class CSolver;
class CInterpolator;
 
using namespace std;
 
/*!
 * \class CInterface
 * \ingroup Interfaces
 * \brief Main class for defining the physical transfer of information.
 * \author R. Sanchez
 * \version 8.5.0 "Harrier"
 */
 
class CInterface {
protected:
 
  const int rank;   /*!< \brief MPI Rank. */
  const int size;   /*!< \brief MPI Size. */
 
  su2double *Physical_Constants = nullptr;
  su2double *Donor_Variable = nullptr;
  su2double *Target_Variable = nullptr;
  bool valAggregated = false;
 
  unsigned short InterfaceType; /*!< \brief The type of interface. */
 
  /*--- Mixing Plane interface variable ---*/
  su2double *SpanValueCoeffTarget = nullptr;
  unsigned short *SpanLevelDonor = nullptr;
  unsigned short nSpanMaxAllZones = 0;
 
  unsigned short nVar = 0;
  static constexpr size_t MAXNDIM = 3;  /*!< \brief Max number of space dimensions, used in some static arrays. */
 
public:
  /*!
   * \brief Constructor of the class.
   */
  CInterface();
 
  /*!
   * \overload
   * \param[in] val_nVar - Number of variables that need to be transferred.
   * \param[in] val_nConst - Number of physical constants that need to be taken into account.
   */
  CInterface(unsigned short val_nVar, unsigned short val_nConst);
 
  /*!
   * \brief Destructor of the class.
   */
  virtual ~CInterface();
 
  /*!
   * \brief Interpolate data and broadcast it into all processors, for nonmatching meshes.
   * \param[in] interpolator - Object defining the interpolation.
   * \param[in] donor_solution - Solution from the donor mesh.
   * \param[in] target_solution - Solution from the target mesh.
   * \param[in] donor_geometry - Geometry of the donor mesh.
   * \param[in] target_geometry - Geometry of the target mesh.
   * \param[in] donor_config - Definition of the problem at the donor mesh.
   * \param[in] target_config - Definition of the problem at the target mesh.
   */
  void BroadcastData(const CInterpolator& interpolator,
                     CSolver *donor_solution, CSolver *target_solution,
                     CGeometry *donor_geometry, CGeometry *target_geometry,
                     const CConfig *donor_config, const CConfig *target_config);
 
protected:
  /*!
   * \brief A virtual member.
   */
  inline virtual void GetPhysical_Constants(CSolver *donor_solution, CSolver *target_solution,
                                            CGeometry *donor_geometry, CGeometry *target_geometry,
                                            const CConfig *donor_config, const CConfig *target_config) { }
  /*!
   * \brief A virtual member.
   * \param[in] donor_solution - Solution from the donor mesh.
   * \param[in] donor_geometry - Geometry of the donor mesh.
   * \param[in] donor_config - Definition of the problem at the donor mesh.
   * \param[in] Marker_Donor - Index of the donor marker.
   * \param[in] Vertex_Donor - Index of the donor vertex.
   */
  virtual void GetDonor_Variable(CSolver *donor_solution, CGeometry *donor_geometry,
                                 const CConfig *donor_config, unsigned long Marker_Donor,
                                 unsigned long Vertex_Donor, unsigned long Point_Donor) = 0;
 
  /*!
   * \brief A virtual member.
   * \param[in] donor_config - Definition of the problem at the donor mesh.
   * \param[in] donor_geometry - Geometry of the donor mesh.
   * \param[in] target_config - Definition of the problem at the target mesh.
   * \param[in] target_geometry - Geometry of the target mesh.
   */
  inline virtual void GetDonor_Velocity_RotatingFrame(const CConfig *donor_config, CGeometry *donor_geometry,
                                 const CConfig *target_config, CGeometry *target_geometry) {}
 
  /*!
   * \brief Initializes the target variable.
   * \param[in] target_solution - Solution from the target mesh.
   * \param[in] Marker_Target - Index of the target marker.
   * \param[in] Vertex_Target - Index of the target vertex.
   * \param[in] nDonorPoints - Number of donor points.
   */
  inline virtual void InitializeTarget_Variable(CSolver *target_solution, unsigned long Marker_Target,
                                                unsigned long Vertex_Target, unsigned short nDonorPoints){
    for (unsigned short iVar = 0; iVar < nVar; iVar++) Target_Variable[iVar] = 0.0;
  }
 
  /*!
   * \brief Recovers the target variable from the buffer of su2doubles that was broadcast.
   * \param[in] bcastVariable - Broadcast variable.
   * \param[in] donorCoeff - value of the donor coefficient.
   */
  inline virtual void RecoverTarget_Variable(const su2double *bcastVariable, su2double donorCoeff) {
    for (auto iVar = 0u; iVar < nVar; iVar++) Target_Variable[iVar] += donorCoeff * bcastVariable[iVar];
  }
 
  /*!
   * \brief Recovers the target variable at the endwall from the buffer of su2doubles that was broadcast for mixing plane interfaces.
   * \param[in] bcastVariable - Broadcast variable.
   * \param[in] idx - Index of the target point.
   */
  inline virtual void RecoverTarget_SpanEndwall(const su2activevector &bcastVariable, unsigned long idx) { }
 
  /*!
   * \brief Recovers the target variable at the span from the buffer of su2doubles that was broadcast for mixing plane interfaces.
   * \param[in] bcastVariable - Broadcast variable.
   * \param[in] idx - Index of the target point.
   * \param[in] donorCoeff - value of the donor coefficient.
   */
  inline virtual void RecoverTarget_Span(const su2activevector &bcastVariable, unsigned long idx, su2double donorCoeff) { }
 
  /*!
   * \brief A virtual member.
   * \param[in] target_solution - Solution from the target mesh.
   * \param[in] target_geometry - Geometry of the target mesh.
   * \param[in] target_config - Definition of the problem at the target mesh.
   * \param[in] Marker_Target - Index of the target marker.
   * \param[in] Vertex_Target - Index of the target vertex.
   * \param[in] Point_Target - Index of the target point.
   */
  virtual void SetTarget_Variable(CSolver *target_solution, CGeometry *target_geometry,
                                  const CConfig *target_config, unsigned long Marker_Target,
                                  unsigned long Vertex_Target, unsigned long Point_Target) = 0;
 
  /*!
   * \brief A virtual member.
   * \param[in] donor_geometry - Geometry of the target mesh.
   * \param[in] target_geometry - Geometry of the target mesh.
   * \param[in] donor_zone - Index of the donorZone.
   */
  inline virtual void SetAverageTurboGeoValues(CGeometry *donor_geometry, CGeometry *target_geometry,
                                               unsigned short donorZone) { }
 
public:
  /*!
   * \brief A virtual member.
   * \param[in] donor_config - Definition of the problem at the donor mesh.
   * \param[in] target_config - Definition of the problem at the target mesh.
   */
  inline virtual void SetSpanWiseLevels(const CConfig *donor_config, const CConfig *target_config) { }
 
  /*!
   * \brief Interpolate data and broadcast it into all processors, for nonmatching meshes.
   * \param[in] interpolator - Object defining the interpolation.
   * \param[in] donor_solution - Solution from the donor mesh.
   * \param[in] target_solution - Solution from the target mesh.
   * \param[in] donor_geometry - Geometry of the donor mesh.
   * \param[in] target_geometry - Geometry of the target mesh.
   * \param[in] donor_config - Definition of the problem at the donor mesh.
   * \param[in] target_config - Definition of the problem at the target mesh.
   */
  inline virtual void BroadcastData_MixingPlane(const CInterpolator& interpolator,
                     CSolver *donor_solution, CSolver *target_solution,
                     CGeometry *donor_geometry, CGeometry *target_geometry,
                     const CConfig *donor_config, const CConfig *target_config) { };
 
 
  /*!
   * \brief Set the contact resistance value for the solid-to-solid heat transfer interface.
   * \param[in] val_contact_resistance - Contact resistance value in m^2/W
   */
  inline virtual void SetContactResistance(su2double val_contact_resistance) {};
 
  /*!
   * \brief Set the type of an interface
   * \param[in] interface_type - The type of interface
   */
  void SetInterfaceType(unsigned short interface_type) { InterfaceType = interface_type; }
 
  /*!
   * \brief Get the type of an interface
   */
  unsigned short GetInterfaceType(void) const { return InterfaceType; }
 
  /*!
   * \brief These can be used to chain interfaces between the same zones but for other variables,
   * without having to mix physics in the interface classes. Currently this is used for FSI+CHT.
   */
  ENUM_TRANSFER NextInterfaceType = ENUM_TRANSFER::NO_TRANSFER;
  CInterface* NextInterface = nullptr;
};