Merge pull request #1361 from su2code/cleanup_meshreader

Cleanup ASCII mesh reader

Author: pcarruscag

Common/include/geometry/meshreader/CMeshReaderFVM.hpp

@@ -37,7 +37,7 @@
 /*!
  * \class CMeshReaderFVM
  * \brief Base class for the mesh zone readers of the finite volume solver (FVM).
- * \author: T. Economon
+ * \author T. Economon
  */
 class CMeshReaderFVM {
 
@@ -46,7 +46,7 @@ class CMeshReaderFVM {
   const int rank;  /*!< \brief MPI Rank. */
   const int size;  /*!< \brief MPI Size. */
 
-  CConfig* const config = nullptr; /*!< \brief Local pointer to the config parameter object. */
+  const CConfig* config = nullptr; /*!< \brief Local pointer to the config parameter object. */
 
   unsigned short dimension = 0; /*!< \brief Dimension of the problem (2 or 3). */
 
@@ -70,15 +70,10 @@ class CMeshReaderFVM {
    * \param[in] val_iZone  - Current zone index.
    * \param[in] val_nZone  - Total number of zones.
    */
-  CMeshReaderFVM(CConfig        *val_config,
+  CMeshReaderFVM(const CConfig *val_config,
                  unsigned short val_iZone,
                  unsigned short val_nZone);
 
-  /*!
-   * \brief Destructor of the CMeshReaderFVM class.
-   */
-  ~CMeshReaderFVM(void) = default;
-
   /*!
    * \brief Get the physical dimension of the problem (2 or 3).
    * \returns Physical dimension of the problem.
@@ -109,7 +104,7 @@ class CMeshReaderFVM {
    * \param[in] val_iMarker - current marker index.
    * \returns Number of surface elements for a marker.
    */
-  inline unsigned long GetNumberOfSurfaceElementsForMarker(int val_iMarker) {
+  inline unsigned long GetNumberOfSurfaceElementsForMarker(int val_iMarker) const {
     return (unsigned long)surfaceElementConnectivity[val_iMarker].size()/SU2_CONN_SIZE;
   }
 

Common/include/geometry/meshreader/CRectangularMeshReaderFVM.hpp

@@ -71,13 +71,8 @@ class CRectangularMeshReaderFVM: public CMeshReaderFVM {
   /*!
    * \brief Constructor of the CRectangularMeshReaderFVM class.
    */
-  CRectangularMeshReaderFVM(CConfig        *val_config,
+  CRectangularMeshReaderFVM(const CConfig *val_config,
                             unsigned short val_iZone,
                             unsigned short val_nZone);
 
-  /*!
-   * \brief Destructor of the CRectangularMeshReaderFVM class.
-   */
-  ~CRectangularMeshReaderFVM(void);
-
 };

Common/include/geometry/meshreader/CSU2ASCIIMeshReaderFVM.hpp

@@ -28,30 +28,34 @@
 
 #pragma once
 
+#include <array>
+
 #include "CMeshReaderFVM.hpp"
 
 /*!
  * \class CSU2ASCIIMeshReaderFVM
  * \brief Reads a native SU2 ASCII grid into linear partitions for the finite volume solver (FVM).
- * \author: T. Economon
+ * \author T. Economon
  */
 class CSU2ASCIIMeshReaderFVM: public CMeshReaderFVM {
 
 private:
+  enum class FileSection { POINTS, ELEMENTS, MARKERS }; /*!< \brief Different sections of the file. */
+  std::array<FileSection, 3> SectionOrder{};            /*!< \brief Order of the sections in the file. */
 
-  unsigned short myZone; /*!< \brief Current SU2 zone index. */
-  unsigned short nZones; /*!< \brief Total number of zones in the SU2 file. */
+  const unsigned short myZone; /*!< \brief Current SU2 zone index. */
+  const unsigned short nZones; /*!< \brief Total number of zones in the SU2 file. */
 
-  string meshFilename; /*!< \brief Name of the SU2 ASCII mesh file being read. */
+  const string meshFilename; /*!< \brief Name of the SU2 ASCII mesh file being read. */
   ifstream mesh_file;  /*!< \brief File object for the SU2 ASCII mesh file. */
 
   bool actuator_disk; /*!< \brief Boolean for whether we have an actuator disk to split. */
 
-  unsigned long ActDiskNewPoints; /*!< \brief Total number of new grid points to add due to actuator disk splitting. */
+  unsigned long ActDiskNewPoints = 0; /*!< \brief Total number of new grid points to add due to actuator disk splitting. */
 
-  su2double Xloc; /*!< \brief X-coordinate of the CG of the actuator disk surface. */
-  su2double Yloc; /*!< \brief X-coordinate of the CG of the actuator disk surface. */
-  su2double Zloc; /*!< \brief X-coordinate of the CG of the actuator disk surface. */
+  su2double Xloc = 0.0; /*!< \brief X-coordinate of the CG of the actuator disk surface. */
+  su2double Yloc = 0.0; /*!< \brief X-coordinate of the CG of the actuator disk surface. */
+  su2double Zloc = 0.0; /*!< \brief X-coordinate of the CG of the actuator disk surface. */
 
   vector<bool> ActDisk_Bool; /*!< \brief Flag to identify the grid points on the actuator disk. */
 
@@ -68,8 +72,11 @@ class CSU2ASCIIMeshReaderFVM: public CMeshReaderFVM {
 
   /*!
    * \brief Reads all SU2 ASCII mesh metadata and checks for errors.
+   * \param[in] single_pass - Try to read the contents together with the metadata if the order allows (points before elements).
+   * \param[in,out] config - Problem configuration where some metadata is updated (e.g. AoA).
+   * \returns True if single_pass was successful.
    */
-  void ReadMetadata();
+  bool ReadMetadata(const bool single_pass, CConfig *config);
 
   /*!
    * \brief Splits a single surface actuator disk boundary into two separate markers (repeated points).
@@ -79,17 +86,17 @@ class CSU2ASCIIMeshReaderFVM: public CMeshReaderFVM {
   /*!
    * \brief Reads the grid points from an SU2 zone into linear partitions across all ranks.
    */
-  void ReadPointCoordinates();
+  void ReadPointCoordinates(const bool single_pass = false);
 
   /*!
    * \brief Reads the interior volume elements from one section of an SU2 zone into linear partitions across all ranks.
    */
-  void ReadVolumeElementConnectivity();
+  void ReadVolumeElementConnectivity(const bool single_pass = false);
 
   /*!
    * \brief Reads the surface (boundary) elements from the SU2 zone.
    */
-  void ReadSurfaceElementConnectivity();
+  void ReadSurfaceElementConnectivity(const bool single_pass = false);
 
   /*!
    * \brief Helper function to find the current zone in an SU2 ASCII mesh object.
@@ -101,13 +108,8 @@ class CSU2ASCIIMeshReaderFVM: public CMeshReaderFVM {
   /*!
    * \brief Constructor of the CSU2ASCIIMeshReaderFVM class.
    */
-  CSU2ASCIIMeshReaderFVM(CConfig        *val_config,
+  CSU2ASCIIMeshReaderFVM(CConfig *val_config,
                          unsigned short val_iZone,
                          unsigned short val_nZone);
 
-  /*!
-   * \brief Destructor of the CSU2ASCIIMeshReaderFVM class.
-   */
-  ~CSU2ASCIIMeshReaderFVM(void);
-
 };

Common/include/option_structure.hpp

@@ -170,6 +170,24 @@ inline unsigned short nFacesOfElementType(unsigned short elementType) {
   }
 }
 
+/*!
+ * \brief Get the number of points of the element.
+ * \param[in] elementType - element type
+ * \return number of points
+ */
+inline unsigned short nPointsOfElementType(unsigned short elementType) {
+  switch (elementType) {
+    case LINE: return N_POINTS_LINE;
+    case TRIANGLE: return N_POINTS_TRIANGLE;
+    case QUADRILATERAL: return N_POINTS_QUADRILATERAL;
+    case TETRAHEDRON: return N_POINTS_TETRAHEDRON;
+    case HEXAHEDRON: return N_POINTS_HEXAHEDRON;
+    case PYRAMID: return N_POINTS_PYRAMID;
+    case PRISM: return N_POINTS_PRISM;
+    default: assert(false && "Invalid element type."); return 0;
+  }
+}
+
 const int CGNS_STRING_SIZE = 33; /*!< \brief Length of strings used in the CGNS format. */
 const int SU2_CONN_SIZE   = 10;  /*!< \brief Size of the connectivity array that is allocated for each element
                                              that we read from a mesh file in the format [[globalID vtkType n0 n1 n2 n3 n4 n5 n6 n7 n8]. */

Common/include/toolboxes/CLinearPartitioner.hpp

@@ -116,4 +116,14 @@ class CLinearPartitioner {
     return cumulativeSizeBeforeRank[rank];
   }
 
+  /*!
+   * \brief Checks if an index belongs to a rank.
+   * \param[in] index - Current index.
+   * \param[in] rank - MPI rank identifier.
+   * \returns True if index is owned by rank.
+   */
+  bool IndexBelongsToRank(unsigned long index, int rank) const {
+    return index >= cumulativeSizeBeforeRank[rank] && index < cumulativeSizeBeforeRank[rank+1];
+  }
+
 };

Common/src/geometry/meshreader/CMeshReaderFVM.cpp

@@ -28,7 +28,7 @@
 
 #include "../../../include/geometry/meshreader/CMeshReaderFVM.hpp"
 
-CMeshReaderFVM::CMeshReaderFVM(CConfig *val_config,
+CMeshReaderFVM::CMeshReaderFVM(const CConfig *val_config,
                                unsigned short val_iZone,
                                unsigned short val_nZone) :
   rank(SU2_MPI::GetRank()),

Common/src/geometry/meshreader/CRectangularMeshReaderFVM.cpp

@@ -29,7 +29,7 @@
 #include "../../../include/toolboxes/CLinearPartitioner.hpp"
 #include "../../../include/geometry/meshreader/CRectangularMeshReaderFVM.hpp"
 
-CRectangularMeshReaderFVM::CRectangularMeshReaderFVM(CConfig        *val_config,
+CRectangularMeshReaderFVM::CRectangularMeshReaderFVM(const CConfig *val_config,
                                                      unsigned short val_iZone,
                                                      unsigned short val_nZone)
 : CMeshReaderFVM(val_config, val_iZone, val_nZone) {
@@ -64,8 +64,6 @@ CRectangularMeshReaderFVM::CRectangularMeshReaderFVM(CConfig        *val_config,
 
 }
 
-CRectangularMeshReaderFVM::~CRectangularMeshReaderFVM(void) { }
-
 void CRectangularMeshReaderFVM::ComputeRectangularPointCoordinates() {
 
   /* Set the global count of points based on the grid dimensions. */