Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Delete all trailing whitespaces and tabs to 2 spaces #808

Merged
merged 11 commits into from
Nov 16, 2019
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
174 changes: 87 additions & 87 deletions Common/doc/docmain.hpp
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
/*!
* \file docmain.hpp
* \brief This file contains documentation for Doxygen and does not have any significance with respect to C++.
* \author F. Palacios
* \version 6.2.0 "Falcon"
*
/*!
* \file docmain.hpp
* \brief This file contains documentation for Doxygen and does not have any significance with respect to C++.
* \author F. Palacios
* \version 6.2.0 "Falcon"
*
* The current SU2 release has been coordinated by the
* SU2 International Developers Society <www.su2devsociety.org>
* with selected contributions from the open-source community.
Expand All @@ -14,85 +14,85 @@
* - Prof. Rafael Palacios' group at Imperial College London.
* - Prof. Edwin van der Weide's group at the University of Twente.
* - Prof. Vincent Terrapon's group at the University of Liege.
*
*
* Copyright 2012-2019, Francisco D. Palacios, Thomas D. Economon,
* Tim Albring, and the SU2 contributors.
*
* SU2 is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* SU2 is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with SU2. If not, see <http://www.gnu.org/licenses/>.
*/
/*!
* \mainpage SU2 version 6.2.0 "Falcon"
* 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
* 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.
*
* The following technical documentation describes the structure and details of the source code for developers.
*/
/*!
* \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
* 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
* 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
* 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.
* \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
* three formulations: direct, adjoint, and linearized.
*/
/*!
* \defgroup Turbulence_Model Solving the turbulence models.
* \brief Group of classes which define the turbulence model in
* three formulations: direct, adjoint, and linearized.
*/
* Tim Albring, and the SU2 contributors.
*
* SU2 is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* SU2 is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with SU2. If not, see <http://www.gnu.org/licenses/>.
*/

/*!
* \mainpage SU2 version 6.2.0 "Falcon"
* 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
* 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.
*
* The following technical documentation describes the structure and details of the source code for developers.
*/

/*!
* \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
* 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
* 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
* 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.
* \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
* three formulations: direct, adjoint, and linearized.
*/

/*!
* \defgroup Turbulence_Model Solving the turbulence models.
* \brief Group of classes which define the turbulence model in
* three formulations: direct, adjoint, and linearized.
*/
24 changes: 12 additions & 12 deletions Common/include/CBoxMeshReaderFVM.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -46,51 +46,51 @@
* \author: T. Economon
*/
class CBoxMeshReaderFVM: public CMeshReaderFVM {

private:

unsigned long nNode; /*!< \brief Number of grid nodes in the x-direction. */
unsigned long mNode; /*!< \brief Number of grid nodes in the y-direction. */
unsigned long pNode; /*!< \brief Number of grid nodes in the z-direction. */

su2double Lx; /*!< \brief Length of the domain in the x-direction. */
su2double Ly; /*!< \brief Length of the domain in the y-direction. */
su2double Lz; /*!< \brief Length of the domain in the z-direction. */

su2double Ox; /*!< \brief Offset of the domain from 0.0 in the x-direction. */
su2double Oy; /*!< \brief Offset of the domain from 0.0 in the y-direction. */
su2double Oz; /*!< \brief Offset of the domain from 0.0 in the z-direction. */

unsigned short KindElem; /*!< \brief VTK identifier of the interior elements. */
unsigned short KindBound; /*!< \brief VTK identifier of the surface elements. */

/*!
* \brief Computes and stores the grid points based on an analytic definition of a box grid.
*/
void ComputeBoxPointCoordinates();

/*!
* \brief Computes and stores the volume element connectivity based on an analytic definition of a box grid.
*/
void ComputeBoxVolumeConnectivity();

/*!
* \brief Computes and stores the surface element connectivity based on an analytic definition of a box grid.
*/
void ComputeBoxSurfaceConnectivity();

public:

/*!
* \brief Constructor of the CBoxMeshReaderFVM class.
*/
CBoxMeshReaderFVM(CConfig *val_config,
unsigned short val_iZone,
unsigned short val_nZone);

/*!
* \brief Destructor of the CBoxMeshReaderFVM class.
*/
~CBoxMeshReaderFVM(void);

};
42 changes: 21 additions & 21 deletions Common/include/CCGNSMeshReaderFVM.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -50,71 +50,71 @@
* \author: T. Economon
*/
class CCGNSMeshReaderFVM: public CMeshReaderFVM {

private:

#ifdef HAVE_CGNS
int cgnsFileID; /*!< \brief CGNS file identifier. */
int cgnsBase; /*!< \brief CGNS database index. */
int cgnsZone; /*!< \brief CGNS zone index. */

int nZones; /*!< \brief Total number of zones in the CGNS file. */
int nSections; /*!< \brief Total number of sections in the CGNS file. */

vector<bool> isInterior; /*!< \brief Vector of booleans to store whether each section in the CGNS file is an interior or boundary section. */
vector<unsigned long> nElems; /*!< \brief Vector containing the local number of elements found within each CGNS section. */
vector<unsigned long> elemOffset; /*!< \brief Global ID offset for each interior section (i.e., the total number of global elements that came before it). */
vector<vector<cgsize_t> > connElems; /*!< \brief Vector containing the local element connectivity found within each CGNS section. First index is the section, second contains the connectivity in format [globalID VTK n1 n2 n3 n4 n5 n6 n7 n8] for each element. */
vector<vector<char> > sectionNames; /*!< \brief Vector for storing the names of each boundary section (marker). */

/*!
* \brief Open the CGNS file and checks for errors.
* \param[in] val_filename - string name of the CGNS file to be read.
*/
void OpenCGNSFile(string val_filename);

/*!
* \brief Reads all CGNS database metadata and checks for errors.
*/
void ReadCGNSDatabaseMetadata();

/*!
* \brief Reads all CGNS zone metadata and checks for errors.
*/
void ReadCGNSZoneMetadata();

/*!
* \brief Reads the grid points from a CGNS zone into linear partitions across all ranks.
*/
void ReadCGNSPointCoordinates();

/*!
* \brief Reads the metadata for each CGNS section in a zone and collect information, including the size and whether it is an interior or boundary section.
*/
void ReadCGNSSectionMetadata();

/*!
* \brief Reads the interior volume elements from one section of a CGNS zone into linear partitions across all ranks.
* \param[in] val_section - CGNS section index.
*/
void ReadCGNSVolumeSection(int val_section);

/*!
* \brief Reads the surface (boundary) elements from the CGNS zone. Only the master rank currently reads and stores the connectivity, which is linearly partitioned later.
* \param[in] val_section - CGNS section index.
*/
void ReadCGNSSurfaceSection(int val_section);

/*!
* \brief Reformats the CGNS volume connectivity from file into the standard base class data structures.
*/
void ReformatCGNSVolumeConnectivity();

/*!
* \brief Reformats the CGNS volume connectivity from file into the standard base class data structures.
*/
void ReformatCGNSSurfaceConnectivity();

/*!
* \brief Get the VTK type and string name for a CGNS element type.
* \param[in] val_elem_type - CGNS element type.
Expand All @@ -124,7 +124,7 @@ class CCGNSMeshReaderFVM: public CMeshReaderFVM {
string GetCGNSElementType(ElementType_t val_elem_type,
int &val_vtk_type);
#endif

/*!
* \brief Routine to launch non-blocking sends and recvs amongst all processors.
* \param[in] bufSend - Buffer of data to be sent.
Expand All @@ -143,7 +143,7 @@ class CCGNSMeshReaderFVM: public CMeshReaderFVM {
SU2_MPI::Request *recvReq,
unsigned short countPerElem,
unsigned short commType);

/*!
* \brief Routine to complete the set of non-blocking communications launched with InitiateComms() with MPI_Waitany().
* \param[in] nSends - Number of sends to be completed.
Expand All @@ -155,20 +155,20 @@ class CCGNSMeshReaderFVM: public CMeshReaderFVM {
SU2_MPI::Request *sendReq,
int nRecvs,
SU2_MPI::Request *recvReq);


public:

/*!
* \brief Constructor of the CCGNSMeshReaderFVM class.
*/
CCGNSMeshReaderFVM(CConfig *val_config,
unsigned short val_iZone,
unsigned short val_nZone);

/*!
* \brief Destructor of the CCGNSMeshReaderFVM class.
*/
~CCGNSMeshReaderFVM(void);

};
Loading