Merge branch 'develop'

SU2 v3.2.3

Common/doc/docmain.hpp

@@ -24,6 +24,11 @@
  *
  */
 
+/*!
+ * \defgroup Config Descriptions of Configuration Options.
+ * \brief Group of variables that can be set using the configuration file.
+ */
+
 /*!
  * \defgroup ConvDiscr Discretization of the convective terms.
  * \brief Group of classes which define the numerical methods for 

Common/include/config_structure.hpp

@@ -3,7 +3,7 @@
  * \brief All the information about the definition of the physical problem.
  *        The subroutines and functions are in the <i>config_structure.cpp</i> file.
  * \author Aerospace Design Laboratory (Stanford University) <http://su2.stanford.edu>.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  *
  * SU2, Copyright (C) 2012-2014 Aerospace Design Laboratory (ADL).
  *
@@ -46,16 +46,18 @@ using namespace std;
  * \brief Main class for defining the problem; basically this class reads the configuration file, and
  *        stores all the information.
  * \author F. Palacios.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  */
 class CConfig {
 private:
 	unsigned short Kind_SU2; /*!< \brief Kind of SU2 software component. */
 	unsigned short iZone, nZone; /*!< \brief Number of zones in the mesh. */
 	double OrderMagResidual; /*!< \brief Order of magnitude reduction. */
 	double MinLogResidual; /*!< \brief Minimum value of the log residual. */
+	double EA_ScaleFactor; /*!< \brief Equivalent Area scaling factor */
 	double* EA_IntLimit; /*!< \brief Integration limits of the Equivalent Area computation */
   double AdjointLimit; /*!< \brief Adjoint variable limit */
+  double* Subsonic_Nacelle_Box; /*!< \brief Coordinates of the box subsonic region */
 	double* Hold_GridFixed_Coord; /*!< \brief Coordinates of the box to hold fixed the nbumerical grid */
 	unsigned short ConvCriteria;	/*!< \brief Kind of convergence criteria. */
   unsigned short nFFD_Iter; 	/*!< \brief Iteration for the point inversion problem. */
@@ -93,18 +95,17 @@ class CConfig {
 	double WeightCd; /*!< \brief Weight of the drag coefficient. */
 	unsigned short Unsteady_Simulation;	/*!< \brief Steady or unsteady (time stepping or dual time stepping) computation. */
 	unsigned short nStartUpIter;	/*!< \brief Start up iterations using the fine grid. */
-	double CteViscDrag;		/*!< \brief Constant value of the viscous drag. */
   double FixAzimuthalLine; /*!< \brief Fix an azimuthal line due to misalignments of the nearfield. */
 	double *DV_Value;		/*!< \brief Previous value of the design variable. */
 	double LimiterCoeff;				/*!< \brief Limiter coefficient */
   unsigned long LimiterIter;	/*!< \brief Freeze the value of the limiter after a number of iterations */
 	double SharpEdgesCoeff;				/*!< \brief Coefficient to identify the limit of a sharp edge. */
   unsigned short SystemMeasurements; /*!< \brief System of measurements. */
-  unsigned short Kind_Regime;	/*!< \brief Kind of adjoint function. */
-	unsigned short Kind_ObjFunc;	/*!< \brief Kind of objective function. */
-	unsigned short Kind_SensSmooth;	/*!< \brief Kind of sensitivity smoothing technique. */
-	unsigned short Continuous_Eqns;	/*!< \brief Which equations to treat continuously (Hybrid adjoint) */
-	unsigned short Discrete_Eqns;	/*!< \brief Which equations to treat discretely (Hybrid adjoint). */
+  unsigned short Kind_Regime;  /*!< \brief Kind of adjoint function. \n SYNTAX: REGIME_TYPE = COMPRESSIBLE.\ingroup Config */
+  unsigned short Kind_ObjFunc;  /*!< \brief Kind of objective function. \n SYNTAX: OBJECTIVE_FUNCTION = DRAG_COEFFICIENT \ingroup Config */
+  unsigned short Kind_SensSmooth; /*!< \brief Kind of sensitivity smoothing technique.  \n SYNTAX: SENS_SMOOTHING = NO_SMOOTH  \ingroup Config */
+  unsigned short Continuous_Eqns; /*!< \brief Which equations to treat continuously (Hybrid adjoint)  \n SYNTAX: CONTINUOUS_EQNS = EULER_EQNS \ingroup Config */
+  unsigned short Discrete_Eqns; /*!< \brief Which equations to treat discretely (Hybrid adjoint). \n SYNTAX: DISCRETE_EQNS NONE_EQNS \ingroup Config  */
 	unsigned short *Design_Variable; /*!< \brief Kind of design variable. */
 	double RatioDensity,				/*!< \brief Ratio of density for a free surface problem. */
 	RatioViscosity,				/*!< \brief Ratio of viscosity for a free surface problem. */
@@ -243,8 +244,6 @@ class CConfig {
 	CFLRedCoeff_AdjTurb,	/*!< \brief CFL reduction coefficient for the adjoint problem. */
 	CFLFineGrid,		/*!< \brief CFL of the finest grid. */
 	Unst_CFL;		/*!< \brief Unsteady CFL number. */
-	unsigned short MaxChildren;		/*!< \brief Maximum number of children. */
-	double MaxDimension;			/*!< \brief Maximum dimension of the aglomerated element compared with the whole domain. */
 	bool AddIndNeighbor;			/*!< \brief Include indirect neighbor in the agglomeration process. */
 	unsigned short nDV;		/*!< \brief Number of design variables. */
   unsigned short nGridMovement;		/*!< \brief Number of grid movement types specified. */
@@ -395,6 +394,7 @@ class CConfig {
 	Cauchy_Func_AdjFlow,				/*!< \brief Function where to apply the convergence criteria in the adjoint problem. */
 	Cauchy_Func_LinFlow,				/*!< \brief Function where to apply the convergence criteria in the linearized problem. */
 	Cauchy_Elems;						/*!< \brief Number of elements to evaluate. */
+	unsigned short Residual_Func_Flow;	/*!< \brief Equation to apply residual convergence to. */
 	unsigned long StartConv_Iter;	/*!< \brief Start convergence criteria at iteration. */
 	double Cauchy_Eps,	/*!< \brief Epsilon used for the convergence. */
 	Cauchy_Eps_OneShot,	/*!< \brief Epsilon used for the one shot method convergence. */
@@ -975,12 +975,6 @@ class CConfig {
 	 */
 	void SetRefOriginMoment_Z(unsigned short val_marker, double val_origin);
 
-	/*!
-	 * \brief Get maximum number of children in the agglomeration process.
-	 * \return Maximum number of children.
-	 */
-	unsigned short GetMaxChildren(void);
-
 	/*!
 	 * \brief Get index of the upper and lower horizontal plane.
 	 * \param[in] index - 0 means upper surface, and 1 means lower surface.
@@ -994,6 +988,13 @@ class CConfig {
 	 * \return Integration limits for the equivalent area computation.
 	 */
 	double GetEA_IntLimit(unsigned short index);
+
+  /*!
+	 * \brief Get the integration limits for the equivalent area computation.
+	 * \param[in] index - 0 means x_min, and 1 means x_max.
+	 * \return Integration limits for the equivalent area computation.
+	 */
+	double GetEA_ScaleFactor(void);
 
   /*!
 	 * \brief Get the limit value for the adjoint variables.
@@ -1007,6 +1008,12 @@ class CConfig {
 	 */
 	double *GetHold_GridFixed_Coord(void);
 
+  /*!
+   * \brief Get the the coordinates where of the box where a subsonic region is imposed.
+   * \return Coordinates where of the box where the grid is going to be a subsonic region.
+   */
+  double *GetSubsonic_Nacelle_Box(void);
+
 	/*!
 	 * \brief Get the power of the dual volume in the grid adaptation sensor.
 	 * \return Power of the dual volume in the grid adaptation sensor.
@@ -1029,12 +1036,6 @@ class CConfig {
 	 */
 	unsigned short GetAxis_Orientation(void);
 
-	/*!
-	 * \brief Get the maximum dimension of the agglomerated element compared with the whole domain.
-	 * \return Maximum dimension of the agglomerated element.
-	 */
-	double GetMaxDimension(void);
-
 	/*!
 	 * \brief Get the ratio of density for a free surface problem.
 	 * \return Ratio of density for a free surface problem.
@@ -3726,6 +3727,12 @@ class CConfig {
 	 * \return Name of the file with the appropriate objective function extension.
 	 */
   string GetObjFunc_Extension(string val_filename);
+
+        /*!
+  	 * \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.
+  	 */
+  	unsigned short GetResidual_Func_Flow(void);
 
 	/*!
 	 * \brief Get functional that is going to be used to evaluate the flow convergence.
@@ -4283,12 +4290,6 @@ class CConfig {
 	 */
 	double GetWeightCd(void);
 
-	/*!
-	 * \brief Value of ther constant viscous drag for Cl/Cd computation.
-	 * \return Value of ther constant viscous drag for Cl/Cd computation.
-	 */
-	double GetCteViscDrag(void);
-
   /*!
 	 * \brief Value of the azimuthal line to fix due to a misalignments of the nearfield.
 	 * \return Azimuthal line to fix due to a misalignments of the nearfield.

Common/include/config_structure.inl

@@ -2,7 +2,7 @@
  * \file config_structure.inl
  * \brief In-Line subroutines of the <i>config_structure.hpp</i> file.
  * \author Aerospace Design Laboratory (Stanford University) <http://su2.stanford.edu>.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  *
  * SU2, Copyright (C) 2012-2014 Aerospace Design Laboratory (ADL).
  *
@@ -56,17 +56,17 @@ inline long CConfig::GetUnst_RestartIter(void) { return Unst_RestartIter; }
 
 inline long CConfig::GetUnst_AdjointIter(void) { return Unst_AdjointIter; }
 
-inline unsigned short CConfig::GetMaxChildren(void) { return MaxChildren; }
-
 inline string CConfig::GetPlaneTag(unsigned short index) { return PlaneTag[index]; }
 
 inline double CConfig::GetEA_IntLimit(unsigned short index) { return EA_IntLimit[index]; }
 
+inline double CConfig::GetEA_ScaleFactor(void) { return EA_ScaleFactor; }
+
 inline double CConfig::GetAdjointLimit(void) { return AdjointLimit; }
 
 inline double *CConfig::GetHold_GridFixed_Coord(void) { return Hold_GridFixed_Coord; }
 
-inline double CConfig::GetMaxDimension(void) { return MaxDimension; }
+inline double *CConfig::GetSubsonic_Nacelle_Box(void) { return Subsonic_Nacelle_Box; }
 
 inline double CConfig::GetRatioDensity(void) { return RatioDensity; }
 
@@ -904,6 +904,8 @@ inline string CConfig::GetSurfAdjCoeff_FileName(void) { return SurfAdjCoeff_File
 
 inline string CConfig::GetSurfLinCoeff_FileName(void) { return SurfLinCoeff_FileName; }
 
+inline unsigned short CConfig::GetResidual_Func_Flow(void) { return Residual_Func_Flow; }
+
 inline unsigned short CConfig::GetCauchy_Func_Flow(void) { return Cauchy_Func_Flow; }
 
 inline unsigned short CConfig::GetCauchy_Func_AdjFlow(void) { return Cauchy_Func_AdjFlow; }
@@ -952,8 +954,6 @@ inline double CConfig::GetPosition_Plane(void) { return Position_Plane; }
 
 inline double CConfig::GetWeightCd(void) { return WeightCd; }
 
-inline double CConfig::GetCteViscDrag(void) { return CteViscDrag; }
-
 inline double CConfig::GetFixAzimuthalLine(void) { return FixAzimuthalLine; }
 
 inline double CConfig::GetCFLRedCoeff_Turb(void) { return CFLRedCoeff_Turb; }

Common/include/dual_grid_structure.hpp

@@ -3,7 +3,7 @@
  * \brief Headers of the main subroutines for doing the complete dual grid structure.
  *        The subroutines and functions are in the <i>dual_grid_structure.cpp</i> file.
  * \author Aerospace Design Laboratory (Stanford University) <http://su2.stanford.edu>.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  *
  * SU2, Copyright (C) 2012-2014 Aerospace Design Laboratory (ADL).
  *
@@ -40,7 +40,7 @@ using namespace std;
  * \brief Class for controlling the dual volume definition. The dual volume is compose by 
  *        three main elements: points, edges, and vertices.
  * \author F. Palacios.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  */
 class CDualGrid{
 protected:
@@ -125,7 +125,7 @@ class CDualGrid{
  * \class CPoint
  * \brief Class for point definition (including control volume definition).
  * \author F. Palacios.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  */
 class CPoint : public CDualGrid {
 private:
@@ -720,7 +720,7 @@ class CPoint : public CDualGrid {
  * \class CEdge
  * \brief Class for defining an edge.
  * \author F. Palacios.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  */
 class CEdge : public CDualGrid {
 private:
@@ -857,7 +857,7 @@ class CEdge : public CDualGrid {
  * \class CVertex
  * \brief Class for vertex definition (equivalent to edges, but for the boundaries).
  * \author F. Palacios.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  */
 class CVertex : public CDualGrid {
 private:

Common/include/dual_grid_structure.inl

@@ -2,7 +2,7 @@
  * \file dual_grid_structure.inl
  * \brief In-Line subroutines of the <i>dual_grid_structure.hpp</i> file.
  * \author Aerospace Design Laboratory (Stanford University) <http://su2.stanford.edu>.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  *
  * SU2, Copyright (C) 2012-2014 Aerospace Design Laboratory (ADL).
  *

Common/include/geometry_structure.hpp

@@ -3,7 +3,7 @@
  * \brief Headers of the main subroutines for creating the geometrical structure.
  *        The subroutines and functions are in the <i>geometry_structure.cpp</i> file.
  * \author Aerospace Design Laboratory (Stanford University) <http://su2.stanford.edu>.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  *
  * SU2, Copyright (C) 2012-2014 Aerospace Design Laboratory (ADL).
  *
@@ -52,7 +52,7 @@ using namespace std;
  * \brief Parent class for defining the geometry of the problem (complete geometry, 
  *        multigrid agglomerated geometry, only boundary geometry, etc..)
  * \author F. Palacios.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  */
 class CGeometry {
 protected:
@@ -820,7 +820,7 @@ class CGeometry {
  * \brief Class for reading a defining the primal grid which is read from the 
  *        grid file in .su2 format.
  * \author F. Palacios.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  */
 class CPhysicalGeometry : public CGeometry {
 
@@ -1290,7 +1290,7 @@ class CPhysicalGeometry : public CGeometry {
  * \brief Class for defining the multigrid geometry, the main delicated part is the 
  *        agglomeration stage, which is done in the declaration.
  * \author F. Palacios.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  */
 class CMultiGridGeometry : public CGeometry {
 
@@ -1460,7 +1460,7 @@ class CMultiGridGeometry : public CGeometry {
  * \brief Class for only defining the boundary of the geometry, this class is only 
  *        used in case we are not interested in the volumetric grid.
  * \author F. Palacios.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  */
 class CBoundaryGeometry : public CGeometry {
 
@@ -1560,7 +1560,7 @@ class CBoundaryGeometry : public CGeometry {
  * \class CPeriodicGeometry
  * \brief Class for defining a periodic boundary condition.
  * \author T. Economon, F. Palacios.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  */
 class CPeriodicGeometry : public CGeometry {
 	CPrimalGrid*** newBoundPer;            /*!< \brief Boundary vector for new periodic elements (primal grid information). */
@@ -1606,7 +1606,7 @@ class CPeriodicGeometry : public CGeometry {
  * \struct CMultiGridQueue
  * \brief Class for a multigrid queue system
  * \author F. Palacios.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  * \date Aug 12, 2012
  */
 class CMultiGridQueue {

Common/include/geometry_structure.inl

@@ -2,7 +2,7 @@
  * \file geometry_structure.inl
  * \brief In-Line subroutines of the <i>geometry_structure.hpp</i> file.
  * \author Aerospace Design Laboratory (Stanford University) <http://su2.stanford.edu>.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  *
  * SU2, Copyright (C) 2012-2014 Aerospace Design Laboratory (ADL).
  *

Common/include/grid_adaptation_structure.hpp

@@ -5,7 +5,7 @@
  *        technique definition). The subroutines and functions are in
  *        the <i>grid_movement_structure.cpp</i> file.
  * \author Aerospace Design Laboratory (Stanford University) <http://su2.stanford.edu>.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  *
  * SU2, Copyright (C) 2012-2014 Aerospace Design Laboratory (ADL).
  *

Common/include/grid_adaptation_structure.inl

@@ -2,7 +2,7 @@
  * \file grid_adaptation_structure.inl
  * \brief In-Line subroutines of the <i>grid_adaptation_structure.hpp</i> file.
  * \author Aerospace Design Laboratory (Stanford University) <http://su2.stanford.edu>.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  *
  * SU2, Copyright (C) 2012-2014 Aerospace Design Laboratory (ADL).
  *

Common/include/grid_movement_structure.hpp

@@ -5,7 +5,7 @@
  *        technique definition). The subroutines and functions are in 
  *        the <i>grid_movement_structure.cpp</i> file.
  * \author Aerospace Design Laboratory (Stanford University) <http://su2.stanford.edu>.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  *
  * SU2, Copyright (C) 2012-2014 Aerospace Design Laboratory (ADL).
  *
@@ -47,7 +47,7 @@ using namespace std;
  * \brief Class for moving the surface and volumetric 
  *        numerical grid (2D and 3D problems).
  * \author F. Palacios.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  */
 class CGridMovement {
 public:
@@ -76,7 +76,7 @@ class CGridMovement {
  * \class CFreeFormDefBox
  * \brief Class for defining the free form FFDBox structure.
  * \author F. Palacios & A. Galdran.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  */
 class CFreeFormDefBox : public CGridMovement {
 public:
@@ -681,7 +681,7 @@ class CFreeFormDefBox : public CGridMovement {
  * \class CVolumetricMovement
  * \brief Class for moving the volumetric numerical grid.
  * \author F. Palacios, A. Bueno, T. Economon, S. Padron.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  */
 class CVolumetricMovement : public CGridMovement {
 protected:
@@ -943,7 +943,7 @@ class CVolumetricMovement : public CGridMovement {
  * \class CSurfaceMovement
  * \brief Class for moving the surface numerical grid.
  * \author F. Palacios, T. Economon.
- * \version 3.2.2 "eagle"
+ * \version 3.2.3 "eagle"
  */
 class CSurfaceMovement : public CGridMovement {
 protected: