CMeshReaderBase.hpp

Go to the documentation of this file.

 
/*!
 * \file CMeshReaderBase.hpp
 * \brief Header file for the class CMeshReaderBase.
 *        The implementations are in the <i>CMeshReaderBase.cpp</i> file.
 * \author T. Economon
 * \version 8.5.0 "Harrier"
 *
 * SU2 Project Website: https://su2code.github.io
 *
 * The SU2 Project is maintained by the SU2 Foundation
 * (http://su2foundation.org)
 *
 * Copyright 2012-2026, SU2 Contributors (cf. AUTHORS.md)
 *
 * 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/>.
 */
 
#pragma once
 
#include <string.h>
 
#include "../primal_grid/CPrimalGridFEM.hpp"
#include "../../toolboxes/fem/CFaceOfElement.hpp"
#include "../../parallelization/mpi_structure.hpp"
#include "../../CConfig.hpp"
 
/*!
 * \class CMeshReaderBase
 * \brief Base class for the mesh zone readers.
 * \author T. Economon
 */
class CMeshReaderBase {
 protected:
  const int rank; /*!< \brief MPI Rank. */
  const int size; /*!< \brief MPI Size. */
 
  const CConfig* config = nullptr; /*!< \brief Local pointer to the config parameter object. */
 
  unsigned short dimension = 0; /*!< \brief Dimension of the problem (2 or 3). */
 
  unsigned long numberOfLocalPoints =
      0; /*!< \brief Number of local grid points within the linear partition on this rank. */
  unsigned long numberOfGlobalPoints = 0; /*!< \brief Number of global grid points within the mesh file. */
  vector<vector<passivedouble> >
      localPointCoordinates; /*!< \brief Vector holding the coordinates from the mesh file for the local grid points.
                                First index is dimension, second is point index. */
  vector<unsigned long> globalPointIDs; /*!< \brief Vector holding the global IDs of the local grid points. */
 
  unsigned long numberOfLocalElements =
      0; /*!< \brief Number of local elements within the linear partition on this rank. */
  unsigned long numberOfGlobalElements = 0;             /*!< \brief Number of global elements within the mesh file. */
  vector<unsigned long> localVolumeElementConnectivity; /*!< \brief Vector containing the element connectivity from the
                                                           mesh file for the local elements. */
 
  unsigned long numberOfMarkers = 0; /*!< \brief Total number of markers contained within the mesh file. */
  vector<string> markerNames;        /*!< \brief String names for all markers in the mesh file. */
  vector<unsigned long>
      numberOfLocalSurfaceElements; /*!< \brief Vector containing the number of local surface elements. */
  vector<vector<unsigned long> >
      surfaceElementConnectivity; /*!< \brief Vector containing the surface element connectivity from the mesh file on a
                                     per-marker basis. For FVM, only the master node reads and stores this connectivity.
                                   */
 
  /*!
   * \brief Function, which determines the faces of the local volume elements.
   * \param[out] localFaces - The faces of the locally stored volume elements.
   */
  void DetermineFacesVolumeElements(vector<CFaceOfElement>& localFaces);
 
  /*!
   * \brief Get all the corner points of all the faces of the given element. It must
   * \param[in]  elemInfo       - Array, which contains the info of the given element.
   * \param[out] nFaces         - Number of faces of the element.
   * \param[out] nPointsPerFace - Number of corner points for each of the faces.
   * \param[out] faceConn       - Global IDs of the corner points of the faces.
   */
  void GetCornerPointsAllFaces(const unsigned long* elemInfo, unsigned short& numFaces, unsigned short nPointsPerFace[],
                               unsigned long faceConn[6][4]);
 
  /*!
   * \brief Creates copies of some markers.
   * \param[in] srcDstMarkers - List of marker names [src_1, dst_1, ..., src_n, dst_n].
   */
  void CopyMarkers(const std::vector<std::string>& srcDstMarkers);
 
 public:
  /*!
   * \brief Constructor of the CMeshReaderBase class.
   * \param[in] val_config - config object for the current zone.
   * \param[in] val_iZone  - Current zone index.
   * \param[in] val_nZone  - Total number of zones.
   */
  CMeshReaderBase(const CConfig* val_config, unsigned short val_iZone, unsigned short val_nZone);
 
  virtual ~CMeshReaderBase() = default;
 
  /*!
   * \brief Get the physical dimension of the problem (2 or 3).
   * \returns Physical dimension of the problem.
   */
  inline unsigned short GetDimension() const { return dimension; }
 
  /*!
   * \brief Get the global IDs of the local points.
   * \returns Reference to the vector containing the global points IDs.
   */
  inline const vector<unsigned long>& GetGlobalPointIDs() const { return globalPointIDs; }
 
  /*!
   * \brief Get the local point coordinates (linearly partitioned).
   * \returns Local point coordinates (linear partitioned).
   */
  inline const vector<vector<passivedouble> >& GetLocalPointCoordinates() const { return localPointCoordinates; }
 
  /*!
   * \brief Get the surface element connectivity for the specified marker. Only the master node owns the surface
   * connectivity. \param[in] val_iMarker - current marker index. \returns Surface element connecitivity for a marker
   * from the master rank.
   */
  inline const vector<unsigned long>& GetSurfaceElementConnectivityForMarker(int val_iMarker) const {
    return surfaceElementConnectivity[val_iMarker];
  }
 
  /*!
   * \brief Get the number surface elements for all markers.
   * \returns Reference to the vector containing the number of surface elements for all markers.
   */
  inline const vector<unsigned long>& GetNumberOfSurfaceElementsAllMarkers() const {
    return numberOfLocalSurfaceElements;
  }
 
  /*!
   * \brief Get the number surface elements for the specified marker.
   * \param[in] val_iMarker - current marker index.
   * \returns Number of surface elements for a marker.
   */
  inline unsigned long GetNumberOfSurfaceElementsForMarker(int val_iMarker) const {
    return (unsigned long)surfaceElementConnectivity[val_iMarker].size() / SU2_CONN_SIZE;
  }
 
  /*!
   * \brief Get the local volume element connectivity (linearly partitioned).
   * \returns Local volume element connectivity (linearly partitioned).
   */
  inline const vector<unsigned long>& GetLocalVolumeElementConnectivity() const {
    return localVolumeElementConnectivity;
  }
 
  /*!
   * \brief Get the total number of markers in the mesh zone.
   * \returns Total number of markers in the mesh zone.
   */
  inline unsigned long GetNumberOfMarkers() const { return numberOfMarkers; }
 
  /*!
   * \brief Get the vector of string names for all markers in the mesh zone.
   * \returns Vector of string names for all markers in the mesh zone.
   */
  inline const vector<string>& GetMarkerNames() const { return markerNames; }
 
  /*!
   * \brief Get the number of local grid points within the linear partition on this rank.
   * \returns Number of local grid points within the linear partition on this rank.
   */
  inline unsigned long GetNumberOfLocalPoints() const { return numberOfLocalPoints; }
 
  /*!
   * \brief Get the number of global grid points within the mesh file.
   * \returns Number of global grid points within the mesh file.
   */
  inline unsigned long GetNumberOfGlobalPoints() const { return numberOfGlobalPoints; }
 
  /*!
   * \brief Get the number of local elements within the linear partition on this rank.
   * \returns Number of local elements within the linear partition on this rank.
   */
  inline unsigned long GetNumberOfLocalElements() const { return numberOfLocalElements; }
 
  /*!
   * \brief Get the number of global elements within the mesh file.
   * \returns Number of global elements within the mesh file.
   */
  inline unsigned long GetNumberOfGlobalElements() const { return numberOfGlobalElements; }
};