Merge remote-tracking branch 'upstream/develop' into feature_Sobolev_smoothing_solver

Author: thomasdick

.gitmodules

@@ -18,3 +18,6 @@
 [submodule "externals/opdi"]
 	path = externals/opdi
 	url = https://github.com/SciCompKL/OpDiLib
+[submodule "externals/mel"]
+	path = externals/mel
+	url = https://github.com/pcarruscag/MEL.git

Common/include/CConfig.hpp

@@ -80,7 +80,6 @@ class CConfig {
   su2double EA_ScaleFactor;       /*!< \brief Equivalent Area scaling factor */
   su2double AdjointLimit;         /*!< \brief Adjoint variable limit */
   string* ConvField;              /*!< \brief Field used for convergence check.*/
-  string ConvCriteria;            // This option is deprecated. After a grace period until 7.2.0 the usage warning should become an error.
 
   string* WndConvField;              /*!< \brief Function where to apply the windowed convergence criteria for the time average of the unsteady (single zone) flow problem. */
   unsigned short nConvField;         /*!< \brief Number of fields used to monitor convergence.*/
@@ -146,11 +145,7 @@ class CConfig {
   su2double dCMx_dCL;          /*!< \brief Fixed Cl mode derivate. */
   su2double dCMy_dCL;          /*!< \brief Fixed Cl mode derivate. */
   su2double dCMz_dCL;          /*!< \brief Fixed Cl mode derivate. */
-  su2double dCD_dCMy;          /*!< \brief Fixed Cl mode derivate. */
   su2double CL_Target;         /*!< \brief Fixed Cl mode Target Cl. */
-  su2double CM_Target;         /*!< \brief Fixed Cl mode Target CM. */
-  su2double *HTP_Min_XCoord,
-  *HTP_Min_YCoord;                   /*!< \brief Identification of the HTP. */
   TIME_MARCHING TimeMarching;        /*!< \brief Steady or unsteady (time stepping or dual time stepping) computation. */
   unsigned short Dynamic_Analysis;   /*!< \brief Static or dynamic structural analysis. */
   unsigned short nStartUpIter;       /*!< \brief Start up iterations using the fine grid. */
@@ -454,7 +449,7 @@ class CConfig {
   unsigned long Grad_Linear_Solver_Iter; /*!< \brief Max iterations of the linear solver for the gradient smoothing. */
 
   bool ReorientElements;       /*!< \brief Flag for enabling element reorientation. */
-  bool AddIndNeighbor;         /*!< \brief Include indirect neighbor in the agglomeration process. */
+  string CustomObjFunc;        /*!< \brief User-defined objective function. */
   unsigned short nDV,                  /*!< \brief Number of design variables. */
   nObj, nObjW;                         /*! \brief Number of objective functions. */
   unsigned short* nDV_Value;           /*!< \brief Number of values for each design variable (might be different than 1 if we allow arbitrary movement). */
@@ -654,11 +649,9 @@ class CConfig {
   iH, AoS, AoA_Offset,
   AoS_Offset, AoA_Sens;       /*!< \brief Angle of sideSlip (just external flow). */
   bool Fixed_CL_Mode;         /*!< \brief Activate fixed CL mode (external flow only). */
-  bool Fixed_CM_Mode;         /*!< \brief Activate fixed CL mode (external flow only). */
   bool Eval_dOF_dCX;          /*!< \brief Activate fixed CL mode (external flow only). */
   bool Discard_InFiles;       /*!< \brief Discard angle of attack in solution and geometry files. */
   su2double Target_CL;        /*!< \brief Specify a target CL instead of AoA (external flow only). */
-  su2double Target_CM;        /*!< \brief Specify a target CM instead of AoA (external flow only). */
   su2double Total_CM;         /*!< \brief Specify a Total CM instead of AoA (external flow only). */
   su2double Total_CD;         /*!< \brief Specify a target CD instead of AoA (external flow only). */
   su2double dCL_dAlpha;       /*!< \brief value of dCl/dAlpha. */
@@ -674,7 +667,6 @@ class CConfig {
   bool Update_AoA;                      /*!< \brief Boolean flag for whether to update the AoA for fixed lift mode on a given iteration. */
   unsigned long Update_AoA_Iter_Limit;  /*!< \brief Limit on number of iterations between AoA updates for fixed lift mode. */
   bool Finite_Difference_Mode;        /*!< \brief Flag to run the finite difference mode in fixed Cl mode. */
-  bool Update_HTPIncidence;           /*!< \brief Boolean flag for whether to update the AoA for fixed lift mode on a given iteration. */
   su2double ChargeCoeff;              /*!< \brief Charge coefficient (just for poisson problems). */
   unsigned short Cauchy_Func_Flow,    /*!< \brief Function where to apply the convergence criteria in the flow problem. */
   Cauchy_Func_AdjFlow,                /*!< \brief Function where to apply the convergence criteria in the adjoint problem. */
@@ -1088,7 +1080,6 @@ class CConfig {
   rampOutPres_coeff[3],  /*!< \brief ramp outlet pressure coefficients for the COption class. */
   jst_adj_coeff[2],      /*!< \brief artificial dissipation (adjoint) array for the COption class. */
   ad_coeff_heat[2],      /*!< \brief artificial dissipation (heat) array for the COption class. */
-  obj_coeff[5],          /*!< \brief objective array for the COption class. */
   mesh_box_length[3],    /*!< \brief mesh box length for the COption class. */
   mesh_box_offset[3],    /*!< \brief mesh box offset for the COption class. */
   geo_loc[2],            /*!< \brief SU2_GEO section locations array for the COption class. */
@@ -1170,7 +1161,7 @@ class CConfig {
   POD_KIND POD_Basis_Gen;                   /*!< \brief Type of POD basis generation (static or incremental). */
   unsigned short maxBasisDim,               /*!< \brief Maximum number of POD basis dimensions. */
   rom_save_freq;                            /*!< \brief Frequency of unsteady time steps to save. */
-  
+
   /* other NEMO configure options*/
   unsigned short nSpecies,                  /*!< \brief No of species present in flow */
   iWall_Catalytic,
@@ -1573,12 +1564,6 @@ class CConfig {
    */
   bool GetCFL_Adapt(void) const { return CFL_Adapt; }
 
-  /*!
-   * \brief Get the values of the CFL adapation.
-   * \return Value of CFL adapation
-   */
-  su2double GetHTP_Axis(unsigned short val_index) const { return htp_axis[val_index]; }
-
   /*!
    * \brief Get the value of the limits for the sections.
    * \return Value of the limits for the sections.
@@ -5231,13 +5216,9 @@ class CConfig {
   void SetWeight_ObjFunc(unsigned short val_obj, su2double val) { Weight_ObjFunc[val_obj] = val; }
 
   /*!
-   * \author H. Kline
-   * \brief Get the coefficients of the objective defined by the chain rule with primitive variables.
-   * \note This objective is only applicable to gradient calculations. Objective value must be
-   * calculated using the area averaged outlet values of density, velocity, and pressure.
-   * Gradients are w.r.t density, velocity[3], and pressure. when 2D gradient w.r.t. 3rd component of velocity set to 0.
+   * \brief Get the user expression for the custom objective function.
    */
-  su2double GetCoeff_ObjChainRule(unsigned short iVar) const { return obj_coeff[iVar]; }
+  const string& GetCustomObjFunc() const { return CustomObjFunc; }
 
   /*!
    * \brief Get the kind of sensitivity smoothing technique.
@@ -5531,12 +5512,6 @@ class CConfig {
    */
   string GetObjFunc_Extension(string val_filename) const;
 
-  /*!
-   * \brief Get the criteria for structural residual (relative/absolute).
-   * \return Relative/Absolute criteria for structural convergence.
-   */
-  unsigned short GetResidual_Criteria_FEM(void) const { return Res_FEM_CRIT; }
-
   /*!
    * \brief Get functional that is going to be used to evaluate the residual flow convergence.
    * \return Functional that is going to be used to evaluate the residual flow convergence.
@@ -6298,18 +6273,6 @@ class CConfig {
    */
   su2double GetFixAzimuthalLine(void) const { return FixAzimuthalLine; }
 
-  /*!
-   * \brief Value of the weight of the CD, CL, CM optimization.
-   * \return Value of the weight of the CD, CL, CM optimization.
-   */
-  su2double GetdCD_dCMy(void) const { return dCD_dCMy; }
-
-  /*!
-   * \brief Value of the weight of the CD, CL, CM optimization.
-   * \return Value of the weight of the CD, CL, CM optimization.
-   */
-  su2double GetCM_Target(void) const { return CM_Target; }
-
   /*!
    * \brief Value of the weight of the CD, CL, CM optimization.
    * \return Value of the weight of the CD, CL, CM optimization.
@@ -6370,12 +6333,6 @@ class CConfig {
    */
   void SetdCM_diH(su2double val_dcm_dhi) { dCM_diH = val_dcm_dhi; }
 
-  /*!
-   * \brief Value of the weight of the CD, CL, CM optimization.
-   * \return Value of the weight of the CD, CL, CM optimization.
-   */
-  void SetdCD_dCMy(su2double val_dcd_dcmy) { dCD_dCMy = val_dcd_dcmy; }
-
   /*!
    * \brief Value of the weight of the CD, CL, CM optimization.
    * \return Value of the weight of the CD, CL, CM optimization.
@@ -8398,12 +8355,6 @@ class CConfig {
    */
   bool GetFixed_CL_Mode(void) const { return Fixed_CL_Mode; }
 
-  /*!
-   * \brief Get information about whether to use fixed CL mode.
-   * \return <code>TRUE</code> if fixed CL mode is active; otherwise <code>FALSE</code>.
-   */
-  bool GetFixed_CM_Mode(void) const { return Fixed_CM_Mode; }
-
   /*!
    * \brief Get information about whether to use fixed CL mode.
    * \return <code>TRUE</code> if fixed CL mode is active; otherwise <code>FALSE</code>.
@@ -9551,25 +9502,25 @@ class CConfig {
    * \return True if specified in config file.
    */
   bool GetSave_libROM(void) const {return libROM; }
-  
+
   /*!
    * \brief Get the name of the file for libROM to save.
    * \return Filename prefix for libROM to save to (default: "su2").
    */
   string GetlibROMbase_FileName(void) const { return libROMbase_FileName; }
-  
+
   /*!
    * \brief Static or incremental toggle for POD basis generation type.
    * \return Type of POD generation type
    */
   POD_KIND GetKind_PODBasis(void) const { return POD_Basis_Gen; }
-  
+
   /*!
    * \brief Get maximum number of POD basis dimensions (default: 100).
    * \return Maximum number of POD basis vectors.
    */
   unsigned short GetMax_BasisDim(void) const { return maxBasisDim; }
-  
+
   /*!
    * \brief Get frequency of unsteady time steps to save (default: 1).
    * \return Save frequency for unsteady time steps.

Common/include/option_structure.hpp

@@ -721,17 +721,13 @@ enum ENUM_GRIDMOVEMENT {
   NO_MOVEMENT = 0,          /*!< \brief Simulation on a static mesh. */
   RIGID_MOTION = 2,         /*!< \brief Simulation with rigid mesh motion (plunging/pitching/rotation). */
   ROTATING_FRAME = 8,       /*!< \brief Simulation in a rotating frame. */
-  ELASTICITY = 9,           /*!< \brief Linear Elasticity. */
   STEADY_TRANSLATION = 11,  /*!< \brief Simulation in a steadily translating frame. */
   GUST = 12,                /*!< \brief Simulation on a static mesh with a gust. */
-  MOVING_HTP = 13,          /*!< \brief Simulation with moving HTP (rotation). */
 };
 static const MapType<std::string, ENUM_GRIDMOVEMENT> GridMovement_Map = {
   MakePair("NONE", NO_MOVEMENT)
   MakePair("RIGID_MOTION", RIGID_MOTION)
   MakePair("ROTATING_FRAME", ROTATING_FRAME)
-  MakePair("ELASTICITY", ELASTICITY)
-  MakePair("MOVING_HTP", MOVING_HTP)
   MakePair("STEADY_TRANSLATION", STEADY_TRANSLATION)
   MakePair("GUST", GUST)
 };
@@ -1573,17 +1569,8 @@ enum ENUM_OBJECTIVE {
   SURFACE_SPECIES_0 = 58,       /*!< \brief Surface Avg. Species_0 objective function definition. */
   SURFACE_SPECIES_VARIANCE = 59,/*!< \brief Species Variance objective function definition. */
   CUSTOM_OBJFUNC = 31,          /*!< \brief Custom objective function definition. */
-  TOTAL_PRESSURE_LOSS = 39,
-  KINETIC_ENERGY_LOSS = 40,
-  TOTAL_EFFICIENCY = 41,
-  TOTAL_STATIC_EFFICIENCY = 42,
-  EULERIAN_WORK = 43,
-  TOTAL_ENTHALPY_IN = 44,
-  FLOW_ANGLE_IN = 45,
   FLOW_ANGLE_OUT = 46,
   MASS_FLOW_IN = 47,
-  MASS_FLOW_OUT = 48,
-  PRESSURE_RATIO = 49,
   ENTROPY_GENERATION = 50,
   REFERENCE_GEOMETRY = 60,      /*!< \brief Norm of displacements with respect to target geometry. */
   REFERENCE_NODE = 61,          /*!< \brief Objective function defined as the difference of a particular node respect to a reference position. */
@@ -1627,18 +1614,9 @@ static const MapType<std::string, ENUM_OBJECTIVE> Objective_Map = {
   MakePair("SURFACE_SPECIES_0", SURFACE_SPECIES_0)
   MakePair("SURFACE_SPECIES_VARIANCE", SURFACE_SPECIES_VARIANCE)
   MakePair("CUSTOM_OBJFUNC", CUSTOM_OBJFUNC)
-  MakePair("TOTAL_EFFICIENCY", TOTAL_EFFICIENCY)
-  MakePair("TOTAL_STATIC_EFFICIENCY", TOTAL_STATIC_EFFICIENCY)
-  MakePair("TOTAL_PRESSURE_LOSS", TOTAL_PRESSURE_LOSS)
-  MakePair("EULERIAN_WORK", EULERIAN_WORK)
-  MakePair("TOTAL_ENTHALPY_IN", TOTAL_ENTHALPY_IN)
-  MakePair("FLOW_ANGLE_IN", FLOW_ANGLE_IN)
   MakePair("FLOW_ANGLE_OUT", FLOW_ANGLE_OUT)
   MakePair("MASS_FLOW_IN", MASS_FLOW_IN)
-  MakePair("MASS_FLOW_OUT", MASS_FLOW_OUT)
-  MakePair("PRESSURE_RATIO",  PRESSURE_RATIO)
   MakePair("ENTROPY_GENERATION",  ENTROPY_GENERATION)
-  MakePair("KINETIC_ENERGY_LOSS", KINETIC_ENERGY_LOSS)
   MakePair("REFERENCE_GEOMETRY", REFERENCE_GEOMETRY)
   MakePair("REFERENCE_NODE", REFERENCE_NODE)
   MakePair("VOLUME_FRACTION", VOLUME_FRACTION)
@@ -1647,46 +1625,6 @@ static const MapType<std::string, ENUM_OBJECTIVE> Objective_Map = {
   MakePair("STRESS_PENALTY", STRESS_PENALTY)
 };
 
-/*!
- * \brief Types of residual criteria equations
- */
-enum ENUM_RESIDUAL {
-  RHO_RESIDUAL = 1,        /*!< \brief Rho equation residual criteria equation. */
-  RHO_ENERGY_RESIDUAL = 2  /*!< \brief RhoE equation residual criteria equation. */
-};
-static const MapType<std::string, ENUM_RESIDUAL> Residual_Map = {
-  MakePair("RHO", RHO_RESIDUAL)
-  MakePair("RHO_ENERGY", RHO_ENERGY_RESIDUAL)
-};
-
-/*!
- * \brief Types of residual criteria for structural problems
- */
-enum ENUM_RESFEM {
-  RESFEM_RELATIVE = 1,         /*!< \brief Relative criteria: Res/Res0. */
-  RESFEM_ABSOLUTE = 2          /*!< \brief Absolute criteria: abs(Res). */
-};
-static const MapType<std::string, ENUM_RESFEM> ResFem_Map = {
-  MakePair("RELATIVE", RESFEM_RELATIVE)
-  MakePair("ABSOLUTE", RESFEM_ABSOLUTE)
-};
-
-/*!
- * \brief Types of sensitivities to compute
- */
-enum ENUM_SENS {
-  SENS_GEOMETRY = 1,    /*!< \brief Geometrical sensitivity. */
-  SENS_MACH = 2,        /*!< \brief Mach number sensitivity. */
-  SENS_AOA = 3,         /*!< \brief Angle of attack sensitivity. */
-  SENS_AOS = 4          /*!< \brief Angle of Sideslip sensitivity. */
-};
-static const MapType<std::string, ENUM_SENS> Sens_Map = {
-  MakePair("SENS_GEOMETRY", SENS_GEOMETRY)
-  MakePair("SENS_MACH", SENS_MACH)
-  MakePair("SENS_AOA", SENS_AOA)
-  MakePair("SENS_AOS", SENS_AOS)
-};
-
 /*!
  * \brief Types of input file formats
  */
@@ -1833,32 +1771,6 @@ static const MapType<std::string, MG_CYCLE> MG_Cycle_Map = {
   MakePair("FULLMG_CYCLE", FULLMG_CYCLE)
 };
 
-/*!
- * \brief Type of solution output variables
- */
-enum ENUM_OUTPUT_VARS {
-  DENSITY = 1,      /*!< \brief Density. */
-  VEL_X = 2,        /*!< \brief X-component of velocity. */
-  VEL_Y = 3,        /*!< \brief Y-component of velocity. */
-  VEL_Z = 4,        /*!< \brief Z-component of velocity. */
-  PRESSURE = 5,     /*!< \brief Static pressure. */
-  MACH = 6,         /*!< \brief Mach number. */
-  TEMPERATURE = 7,  /*!< \brief Temperature. */
-  LAM_VISC = 8,     /*!< \brief Laminar viscosity. */
-  EDDY_VISC = 9     /*!< \brief Eddy viscosity. */
-};
-static const MapType<std::string, ENUM_OUTPUT_VARS> Output_Vars_Map = {
-  MakePair("DENSITY", DENSITY)
-  MakePair("VEL_X", VEL_X)
-  MakePair("VEL_Y", VEL_Y)
-  MakePair("VEL_Z", VEL_Z)
-  MakePair("PRESSURE", PRESSURE)
-  MakePair("MACH", MACH)
-  MakePair("TEMPERATURE", TEMPERATURE)
-  MakePair("LAM_VISC", LAM_VISC)
-  MakePair("EDDY_VISC", EDDY_VISC)
-};
-
 /*!
  * \brief Types of design parameterizations
  */
@@ -2387,35 +2299,35 @@ class COptionBase {
 private:
   std::vector<std::string> value;
 public:
-  COptionBase() {};
-  virtual  ~COptionBase() = 0;
+  virtual ~COptionBase() = default;
+
+  const std::vector<std::string>& GetValue() const {return value;}
 
-  virtual std::string SetValue(std::vector<std::string> value){this->value = value; return "";}
-  std::vector<std::string> GetValue() {return value;}
+  virtual std::string SetValue(const std::vector<std::string>& val) {
+    value = val;
+    return "";
+  }
   virtual void SetDefault() = 0;
 
-  std::string optionCheckMultipleValues(std::vector<std::string> & option_value, std::string type_id, std::string option_name) {
+  std::string optionCheckMultipleValues(const std::vector<std::string>& option_value,
+                                        std::string type_id, const std::string& option_name) {
     if (option_value.size() != 1) {
-      std::string newString;
-      newString.append(option_name);
+      std::string newString(option_name);
       newString.append(": multiple values for type ");
       newString.append(type_id);
       return newString;
     }
     return "";
   }
 
-  std::string badValue(std::vector<std::string> & option_value, std::string type_id, std::string option_name) {
-    std::string newString;
-    newString.append(option_name);
+  std::string badValue(std::string type_id, const std::string& option_name) {
+    std::string newString(option_name);
     newString.append(": improper option value for type ");
     newString.append(type_id);
     return newString;
   }
 };
 
-inline COptionBase::~COptionBase() {}
-
 #ifdef ENABLE_MAPS
 #include "option_structure.inl"
 #endif