Mesh.hpp

Go to the documentation of this file.

/*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   This file is part of CEPS.
 
   CEPS is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.
 
   CEPS 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 General Public License for more details.
 
   You should have received a copy of the GNU General Public License
   along with CEPS (see file LICENSE at root of project).
   If not, see <https://www.gnu.org/licenses/>.
 
 
   Copyright 2019-2024 Inria, Universite de Bordeaux
 
   Authors, in alphabetical order:
 
     Pierre-Elliott BECUE, Florian CARO, Yves COUDIERE(*), Andjela DAVIDOVIC, 
     Charlie DOUANLA-LONTSI, Marc FUENTES, Mehdi JUHOOR, Michael LEGUEBE(*), 
     Pauline MIGERDITICHAN, Valentin PANNETIER(*), Nejib ZEMZEMI.
     * : currently active authors
 
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
#pragma once
 
#include "geometry/base/GeomCellJunction.hpp"
#include "geometry/base/GeomCell.hpp"
 
// Forward declaration of geometry template class
class Geometry;
 
class Mesh
{
 
  public:
 
    explicit Mesh(CepsUInt dim);
  
    ~Mesh();
  
    CepsUInt
    getDimension() const;
  
    void
    addCell(GeomCell *cell);
  
    void
    addBoundaryCell(GeomCell *boundaryCell);
  
    void
    addNode(GeomNode *node);
  
    void
    addHaloNode(GeomNode *node);
  
    void
    refreshCells();
  
    void
    setNbCells(CepsUInt n);
  
    void
    setNbBoundaryCells(CepsUInt n);
  
    void
    setNbNodes(CepsUInt n);
  
    GeomNode*
    getNode(CepsNodeGlobalIndex globalIndex) const;
  
    GeomNode*
    getHaloNode(CepsNodeGlobalIndex geomIndex) const;
  
    GeomNode*
    getNodeOrHaloNode(CepsNodeGlobalIndex geomIndex) const;
  
    CepsInt
    getLocalIndexOfCell(CepsCellGlobalIndex geomIndex) const;
  
    CepsInt
    getLocalIndexOfBoundaryCell(CepsCellGlobalIndex geomIndex) const;
  
    GeomCell*
    getCell(CepsCellGlobalIndex geomIndex) const;
  
    GeomCell*
    getBoundaryCell(CepsCellGlobalIndex geomIndex) const;
  
    const CepsVector<GeomCell*>&
    getCells();
  
    const CepsVector<GeomCell*>&
    getBoundaryCells();
  
    const CepsVector<GeomNode*>&
    getOwnedNodes();
  
    const CepsVector<GeomNode*>&
    getHaloNodes();
  
    CepsUInt
    getNbCells() const;
  
    CepsUInt
    getNbBoundaryCells() const;
  
    CepsUInt
    getNbNodes() const;
  
    CepsUInt
    getLocalNbCells() const;
  
    CepsUInt
    getLocalNbBoundaryCells() const;
  
    CepsUInt
    getLocalNbNodes() const;
  
    CepsUInt
    getLocalNbHaloNodes() const;
  
    CepsUInt
    getMaxNodeConnectivity();
  
    CepsReal
    getMaxCellDiameter() const;
  
    void
    setGeometry(Geometry* geom);
  
    Geometry*
    getGeometry() const;
  
    void
    scale(CepsReal scaleFactor);
  
    friend std::ostream&
    operator<<(std::ostream& os, const Mesh& m);
  
 
  protected:
 
    CepsUInt
    computeMaxNodeConnectivity();
  
    CepsHash
    getNodeHash(GeomNode* n);
  
    CepsHash
    getCellHash(GeomCell* c);
  
  
  protected:
  
    // ----------------------------------------**
    // GLOBAL DATA
    // ----------------------------------------**
  
    CepsUInt m_dim;  
  
    Geometry *m_geom;                 
    CepsUInt  m_nbCells;              
    CepsUInt  m_nbBoundaryCells;      
    CepsUInt  m_nbNodes;              
    CepsBool  m_connectivityComputed; 
    CepsReal  m_maxCellDiameter;      
  
    // ----------------------------------------**
    // PARTIAL DATA
    // ----------------------------------------**
  
    // Data structures
    LocalGlobalMapping<GeomCell*> m_cells;      
    LocalGlobalMapping<GeomCell*> m_bCells;     
    LocalGlobalMapping<GeomNode*> m_ownedNodes; 
    LocalGlobalMapping<GeomNode*> m_haloNodes;  
  
    CepsUInt m_maxNodeConnectivity;  
};
 
std::ostream&
operator<<(std::ostream& os, const Mesh& m);