doxygen

Author: pcarruscag

Docs/docmain.hpp

@@ -25,10 +25,10 @@
  * License along with SU2. If not, see <http://www.gnu.org/licenses/>.
  */
 
-/*! 
+/*!
  * \mainpage SU2 version 7.5.1 "Blackbird"
  * SU2 suite is an open-source collection of C++ based software tools
- * to perform PDE analysis and PDE constrained optimization.  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 open-source license.
@@ -66,43 +66,43 @@
 
 /*!
  * \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 
+ * \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
- * \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 
+ * \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
- * \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 
+ * \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 Euler_Equations Solving the Euler equations
- * \brief Group of classes which define the system of Euler equations in 
+ * \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
- * \brief Group of classes which define the system of Navier-Stokes equations in 
+ * \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 model equations
- * \brief Group of classes which define the turbulence model in 
+ * \brief Group of classes which define the turbulence model in
  *		  three formulations: direct, adjoint, and linearized.
  */
 
@@ -130,6 +130,13 @@
  *        space and time integration. The latter use mostly the "Solvers".
  */
 
+/*!
+ * \defgroup PySU2 Python Wrapper functions
+ * \brief Functions of the driver classes (\ref Drivers) that can be used to customize SU2
+ *        via Python. For example, set custom temperature distributions at boundaries,
+ *        deform the mesh, etc.
+ */
+
 /*!
  * \defgroup Variable Storing solution variables
  * \brief Classes used to store and access the solution variables of all types of problems.

SU2_CFD/include/drivers/CDriver.hpp

@@ -403,6 +403,9 @@ class CDriver : public CDriverBase {
    */
   virtual void SetInitialMesh() {}
 
+/// \addtogroup PySU2
+/// \{
+
   /*!
    * \brief Process the boundary conditions and update the multi-grid structure.
    */
@@ -644,6 +647,8 @@ class CDriver : public CDriverBase {
    */
   void SetInlet_Angle(unsigned short iMarker, passivedouble alpha);
 
+/// \}
+
   /*!
    * \brief Sum the number of primal or adjoint variables for all solvers in a given zone.
    * \param[in] iZone - Index of the zone.

SU2_CFD/include/drivers/CDriverBase.hpp

@@ -121,6 +121,9 @@ class CDriverBase {
    */
   virtual void Postprocessing(){}
 
+/// \addtogroup PySU2
+/// @{
+
   /*!
    * \brief Get the number of design variables.
    * \return Number of design variables.
@@ -320,6 +323,7 @@ class CDriverBase {
    * \brief Communicate the boundary mesh displacements.
    */
   void CommunicateMeshDisplacements(void);
+/// \}
 
  protected:
   /*!

SU2_DEF/obj/Makefile.am

@@ -33,7 +33,6 @@ ACLOCAL_AMFLAGS = ${ACLOCAL_FLAGS}
 bin_PROGRAMS = ../bin/SU2_DEF
 
 ___bin_SU2_DEF_SOURCES = \
-  ../include/SU2_DEF.hpp \
   ../src/SU2_DEF.cpp
 
 

SU2_DOT/obj/Makefile.am

@@ -40,8 +40,7 @@ if BUILD_REVERSE
 bin_PROGRAMS += ../bin/SU2_DOT_AD
 endif
 
-su2_dot_sources = ../include/SU2_DOT.hpp \
-		../src/SU2_DOT.cpp
+su2_dot_sources = ../src/SU2_DOT.cpp
 
 su2_dot_ldadd =
 su2_dot_cxx_flags = -std=c++11