Various smaller changes. Mainly spelling.

Author: TobiKattmann

.github/workflows/regression.yml

@@ -83,7 +83,7 @@ jobs:
       - name: Run Tests in Container
         uses: docker://su2code/test-su2:20200303
         with:
-          args: -b ${{github.ref}} -t develop -c feature_periodic_streamwise -s ${{matrix.testscript}}
+          args: -b ${{github.ref}} -t develop -c develop -s ${{matrix.testscript}}
   unit_tests:
     runs-on: ubuntu-latest
     name: Unit Tests

Common/include/CConfig.hpp

@@ -996,8 +996,8 @@ class CConfig {
   array<su2double, N_POLY_COEFFS> kt_polycoeffs{{0.0}};  /*!< \brief Array for thermal conductivity polynomial coefficients. */
   bool Body_Force;                      /*!< \brief Flag to know if a body force is included in the formulation. */
 
-  unsigned short Kind_Streamwise_Periodic;          /*!< \brief Flag to know if a body force is included in the formulation, used for periodic BC as inlet & outlet. */
-  bool Streamwise_Periodic_Temperature;             /*!< \brief Use real periodicity for Energy equation or oterwise outlet source term. */
+  unsigned short Kind_Streamwise_Periodic;          /*!< \brief Kind of Streamwise periodic flow (pressure drop or massflow) */
+  bool Streamwise_Periodic_Temperature;             /*!< \brief Use real periodicity for Energy equation or otherwise outlet source term. */
   su2double Streamwise_Periodic_PressureDrop,       /*!< \brief Value of prescribed pressure drop [Pa] which results in an artificial body force vector. */
             Streamwise_Periodic_TargetMassFlow,     /*!< \brief Value of prescribed massflow [kg/s] which results in an delta p and therefore an artificial body force vector. */
             Streamwise_Periodic_OutletHeat;         /*!< /brief Heatflux boundary [W/m^2] imposed at streamwise periodic outlet. */
@@ -3095,7 +3095,7 @@ class CConfig {
    *         has the marker <i>val_marker</i>.
    */
   string GetMarker_Outlet_TagBound(unsigned short val_marker) const { return Marker_Outlet[val_marker]; }
-  
+
   /*!
    * \brief Get the index of the surface defined in the geometry file.
    * \param[in] val_marker - Value of the marker in which we are interested.
@@ -5179,7 +5179,7 @@ class CConfig {
   unsigned short GetTabular_FileFormat(void) const { return Tab_FileFormat; }
 
   /*!
-   * \brief Get the output precision to be used in <ofstream>.precision(value).
+   * \brief Get the output precision to be used in <ofstream>.precision(value) for history and SU2_DOT output.
    * \return Output precision.
    */
   unsigned short GetOutput_Precision(void) const { return output_precision; }

Common/include/geometry/CGeometry.hpp

@@ -735,12 +735,6 @@ class CGeometry {
    */
   inline virtual void MatchPeriodic(CConfig *config, unsigned short val_periodic) {}
 
-  /*!
-   * \brief For streamwise periodicity, find a unique reference node on the designated inlet.
-   * \param[in] config - Definition of the particular problem.
-   */
-  inline virtual void FindUniqueNode_PeriodicBound(CConfig *config) {}
-
   /*!
    * \brief A virtual member.
    * \param[in] config - Definition of the particular problem.
@@ -1718,6 +1712,12 @@ class CGeometry {
    */
   unsigned long GetnNonconvexElements() const {return nNonconvexElements;}
 
+  /*!
+   * \brief For streamwise periodicity, find & store a unique reference node on the designated periodic inlet.
+   * \param[in] config - Definition of the particular problem.
+   */
+  inline virtual void FindUniqueNode_PeriodicBound(CConfig *config) {}
+
   /*!
    * \brief Get a pointer to the reference node coordinate vector.
    * \return A pointer to the reference node coordinate vector.

Common/include/geometry/CPhysicalGeometry.hpp

@@ -107,7 +107,7 @@ class CPhysicalGeometry final : public CGeometry {
   vector<int> GlobalMarkerStorageDispl;
   vector<su2double> GlobalRoughness_Height;
 
-  su2double Streamwise_Periodic_RefNode[MAXNDIM] = {0}; /*!< \brief Coordinates of the reference node [m] on the receiving periodic marker, for recovered pressure/temperature computation only. Size nDim.*/
+  su2double Streamwise_Periodic_RefNode[MAXNDIM] = {0}; /*!< \brief Coordinates of the reference node [m] on the receiving periodic marker, for recovered pressure/temperature computation only.*/
 
 public:
   /*--- This is to suppress Woverloaded-virtual, omitting it has no negative impact. ---*/
@@ -467,12 +467,6 @@ class CPhysicalGeometry final : public CGeometry {
    */
   void MatchPeriodic(CConfig *config, unsigned short val_periodic) override;
 
-  /*!
-   * \brief For streamwise periodicity, find a unique reference node on the designated inlet.
-   * \param[in] config - Definition of the particular problem.
-   */
-  void FindUniqueNode_PeriodicBound(CConfig *config) final;
-
   /*!
    * \brief Set boundary vertex structure of the control volume.
    * \param[in] config - Definition of the particular problem.
@@ -792,6 +786,12 @@ class CPhysicalGeometry final : public CGeometry {
    */
   void SetGlobalMarkerRoughness(const CConfig* config);
 
+  /*!
+   * \brief For streamwise periodicity, find & store a unique reference node on the designated periodic inlet.
+   * \param[in] config - Definition of the particular problem.
+   */
+  void FindUniqueNode_PeriodicBound(CConfig *config) final;
+
   /*!
    * \brief Get a pointer to the reference node coordinate vector.
    * \return A pointer to the reference node coordinate vector.

Common/include/option_structure.hpp

@@ -2257,7 +2257,7 @@ static const MapType<string, ENUM_VERIFICATION_SOLUTIONS> Verification_Solution_
 };
 
 /*!
- * \brief types of streamwise periodicity.
+ * \brief Types of streamwise periodicity.
  */
 enum ENUM_STREAMWISE_PERIODIC {
   NO_STREAMWISE_PERIODIC = 0, /*!< \brief No streamwise periodic flow. */

Common/src/CConfig.cpp

@@ -1105,15 +1105,15 @@ void CConfig::SetConfig_Options() {
   /* DESCRIPTION: Vector of body force values (BodyForce_X, BodyForce_Y, BodyForce_Z) */
   addDoubleArrayOption("BODY_FORCE_VECTOR", 3, body_force);
 
-  /* DESCRIPTION: Apply a body force as a source term for periodic boundary conditions (NONE, PRESSURE_DROP, MASSFLOW) */
+  /* DESCRIPTION: Apply a body force as a source term for periodic boundary conditions \n Options: NONE, PRESSURE_DROP, MASSFLOW \n DEFAULT: NONE \ingroup Config */
   addEnumOption("KIND_STREAMWISE_PERIODIC", Kind_Streamwise_Periodic, Streamwise_Periodic_Map, NO_STREAMWISE_PERIODIC);
-  /*!\brief STREAMWISE_PERIODIC_TEMPERATURE \n DESCRIPTION: Use real periodicty for temperature: NO, YES \ingroup Config */
+  /* DESCRIPTION: Use real periodicity for temperature \n Options: NO, YES \n DEFAULT: NO \ingroup Config */
   addBoolOption("STREAMWISE_PERIODIC_TEMPERATURE", Streamwise_Periodic_Temperature, false);
-  /* DESCRIPTION: Heatflux boundary at streamwise periodic 'outlet', choose heat [W] such that net domain heatflux is zero. Only active if STREAMWISE_PERIODIC_TEMPERATURE is active. */
+  /* DESCRIPTION: Heatflux boundary at streamwise periodic 'outlet', choose heat [W] such that net domain heatflux is zero. Only active if STREAMWISE_PERIODIC_TEMPERATURE is active. \n DEFAULT: 0.0 \ingroup Config */
   addDoubleOption("STREAMWISE_PERIODIC_OUTLET_HEAT", Streamwise_Periodic_OutletHeat, 0.0);
-  /* DESCRIPTION: Delta pressure [Pa] on which basis body force will be computed, serves as initial value if MASSFLOW is chosen */
+  /* DESCRIPTION: Delta pressure [Pa] on which basis body force will be computed, serves as initial value if MASSFLOW is chosen. \n DEFAULT: 1.0 \ingroup Config */
   addDoubleOption("STREAMWISE_PERIODIC_PRESSURE_DROP", Streamwise_Periodic_PressureDrop, 1.0);
-  /* DESCRIPTION: Target Massflow [kg/s], Delta P will be adapted until m_dot is met.  */
+  /* DESCRIPTION: Target Massflow [kg/s], Delta P will be adapted until m_dot is met. \n DEFAULT: 0.0 \ingroup Config  */
   addDoubleOption("STREAMWISE_PERIODIC_MASSFLOW", Streamwise_Periodic_TargetMassFlow, 0.0);
 
   /*!\brief RESTART_SOL \n DESCRIPTION: Restart solution from native solution file \n Options: NO, YES \ingroup Config */
@@ -1936,7 +1936,7 @@ void CConfig::SetConfig_Options() {
 
   /*!\brief OUTPUT_FORMAT \n DESCRIPTION: I/O format for output plots. \n OPTIONS: see \link TabOutput_Map \endlink \n DEFAULT: TECPLOT \ingroup Config */
   addEnumOption("TABULAR_FORMAT", Tab_FileFormat, TabOutput_Map, TAB_CSV);
-  /*!\brief OUTPUT_PRECISION \n DESCRIPTION: Set <ofstream>.precision(value) to specified value for SU2_DOT and HISTORY output. Useful for exact gradient validation. */
+  /*!\brief OUTPUT_PRECISION \n DESCRIPTION: Set <ofstream>.precision(value) to specified value for SU2_DOT and HISTORY output. Useful for exact gradient validation. \n DEFAULT: 6 \ingroup Config */
   addUnsignedShortOption("OUTPUT_PRECISION", output_precision, 6);
   /*!\brief ACTDISK_JUMP \n DESCRIPTION: The jump is given by the difference in values or a ratio */
   addEnumOption("ACTDISK_JUMP", ActDisk_Jump, Jump_Map, DIFFERENCE);
@@ -4602,10 +4602,10 @@ void CConfig::SetPostprocessing(unsigned short val_software, unsigned short val_
 
   /*--- Check feassbility for Streamwise Periodic flow ---*/
   if (Kind_Streamwise_Periodic != NONE) {
-    if (Kind_Solver == INC_EULER)
-      SU2_MPI::Error("Streamwise Periodic Flow + Incompressible Euler: Not tested yet.", CURRENT_FUNCTION);
     if (Kind_Regime != INCOMPRESSIBLE)
       SU2_MPI::Error("Streamwise Periodic Flow currently only implemented for incompressible flow.", CURRENT_FUNCTION);
+    if (Kind_Solver == INC_EULER)
+      SU2_MPI::Error("Streamwise Periodic Flow + Incompressible Euler: Not tested yet.", CURRENT_FUNCTION);
     if (nMarker_PerBound != 2)
       SU2_MPI::Error("Streamwise Periodic Flow currently only implemented for one Periodic Marker pair. Combining Streamwise and Spanwise periodicity not possible in the moment.", CURRENT_FUNCTION);
     if (Energy_Equation && Streamwise_Periodic_Temperature && nMarker_Isothermal != 0)

Common/src/geometry/CPhysicalGeometry.cpp

@@ -7519,7 +7519,7 @@ void CPhysicalGeometry::FindUniqueNode_PeriodicBound(CConfig *config) {
   /*-------------------------------------------------------------------------------------------*/
   /*--- Step 2: Amongst all local nodes with the smallest distance to the origin, find the  ---*/
   /*---         globally closest to the origin. Store the found node coordinates in the     ---*/
-  /*---         config container.                                                           ---*/
+  /*---         geometry container.                                                         ---*/
   /*-------------------------------------------------------------------------------------------*/
 
   for (int iRank = 0; iRank < size; iRank++) {
@@ -7533,7 +7533,6 @@ void CPhysicalGeometry::FindUniqueNode_PeriodicBound(CConfig *config) {
       for (unsigned short iDim = 0; iDim < nDim; iDim++)
         Streamwise_Periodic_RefNode[iDim] = Buffer_Recv_RefNode[iRank*nDim + iDim];
     }
-    /*--- The theoretical case, that multiple inlet points with the same distance to the origin exists, remains. ---*/
   }
 
   /*--- Print the reference node to screen. ---*/

Common/src/grid_movement/CVolumetricMovement.cpp

@@ -1641,7 +1641,7 @@ void CVolumetricMovement::SetBoundaryDisplacements(CGeometry *geometry, CConfig
   VarIncrement = 1.0/((su2double)config->GetGridDef_Nonlinear_Iter());
 
   /*--- As initialization, set to zero displacements of all the surfaces except the symmetry
-   plane (which is treated specially, see below), internal and the send-receive boundaries  ---*/
+   plane (which is treated specially, see below), internal and the send-receive boundaries ---*/
 
   for (iMarker = 0; iMarker < config->GetnMarker_All(); iMarker++) {
     if (((config->GetMarker_All_KindBC(iMarker) != SYMMETRY_PLANE) &&

SU2_CFD/include/numerics/flow/flow_sources.hpp

@@ -41,9 +41,9 @@ class CSourceBase_Flow : public CNumerics {
   su2double* residual = nullptr;
   su2double** jacobian = nullptr;
   su2double
-  Streamwise_Periodic_MassFlow,           /*!< \brief Value of current massflow [kg/s] which results in an delta p and therefore an artificial body force vector. */
+  Streamwise_Periodic_MassFlow,           /*!< \brief Value of current massflow [kg/s] which results in a delta p and therefore an artificial body force vector. */
   Streamwise_Periodic_IntegratedHeatFlow, /*!< \brief Value of of the net sum of heatflow [W] into the domain. */
-  Streamwise_Periodic_InletTemperature;   /*!< /brief Area avg static Temp [K] at the periodic inlet. Used for adaptive outlet heatsink. */
+  Streamwise_Periodic_InletTemperature;   /*!< \brief Area avg static Temp [K] at the periodic inlet. Used for adaptive outlet heatsink. */
 
   /*!
    * \brief Constructor of the class.

SU2_CFD/include/solvers/CIncEulerSolver.hpp

@@ -40,9 +40,9 @@ class CIncEulerSolver : public CFVMFlowSolverBase<CIncEulerVariable, INCOMPRESSI
 protected:
   vector<CFluidModel*> FluidModel;   /*!< \brief fluid model used in the solver. */
   su2double
-  Streamwise_Periodic_MassFlow,           /*!< \brief Value of current massflow [kg/s] which results in an delta p and therefore an artificial body force vector. */
+  Streamwise_Periodic_MassFlow,           /*!< \brief Value of current massflow [kg/s] which results in a delta p and therefore an artificial body force vector. */
   Streamwise_Periodic_IntegratedHeatFlow, /*!< \brief Value of of the net sum of heatflow [W] into the domain. */
-  Streamwise_Periodic_InletTemperature;   /*!< /brief Area avg static Temp [K] at the periodic inlet. Used for adaptive outlet heatsink. */
+  Streamwise_Periodic_InletTemperature;   /*!< \brief Area avg static Temp [K] at the periodic inlet. Used for adaptive outlet heatsink. */
 
   /*!
    * \brief Preprocessing actions common to the Euler and NS solvers.