Changes for comments w/ update docs & reg test configs

Author: joshkellyjak

Common/include/CConfig.hpp

@@ -1067,10 +1067,12 @@ class CConfig {
   unsigned short *nSpan_iZones;     /*!< \brief number of span-wise sections for each zones */
   bool turbMixingPlane;             /*!< \brief option for turbulent mixingplane */
   bool SpatialFourier;              /*!< \brief option for computing the fourier transforms for subsonic non-reflecting BC. */
-  bool RampRotatingFrame;           /*!< \brief option for ramping up or down the Rotating Frame values */
-  bool RampTranslationFrame;        /*!< \brief option for ramping up or down the Translation Frame values */
-  bool RampOutletPressure;          /*!< \brief option for ramping up or down the outlet pressure */
-  bool RampOutletMassFlow;          /*!< \brief option for ramping up or down the mass flow rate*/
+  bool RampMotionFrame;             /*!< \brief option for ramping up or down the motion Frame values */
+  bool RampOutlet;                  /*!< \brief option for ramping up or down the outlet values */
+  bool RampRotatingFrame;           /*!< \brief option for ramping up or down the motion Frame values */
+  bool RampTranslationFrame;        /*!< \brief option for ramping up or down the outlet values */
+  bool RampOutletMassFlow;          /*!< \brief option for ramping up or down the motion Frame values */
+  bool RampOutletPressure;          /*!< \brief option for ramping up or down the outlet values */
   su2double AverageMachLimit;           /*!< \brief option for turbulent mixingplane */
   su2double FinalRotation_Rate_Z;       /*!< \brief Final rotation rate Z if Ramp rotating frame is activated. */
   su2double FinalTranslation_Rate_Y;    /*!< \brief Final translation rate Y if Ramp translation frame is activated. */
@@ -1126,10 +1128,8 @@ class CConfig {
   jst_coeff[2],          /*!< \brief artificial dissipation (flow) array for the COption class. */
   ffd_coeff[3],          /*!< \brief artificial dissipation (flow) array for the COption class. */
   mixedout_coeff[3],     /*!< \brief default mixedout algorithm coefficients for the COption class. */
-  rampRotFrame_coeff[3], /*!< \brief ramp rotating frame coefficients for the COption class. */
-  rampTransFrame_coeff[3],/*!< \brief ramp translating frame coefficients for the COption class. */
-  rampOutPres_coeff[3],  /*!< \brief ramp outlet pressure coefficients for the COption class. */
-  rampOutMassFlow_coeff[3], /*< \brief ramp outlet mass flow coefficients for the COption class. */
+  rampMotionFrame_coeff[3], /*!< \brief ramp motion frame coefficients for the COption class. */
+  rampOutlet_coeff[3],   /*!< \brief ramp outlet value coefficients for the COption class. */
   jst_adj_coeff[2],      /*!< \brief artificial dissipation (adjoint) 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. */
@@ -5165,86 +5165,46 @@ class CConfig {
   void SetKind_PerformanceAverageProcess(unsigned short new_AverageProcess) { Kind_PerformanceAverageProcess = new_AverageProcess; }
 
   /*!
-   * \brief Get coeff for Rotating Frame Ramp.
-   * \return coeff Ramp Rotating Frame.
+   * \brief Get Motion Frame Ramp option.
+   * \return Ramp Motion Frame option.
    */
-  su2double GetRampRotatingFrame_Coeff(unsigned short iCoeff) const { return rampRotFrame_coeff[iCoeff];}
+  bool GetRampMotionFrame(void) const { return RampMotionFrame; }
 
   /*!
-   * \brief Get Rotating Frame Ramp option.
-   * \return Ramp Rotating Frame option.
-   */
-  bool GetRampRotatingFrame(void) const { return RampRotatingFrame;}
-
-  /*!
-   * \brief Get coeff for Rotating Frame Ramp.
-   * \return coeff Ramp Rotating Frame.
-   */
-  su2double GetRampTranslationFrame_Coeff(unsigned short iCoeff) const { return rampTransFrame_coeff[iCoeff];}
-
-  /*!
-   * \brief Get Rotating Frame Ramp option.
-   * \return Ramp Rotating Frame option.
-   */
-  bool GetRampTranslationFrame(void) const { return RampTranslationFrame;}
-
-  /*!
-   * \brief Get coeff for Outlet Pressure Ramp.
-   * \return coeff Ramp Outlet Pressure.
-   */
-  su2double GetRampOutletPressure_Coeff(unsigned short iCoeff) const { return rampOutPres_coeff[iCoeff];}
-
-  /*!
-   * \brief Get final Outlet Pressure value for the ramp.
-   * \return final Outlet Pressure value.
-   */
-  su2double GetFinalOutletPressure(void) const { return  FinalOutletPressure; }
-
-  /*!
-   * \brief Get final Outlet Pressure value for the ramp.
-   * \return Monitor Outlet Pressure value.
-   */
-  su2double GetMonitorOutletPressure(void) const { return MonitorOutletPressure; }
-
-  /*!
-   * \brief Set Monitor Outlet Pressure value for the ramp.
-   */
-  void SetMonitorOutletPressure(su2double newMonPres) { MonitorOutletPressure = newMonPres;}
-
-  /*!
-   * \brief Get Outlet Pressure Ramp option.
-   * \return Ramp Outlet pressure option.
-   */
-  bool GetRampOutletPressure(void) const { return RampOutletPressure;}
-
-  /*!
-   * \brief Get Outlet Mass Flow Ramp option.
-   * \return Ramp Outlet Mass flow rate option.
-   */
-  bool GetRampOutletMassFlow(void) const { return RampOutletMassFlow;}
+   * \brief Get coeff for ramping the frame of motion (translation/rotation) [TURBO ONLY]
+   * \return coeff Ramp for frame of motion
+  */
+  su2double GetRampMotionFrame_Coeff(unsigned short iCoeff) const { return rampMotionFrame_coeff[iCoeff];}
 
   /*!
-   * \brief Get coeff for Outlet Mass flow rate Ramp.
-   * \return coeff Ramp Outlet Mass flow rate.
+   * \brief Get outflow ramp option.
+   * \return Ramp outflow option.
    */
-  su2double GetRampOutletMassFlow_Coeff(unsigned short iCoeff) const { return rampOutMassFlow_coeff[iCoeff];}
+  bool GetRampOutflow(void) const { return RampOutlet; }
 
   /*!
-   * \brief Get final Outlet Mass flow rate value for the ramp.
-   * \return final Outlet Mass flow rate value.
-   */
-  su2double GetFinalOutletMassFlow(void) const { return  FinalOutletMassFlow; }
+   * \brief Get coeff for ramping the Giles boundary outflow (pressure/mass flow) [TURBO ONLY]
+   * \return coeff Ramp for Giles outflow
+  */
+  su2double GetRampOutflow_Coeff(unsigned short iCoeff) const { return rampOutlet_coeff[iCoeff]; }
 
   /*!
-   * \brief Get final Outlet Mass flow rate value for the ramp.
-   * \return Monitor Outlet Mass flow value.
-   */
-  su2double GetMonitorOutletMassFlow(void) const { return MonitorOutletMassFlow; }
+   * \brief General interface for accessing ramp coefficient information
+   * \return coeff for ramps
+  */
+  su2double GetRamp_Coeff(TURBO_RAMP_TYPE ramp_flag, TURBO_RAMP_COEFF val_coeff) { 
+    if (ramp_flag == TURBO_RAMP_TYPE::GRID) return rampMotionFrame_coeff[val_coeff];
+    else if (ramp_flag == TURBO_RAMP_TYPE::BOUNDARY) return rampOutlet_coeff[val_coeff];
+    else return 0;
+  };
 
   /*!
-   * \brief Set Monitor Outlet Mass flow rate value for the ramp.
+   * \brief Generic interface for setting monitor outlet values for the ramp.
    */
-  void SetMonitorOutletMassFlow(su2double newMonMassFlow) { MonitorOutletMassFlow= newMonMassFlow;}
+  void SetMonitorValue(su2double newMon_val) {
+    if (RampOutletPressure) MonitorOutletPressure = newMon_val;
+    else if (RampOutletMassFlow) MonitorOutletMassFlow = newMon_val;
+  }
 
   /*!
    * \brief Get mixedout coefficients.
@@ -6103,6 +6063,16 @@ class CConfig {
    */
   void SetRotation_Rate(unsigned short iDim, su2double val) { Rotation_Rate[iDim] = val;}
 
+  /*!
+   * \brief General interface for setting the rate of motion in grid ramps
+   * \param[in] ramp_flag - flag for type of ramp 
+   * \param[in] val - new value of rate of motion
+  */
+  void SetRate(su2double val) { 
+    if (RampRotatingFrame) Rotation_Rate[2] = val;
+    else if (RampTranslationFrame) Translation_Rate[1] = val;
+  };
+
   /*!
    * \brief Get the rotation rate of the marker.
    *  \param[in] iMarkerMoving -  Index of the moving marker (as specified in Marker_Moving)
@@ -6214,6 +6184,14 @@ class CConfig {
    */
   void SetRotation_Rate_Z(su2double newRotation_Rate_Z);
 
+  su2double GetFinalValue(TURBO_RAMP_TYPE ramp_flag) { 
+    if (ramp_flag == TURBO_RAMP_TYPE::GRID && RampRotatingFrame) return FinalRotation_Rate_Z;
+    else if (ramp_flag == TURBO_RAMP_TYPE::GRID && RampTranslationFrame) return FinalTranslation_Rate_Y;
+    else if (ramp_flag == TURBO_RAMP_TYPE::BOUNDARY && RampOutletPressure) return FinalOutletPressure;
+    else if (ramp_flag == TURBO_RAMP_TYPE::BOUNDARY && RampOutletMassFlow) return FinalOutletMassFlow;
+    else return 0.0;
+  };
+
   /*!
    * \brief Get the Harmonic Balance frequency pointer.
    * \return Harmonic Balance Frequency pointer.

Common/include/geometry/CGeometry.hpp

@@ -961,6 +961,17 @@ class CGeometry {
    */
   void SetCustomBoundary(CConfig* config);
 
+  /*!
+   * \brief General interface for setting the velocity in the geometry during motion ramps
+   * \param[in] config - config class
+   * \param[in] ramp_flag - flag for type of ramp 
+   * \param[in] print - bool to print update to screen
+  */
+  void SetVelocity(CConfig* config, bool print) { 
+    if (config->GetKind_GridMovement() == ENUM_GRIDMOVEMENT::ROTATING_FRAME) SetRotationalVelocity(config, print);
+    else if (config->GetKind_GridMovement() == ENUM_GRIDMOVEMENT::STEADY_TRANSLATION) SetTranslationalVelocity(config, print);
+  };
+
   /*!
    * \brief Set cartesian grid velocity based on rotational speed and axis.
    * \param[in] config - Definition of the particular problem.

Common/include/option_structure.hpp

@@ -1887,10 +1887,16 @@ enum TURBO_MARKER_TYPE{
 };
 
 enum TURBO_RAMP_TYPE{
-  GRID = 1,   /*!< \brief flag for rotational/translational ramps */
+  GRID = 1,       /*!< \brief flag for rotational/translational ramps */
   BOUNDARY = 2    /*!< \brief flag for pressure/mass flow ramps*/
 };
 
+enum TURBO_RAMP_COEFF{
+  INITIAL_VALUE = 0,  /*!< \brief intial value of the ramp */
+  UPDATE_FREQ = 1,    /*<! \brief update frequency of the ramp */
+  FINAL_ITER = 2     /*<! \brief final iteration of the ramp */
+};
+
 /*!
  * \brief Types inlet boundary treatments
  */

Common/src/CConfig.cpp

@@ -1621,32 +1621,20 @@ void CConfig::SetConfig_Options() {
    * the 2nd coefficient is the tolerance for the Newton method, 3rd coefficient is the maximum number of
    * iteration for the Newton Method.*/
   addDoubleArrayOption("MIXEDOUT_COEFF", 3, mixedout_coeff);
-  /*!\brief RAMP_ROTATING_FRAME\n DESCRIPTION: option to ramp up or down the rotating frame velocity value*/
-  addBoolOption("RAMP_ROTATING_FRAME", RampRotatingFrame, false);
-  rampRotFrame_coeff[0] = 0; rampRotFrame_coeff[1] = 1.0; rampRotFrame_coeff[2] = 1000.0;
-      /*!\brief RAMP_ROTATING_FRAME_COEFF \n DESCRIPTION: the 1st coeff is the staring velocity,
-   * the 2nd coeff is the number of iterations for the update, 3rd is the number of iteration */
-  addDoubleArrayOption("RAMP_ROTATING_FRAME_COEFF", 3, rampRotFrame_coeff);
-  /*!\brief RAMP_TRANSLATION_FRAME\n DESCRIPTION: option to ramp up or down the translating frame velocity value*/
-  addBoolOption("RAMP_TRANSLATION_FRAME", RampTranslationFrame, false);
-  rampTransFrame_coeff[0] = 0; rampTransFrame_coeff[1] = 1.0; rampTransFrame_coeff[2] = 1000.0;
-      /*!\brief RAMP_TRANSLATION_FRAME\n DESCRIPTION: the 1st coeff is the staring velocity,
-   * the 2nd coeff is the number of iterations for the update, 3rd is the number of iteration */
-  addDoubleArrayOption("RAMP_TRANSLATION_FRAME_COEFF", 3, rampTransFrame_coeff);
+  /*!\brief RAMP_MOTION_FRAME\n DESCRIPTION: option to ramp up or down the frame of motion velocity value*/
+  addBoolOption("RAMP_MOTION_FRAME", RampMotionFrame, false);
+  rampMotionFrame_coeff[0] = 100.0; rampMotionFrame_coeff[1] = 1.0; rampMotionFrame_coeff[2] = 1000.0;
+  /*!\brief RAMP_MOTION_FRAME_COEFF \n DESCRIPTION: the 1st coeff is the staring outlet value,
+   * the 2nd coeff is the number of iterations for the update, 3rd is the number of total iteration till reaching the final outlet pressure value */
+  addDoubleArrayOption("RAMP_MOTION_FRAME_COEFF", 3, rampMotionFrame_coeff);
   /* DESCRIPTION: AVERAGE_MACH_LIMIT is a limit value for average procedure based on the mass flux. */
   addDoubleOption("AVERAGE_MACH_LIMIT", AverageMachLimit, 0.03);
-  /*!\brief RAMP_OUTLET_PRESSURE\n DESCRIPTION: option to ramp up or down the rotating frame velocity value*/
-  addBoolOption("RAMP_OUTLET_PRESSURE", RampOutletPressure, false);
-  rampOutPres_coeff[0] = 100000.0; rampOutPres_coeff[1] = 1.0; rampOutPres_coeff[2] = 1000.0;
-  /*!\brief RAMP_OUTLET_PRESSURE_COEFF \n DESCRIPTION: the 1st coeff is the staring outlet pressure,
+  /*!\brief RAMP_OUTLET\n DESCRIPTION: option to ramp up or down the Giles outlet value*/
+  addBoolOption("RAMP_OUTLET", RampOutlet, false);
+  rampOutlet_coeff[0] = 100000.0; rampOutlet_coeff[1] = 1.0; rampOutlet_coeff[2] = 1000.0;
+  /*!\brief RAMP_OUTLET_COEFF \n DESCRIPTION: the 1st coeff is the staring outlet value,
    * the 2nd coeff is the number of iterations for the update, 3rd is the number of total iteration till reaching the final outlet pressure value */
-  addDoubleArrayOption("RAMP_OUTLET_PRESSURE_COEFF", 3, rampOutPres_coeff);
-  /*!\brief RAMP_OUTLET_MASS_FLOW\n DESCRIPTION: option to ramp up or down the outlet mass flow rate value*/
-  addBoolOption("RAMP_OUTLET_MASS_FLOW", RampOutletMassFlow, false);
-  rampOutMassFlow_coeff[0] = 1.0; rampOutMassFlow_coeff[1] = 1.0; rampOutPres_coeff[2] = 1000.0;
-  /*!\brief RAMP_OUTLET_MASS_FLOW_COEFF \n DESCRIPTION: the 1st coeff is the staring mass flow rate,
-   * the 2nd coeff is the number of iterations for the update, 3rd is the number of total iteration till reaching the final outlet mass flow rate value */
-  addDoubleArrayOption("RAMP_OUTLET_MASS_FLOW_COEFF", 3, rampOutMassFlow_coeff);
+  addDoubleArrayOption("RAMP_OUTLET_COEFF", 3, rampOutlet_coeff);
   /*!\brief MARKER_MIXINGPLANE \n DESCRIPTION: Identify the boundaries in which the mixing plane is applied. \ingroup Config*/
   addStringListOption("MARKER_MIXINGPLANE_INTERFACE", nMarker_MixingPlaneInterface, Marker_MixingPlaneInterface);
   /*!\brief TURBULENT_MIXINGPLANE \n DESCRIPTION: Activate mixing plane also for turbulent quantities \ingroup Config*/
@@ -4367,32 +4355,46 @@ void CConfig::SetPostprocessing(SU2_COMPONENT val_software, unsigned short val_i
     nSpan_iZones = new unsigned short[nZone];
   }
 
+  /*--- Interface for handling turbo ramps ---*/
+  if(GetGrid_Movement() && RampMotionFrame && !DiscreteAdjoint){
+    if (Kind_GridMovement == ENUM_GRIDMOVEMENT::ROTATING_FRAME) RampRotatingFrame = true;
+    else if (Kind_GridMovement == ENUM_GRIDMOVEMENT::STEADY_TRANSLATION) RampTranslationFrame = true;
+  }
+
+  if(RampOutlet && !DiscreteAdjoint) {
+    for (iMarker = 0; iMarker < nMarker_Giles; iMarker++){
+      if (Kind_Data_Giles[iMarker] == STATIC_PRESSURE ||  Kind_Data_Giles[iMarker] == STATIC_PRESSURE_1D || Kind_Data_Giles[iMarker] == RADIAL_EQUILIBRIUM )
+        RampOutletPressure = true;
+      else if (Kind_Data_Giles[iMarker] == MASS_FLOW_OUTLET) RampOutletMassFlow = true;
+    }
+  }
+
   /*--- Set number of TurboPerformance markers ---*/
   if(GetGrid_Movement() && RampRotatingFrame && !DiscreteAdjoint){
     FinalRotation_Rate_Z = Rotation_Rate[2];
     if(abs(FinalRotation_Rate_Z) > 0.0){
-      Rotation_Rate[2] = rampRotFrame_coeff[0];
+      Rotation_Rate[2] = rampMotionFrame_coeff[TURBO_RAMP_COEFF::INITIAL_VALUE];
     }
   }
 
   if(GetGrid_Movement() && RampTranslationFrame && !DiscreteAdjoint){
     FinalTranslation_Rate_Y = Translation_Rate[1];
     if(abs(FinalTranslation_Rate_Y) > 0.0){
-      Translation_Rate[1] = rampTransFrame_coeff[0];
+      Translation_Rate[1] = rampMotionFrame_coeff[TURBO_RAMP_COEFF::INITIAL_VALUE];
     }
   }
 
   if(RampOutletPressure && !DiscreteAdjoint){
     for (iMarker = 0; iMarker < nMarker_Giles; iMarker++){
       if (Kind_Data_Giles[iMarker] == STATIC_PRESSURE || Kind_Data_Giles[iMarker] == STATIC_PRESSURE_1D || Kind_Data_Giles[iMarker] == RADIAL_EQUILIBRIUM ){
         FinalOutletPressure = Giles_Var1[iMarker];
-        Giles_Var1[iMarker] = rampOutPres_coeff[0];
+        Giles_Var1[iMarker] = rampOutlet_coeff[TURBO_RAMP_COEFF::INITIAL_VALUE];
       }
     }
     for (iMarker = 0; iMarker < nMarker_Riemann; iMarker++){
       if (Kind_Data_Riemann[iMarker] == STATIC_PRESSURE || Kind_Data_Riemann[iMarker] == RADIAL_EQUILIBRIUM){
         FinalOutletPressure = Riemann_Var1[iMarker];
-        Riemann_Var1[iMarker] = rampOutPres_coeff[0];
+        Riemann_Var1[iMarker] = rampOutlet_coeff[TURBO_RAMP_COEFF::INITIAL_VALUE];
       }
     }
   }
@@ -4401,7 +4403,7 @@ void CConfig::SetPostprocessing(SU2_COMPONENT val_software, unsigned short val_i
     for (iMarker = 0; iMarker < nMarker_Giles; iMarker++){
       if (Kind_Data_Giles[iMarker] == MASS_FLOW_OUTLET){
         FinalOutletMassFlow = Giles_Var1[iMarker];
-        Giles_Var1[iMarker] = rampOutMassFlow_coeff[0];
+        Giles_Var1[iMarker] = rampOutlet_coeff[TURBO_RAMP_COEFF::INITIAL_VALUE];
       }
     }
   }

SU2_CFD/include/iteration/CFluidIteration.hpp

@@ -115,7 +115,7 @@ class CFluidIteration : public CIteration {
    * \param[in] iZone - The current zone
    * \param[in] ramp_flag - Flag indicating type of ramp (grid or boundary)
    */
-  virtual void TurboRamp(CGeometry**** geometry_container, CConfig** config_container, unsigned long iter, unsigned short iZone, unsigned short ramp_flag) {};
+  virtual void TurboRamp(CGeometry**** geometry_container, CConfig** config_container, unsigned long iter, unsigned short iZone, TURBO_RAMP_TYPE ramp_flag) {};
 
   /*!
    * \brief Computes turboperformance.

SU2_CFD/include/iteration/CTurboIteration.hpp

@@ -77,5 +77,5 @@ class CTurboIteration : public CFluidIteration {
    * \param[in] iZone - The current zone
    * \param[in] ramp_flag - Flag indicating type of ramp (grid or boundary)
    */
-  void TurboRamp(CGeometry**** geometry_container, CConfig** config_container, unsigned long iter, unsigned short iZone, unsigned short ramp_flag) override;
+  void TurboRamp(CGeometry**** geometry_container, CConfig** config_container, unsigned long iter, unsigned short iZone, TURBO_RAMP_TYPE ramp_flag) override;
 };

SU2_CFD/src/iteration/CFluidIteration.cpp

@@ -233,9 +233,9 @@ bool CFluidIteration::Monitor(COutput* output, CIntegration**** integration, CGe
                            config[val_iZone]->GetInnerIter(), val_iInst);
     }
     /*--- Update ramps, grid first then outlet boundary ---*/
-    if (config[val_iZone]->GetRampRotatingFrame() || config[val_iZone]->GetRampTranslationFrame())
+    if (config[val_iZone]->GetRampMotionFrame())
       TurboRamp(geometry, config, config[val_iZone]->GetInnerIter(), val_iZone, TURBO_RAMP_TYPE::GRID);
-    if (config[val_iZone]->GetRampOutletMassFlow() || config[val_iZone]->GetRampOutletPressure())
+    if (config[val_iZone]->GetRampOutflow())
       TurboRamp(geometry, config, config[val_iZone]->GetInnerIter(), val_iZone, TURBO_RAMP_TYPE::BOUNDARY);
   }
   output->SetHistoryOutput(geometry[val_iZone][val_iInst][MESH_0], solver[val_iZone][val_iInst][MESH_0],