fix build and some doxygen cleanup

RichRoos · Sep 11, 2022 · 5f0e319 · 5f0e319
1 parent 2edca53
commit 5f0e319
Show file tree

Hide file tree

Showing 12 changed files with 40 additions and 23 deletions.
diff --git a/Common/doc/docmain.hpp b/Common/doc/docmain.hpp
@@ -28,7 +28,7 @@
 /*! 
  * \mainpage SU2 version 7.4.0 "Blackbird"
  * SU2 suite is an open-source collection of C++ based software tools
- * to perform PDE analysis and PDE constrained optimization problems.  The toolset is designed with 
+ * to perform PDE analysis and PDE constrained optimization.  The toolset is designed with 
  * computational fluid dynamics and aerodynamic shape optimization in mind, but is extensible to
  * include other families of governing equations such as potential flow, electrodynamics, chemically reacting
  * flows, and many others.  SU2 is released under an
@@ -38,54 +38,53 @@
  */
 
 /*!
- * \defgroup Config Descriptions of Configuration Options.
+ * \defgroup Config Description of the Configuration Options
  * \brief Group of variables that can be set using the configuration file.
  */
 
 /*!
- * \defgroup ConvDiscr Discretization of the convective terms.
+ * \defgroup ConvDiscr Discretization of the convective terms
  * \brief Group of classes which define the numerical methods for 
  *		  discretizing the convective terms of a Partial Differential Equation. 
  *		  There are methods for solving the direct, adjoint and linearized 
  *		  systems of equations.
  */
 
 /*!
- * \defgroup ViscDiscr Discretization of the viscous terms.
+ * \defgroup ViscDiscr Discretization of the viscous terms
  * \brief Group of classes which define the numerical methods for 
  *		  discretizing the viscous terms of a Partial Differential Equation. 
  *		  There are methods for solving the direct, adjoint and linearized 
  *		  systems of equations.
  */
 
 /*!
- * \defgroup SourceDiscr Discretization of the source terms.
+ * \defgroup SourceDiscr Discretization of the source terms
  * \brief Group of classes which define the numerical methods for 
  *		  discretizing the source terms of a Partial Differential Equation. 
  *		  There are methods for solving the direct, adjoint and linearized 
  *		  systems of equations.
  */
 
 /*!
- * \defgroup Potential_Flow_Equation Solving the potential flow equation.
- * \brief Group of classes which define the system of Potential flow equation in 
- *		  three formulations: direct, adjoint, and linearized.
- */
-
-/*!
- * \defgroup Euler_Equations Solving the Euler's equations.
+ * \defgroup Euler_Equations Solving the Euler equations
  * \brief Group of classes which define the system of Euler equations in 
  *		  three formulations: direct, adjoint, and linearized.
  */
 
 /*!
- * \defgroup Navier_Stokes_Equations Solving the Navier-Stokes' equations.
+ * \defgroup Navier_Stokes_Equations Solving the Navier-Stokes' equations
  * \brief Group of classes which define the system of Navier-Stokes equations in 
  *		  three formulations: direct, adjoint, and linearized.
  */
 
 /*!
- * \defgroup Turbulence_Model Solving the turbulence models.
+ * \defgroup Turbulence_Model Solving the turbulence model equations
  * \brief Group of classes which define the turbulence model in 
  *		  three formulations: direct, adjoint, and linearized.
  */
+
+/*!
+ * \defgroup Elasticity_Equations Solving the elasticity equations
+ * \brief Group of classes to solve solid deformation problems.
+ */
diff --git a/SU2_CFD/include/numerics/elasticity/CFEAElasticity.hpp b/SU2_CFD/include/numerics/elasticity/CFEAElasticity.hpp
@@ -32,11 +32,11 @@
 
 /*!
  * \class CFEAElasticity
+ * \ingroup Elasticity_Equations
  * \brief Abstract class for computing the tangent matrix and the residual for structural problems.
  * \note  At the next level of abstraction (linear or not) a class must define the constitutive term.
  *        The methods we override in this class with an empty implementation are here just to better
  *        document the public interface of this class hierarchy.
- * \ingroup FEM_Discr
  * \author R.Sanchez
  * \version 7.4.0 "Blackbird"
  */

diff --git a/SU2_CFD/include/numerics/elasticity/CFEALinearElasticity.hpp b/SU2_CFD/include/numerics/elasticity/CFEALinearElasticity.hpp
@@ -33,7 +33,7 @@
 /*!
  * \class CFEALinearElasticity
  * \brief Class for computing the stiffness matrix of a linear, elastic problem.
- * \ingroup FEM_Discr
+ * \ingroup Elasticity_Equations
  * \author R.Sanchez
  * \version 7.4.0 "Blackbird"
  */
@@ -88,7 +88,7 @@ class CFEALinearElasticity : public CFEAElasticity {
 /*!
  * \class CFEAMeshElasticity
  * \brief Particular case of linear elasticity used for mesh deformation.
- * \ingroup FEM_Discr
+ * \ingroup Elasticity_Equations
  * \author R.Sanchez
  * \version 7.4.0 "Blackbird"
  */

diff --git a/SU2_CFD/include/numerics/elasticity/CFEANonlinearElasticity.hpp b/SU2_CFD/include/numerics/elasticity/CFEANonlinearElasticity.hpp
@@ -35,7 +35,7 @@
  *        This class does not implement a particular model, that will be done by its children.
  * \note  In addition to Compute_Constitutive_Matrix, derived classes MUST further implement
  *        Compute_Plane_Stress_Term and Compute_Stress_Tensor.
- * \ingroup FEM_Discr
+ * \ingroup Elasticity_Equations
  * \author R.Sanchez
  * \version 7.4.0 "Blackbird"
  */

diff --git a/SU2_CFD/include/numerics/elasticity/nonlinear_models.hpp b/SU2_CFD/include/numerics/elasticity/nonlinear_models.hpp
@@ -33,7 +33,7 @@
 /*!
  * \class CFEM_NeoHookean_Comp
  * \brief Class for computing the constitutive and stress tensors for a neo-Hookean material model, compressible.
- * \ingroup FEM_Discr
+ * \ingroup Elasticity_Equations
  * \author R.Sanchez
  * \version 7.4.0 "Blackbird"
  */
@@ -81,7 +81,7 @@ class CFEM_NeoHookean_Comp final : public CFEANonlinearElasticity {
 /*!
  * \class CFEM_NeoHookean_Comp
  * \brief Constitutive and stress tensors for a Knowles stored-energy function, nearly incompressible.
- * \ingroup FEM_Discr
+ * \ingroup Elasticity_Equations
  * \author R.Sanchez
  * \version 7.4.0 "Blackbird"
  */
@@ -132,7 +132,7 @@ class CFEM_Knowles_NearInc final : public CFEANonlinearElasticity {
 /*!
  * \class CFEM_DielectricElastomer
  * \brief Class for computing the constitutive and stress tensors for a dielectric elastomer.
- * \ingroup FEM_Discr
+ * \ingroup Elasticity_Equations
  * \author R.Sanchez
  * \version 7.4.0 "Blackbird"
  */
@@ -180,7 +180,7 @@ class CFEM_DielectricElastomer final : public CFEANonlinearElasticity {
 /*!
  * \class CFEM_IdealDE
  * \brief Class for computing the constitutive and stress tensors for a nearly-incompressible ideal DE.
- * \ingroup FEM_Discr
+ * \ingroup Elasticity_Equations
  * \author R.Sanchez
  * \version 7.4.0 "Blackbird"
  */

diff --git a/SU2_CFD/include/numerics_simd/flow/convection/centered.hpp b/SU2_CFD/include/numerics_simd/flow/convection/centered.hpp
@@ -36,6 +36,7 @@
 
 /*!
  * \class CCenteredBase
+ * \ingroup ConvDiscr
  * \brief Base class for Centered schemes, derived classes implement
  * the dissipation term in a const "finalizeFlux" method.
  * \note See CRoeBase for the role of Base.
@@ -186,6 +187,7 @@ class CCenteredBase : public Base {
 
 /*!
  * \class CJSTScheme
+ * \ingroup ConvDiscr
  * \brief Classical JST scheme with scalar dissipation.
  */
 template<class Decorator>
@@ -265,6 +267,7 @@ class CJSTScheme : public CCenteredBase<CJSTScheme<Decorator>,Decorator> {
 
 /*!
  * \class CJSTmatScheme
+ * \ingroup ConvDiscr
  * \brief JST scheme with matrix dissipation.
  */
 template<class Decorator>
@@ -391,6 +394,7 @@ class CJSTmatScheme : public CCenteredBase<CJSTmatScheme<Decorator>,Decorator> {
 
 /*!
  * \class CJSTkeScheme
+ * \ingroup ConvDiscr
  * \brief JST scheme without 4th order dissipation.
  */
 template<class Decorator>
@@ -461,6 +465,7 @@ class CJSTkeScheme : public CCenteredBase<CJSTkeScheme<Decorator>,Decorator> {
 
 /*!
  * \class CLaxScheme
+ * \ingroup ConvDiscr
  * \brief Lax–Friedrichs 1st order scheme.
  */
 template<class Decorator>

diff --git a/SU2_CFD/include/numerics_simd/flow/convection/roe.hpp b/SU2_CFD/include/numerics_simd/flow/convection/roe.hpp
@@ -36,6 +36,7 @@
 
 /*!
  * \class CRoeBase
+ * \ingroup ConvDiscr
  * \brief Base class for Roe schemes, derived classes implement
  * the dissipation term in a const "finalizeFlux" method.
  * A base class implementing "viscousTerms" is accepted as template parameter.
@@ -215,6 +216,7 @@ class CRoeBase : public Base {
 
 /*!
  * \class CRoeScheme
+ * \ingroup ConvDiscr
  * \brief Classical Roe scheme.
  */
 template<class Decorator>

diff --git a/SU2_CFD/include/numerics_simd/flow/diffusion/viscous_fluxes.hpp b/SU2_CFD/include/numerics_simd/flow/diffusion/viscous_fluxes.hpp
@@ -34,6 +34,7 @@
 
 /*!
  * \class CNoViscousFlux
+ * \ingroup ViscDiscr
  * \brief Numerics classes that accept a compile-time decorator should use this
  * class template as a "do-nothing" decorator and as a link to the interface when
  * they are not being decorated.
@@ -63,6 +64,7 @@ class CNoViscousFlux : public CNumericsSIMD {
 
 /*!
  * \class CCompressibleViscousFluxBase
+ * \ingroup ViscDiscr
  * \brief Decorator class to add viscous fluxes (compressible flow).
  */
 template<size_t NDIM, class Derived>
@@ -248,6 +250,7 @@ class CCompressibleViscousFluxBase : public CNumericsSIMD {
 
 /*!
  * \class CCompressibleViscousFlux
+ * \ingroup ViscDiscr
  * \brief Decorator class to add viscous fluxes (compressible flow, ideal gas).
  */
 template<size_t NDIM>
@@ -306,6 +309,7 @@ class CCompressibleViscousFlux : public CCompressibleViscousFluxBase<NDIM, CComp
 
 /*!
  * \class CGeneralCompressibleViscousFlux
+ * \ingroup ViscDiscr
  * \brief Decorator class to add viscous fluxes (compressible flow, real gas).
  */
 template<size_t NDIM>

diff --git a/SU2_CFD/include/solvers/CEulerSolver.hpp b/SU2_CFD/include/solvers/CEulerSolver.hpp
@@ -32,6 +32,7 @@
 
 /*!
  * \class CEulerSolver
+ * \ingroup Euler_Equations
  * \brief Class for compressible inviscid flow problems, serves as base for Navier-Stokes/RANS.
  * \author F. Palacios
  */

diff --git a/SU2_CFD/include/solvers/CFEASolver.hpp b/SU2_CFD/include/solvers/CFEASolver.hpp
@@ -31,6 +31,7 @@
 
 /*!
  * \class CFEASolver
+ * \ingroup Elasticity_Equations
  * \brief Main class for defining a FEM solver for elastic structural problems.
  * \author R. Sanchez.
  */

diff --git a/SU2_CFD/include/solvers/CFEASolverBase.hpp b/SU2_CFD/include/solvers/CFEASolverBase.hpp
@@ -33,6 +33,11 @@
 #include "../../../Common/include/geometry/elements/CElement.hpp"
 #include "../../../Common/include/parallelization/omp_structure.hpp"
 
+/*!
+ * \class CFEASolverBase
+ * \ingroup Elasticity_Equations
+ * \brief Base class for FEM elasticity solvers.
+ */
 class CFEASolverBase : public CSolver {
  public:
   enum : size_t {MAXNNODE_2D = 4};

diff --git a/SU2_CFD/include/variables/CFlowVariable.hpp b/SU2_CFD/include/variables/CFlowVariable.hpp
@@ -75,7 +75,7 @@ class CFlowVariable : public CVariable {
    */
   template <class T>
   inline T UpdateNonPhysicalEdgeCounter(unsigned long iEdge, const T& isNonPhys) const {
-    if (isNonPhys) {
+    if (isNonPhys > 0) {
       /*--- Force 1st order for this edge for at least 20 iterations. ---*/
       NonPhysicalEdgeCounter[iEdge] = 21;
     }