Mesh.h

Go to the documentation of this file.

//  
//       ,---.     ,--,    .---.     ,--,    ,---.    .-. .-. 
//       | .-'   .' .')   / .-. )  .' .'     | .-'    |  \| | 
//       | `-.   |  |(_)  | | |(_) |  |  __  | `-.    |   | | 
//       | .-'   \  \     | | | |  \  \ ( _) | .-'    | |\  | 
//       |  `--.  \  `-.  \ `-' /   \  `-) ) |  `--.  | | |)| 
//       /( __.'   \____\  )---'    )\____/  /( __.'  /(  (_) 
//      (__)              (_)      (__)     (__)     (__)     
//      Official webSite: https://code-mphi.github.io/ECOGEN/
//
//  This file is part of ECOGEN.
//
//  ECOGEN is the legal property of its developers, whose names 
//  are listed in the copyright file included with this source 
//  distribution.
//
//  ECOGEN 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.
//  
//  ECOGEN 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 ECOGEN (file LICENSE).  
//  If not, see <http://www.gnu.org/licenses/>.
 
#ifndef MESH_H
#define MESH_H
 
#include <ctime>
#include <fstream>
#include "../libTierces/tinyxml2.h"
#include "../Order1/Cell.h"
#include "../Order1/CellGhost.h"
#include "../Order1/CellInterface.h"
#include "../Order2/CellO2GhostCartesian.h"
#include "../Order2/CellO2GhostNS.h"
#include "../BoundConds/HeaderBoundCond.h"
#include "../Maths/Coord.h"
#include "../Parallel/Parallel.h"
#include "../AdditionalPhysics/HeaderQuantitiesAddPhys.h"
#include "../Maths/GeometricObject.h"
#include "../Sources/HeaderSources.h"
 
class Mesh
{
public:
  Mesh();
  virtual ~Mesh();
 
  virtual void assignLimits(std::vector<BoundCond*>& boundCond) = 0;
  virtual int initializeGeometrie(TypeMeshContainer<Cell*>& cells, TypeMeshContainer<Cell*>& cellsGhost, TypeMeshContainer<CellInterface*>& cellInterfaces,
    const int& restartSimulation, bool pretraitementParallele = true, std::string ordreCalcul = "FIRSTORDER") = 0; 
  virtual std::string whoAmI() const { Errors::errorMessage("whoAmI not available for considered mesh"); return 0; };
  virtual void setImmersedBoundaries(TypeMeshContainer<CellInterface*>* /*cellInterfacesLvl*/, std::string /*ordreCalcul*/) const {};
 
  //Accessors
  //---------
  const int& getProblemDimension() const { return m_problemDimension; };
  const int& getNumberCells() const { return m_numberCellsCalcul; };
  const int& getNumberCellsTotal() const { return m_numberCellsTotal; };
  const int& getNumberFaces() const { return m_numberFacesTotal; };
  const int& getNumFichier() const { return m_numFichier; };
  virtual double getdX() const { return 0; };
  virtual double getdY() const { return 0; };
  virtual double getdZ() const { return 0; };
  const TypeM& getType() const { return m_type; };
  virtual int getNumberCellsY() { return 0; };
  virtual int getNumberCellsZ() { return 0; };
  virtual int getLvlMax() const { return 0; };
 
  //Printing
  //--------
  void writeResultsGnuplot(std::vector<Cell*>* cellsLvl, std::ofstream& fileStream, GeometricObject* objet = 0, bool recordPsat = false) const;
  virtual void writeHeaderPiece(std::ofstream& /*fileStream*/, std::vector<Cell*>* /*cellsLvl*/) const { Errors::errorMessage("writeHeaderPiece not available for considered mesh"); };
  virtual std::string getStringExtent(bool /*global*/ = false) const { Errors::errorMessage("getStringExtent not available for considered mesh"); return 0; };
  virtual void getCoord(std::vector<double>& /*dataset*/, Axis /*axis*/) const { Errors::errorMessage("getCoord not available for considered mesh"); };
  virtual void getNodes(std::vector<double>& /*dataset*/, std::vector<Cell*>* /*cellsLvl*/) const { Errors::errorMessage("getNodes not available for considered mesh"); };
  virtual void getConnectivity(std::vector<double>& /*dataset*/, std::vector<Cell*>* /*cellsLvl*/) const { Errors::errorMessage("getConnectivity not available for considered mesh"); };
  virtual void getOffsets(std::vector<double>& /*dataset*/, std::vector<Cell*>* /*cellsLvl*/) const { Errors::errorMessage("getOffsets not available for considered mesh"); };
  virtual void getTypeCell(std::vector<double>& /*dataset*/, std::vector<Cell*>* /*cellsLvl*/) const { Errors::errorMessage("getTypeCell not available for considered mesh"); };
  virtual void getData(std::vector<Cell*>* /*cellsLvl*/, std::vector<double>& /*dataset*/, const int /*var*/, int /*phase*/) const { Errors::errorMessage("getData not available for considered mesh"); };
  virtual void setDataSet(std::vector<double>& /*dataset*/, std::vector<Cell*>* /*cellsLvl*/, const int /*var*/, int /*phase*/) const { Errors::errorMessage("setDataSet not available for requested mesh"); };
  virtual void refineCellAndCellInterfaces(Cell* /*cell*/, const std::vector<AddPhys*>& /*addPhys*/, int& /*nbCellsTotalAMR*/) { Errors::errorMessage("refineCellAndCellInterfaces not available for requested mesh"); };
  virtual void extractAbsVelocityMRF(std::vector<Cell*>* /*cellsLvl*/, std::vector<double>& /*dataset*/, Source* /*sourceMRF*/) const { Errors::errorMessage("extractAbsVeloxityMRF not available for considered mesh"); };
  virtual void extractReferenceLength(std::vector<Cell*>* /*cellsLvl*/, std::vector<double>& /*dataset*/) const { Errors::errorMessage("extractReferenceLength not available for considered mesh"); };
  virtual void printDomainDecomposition(std::ofstream& /*fileStream*/) {};
  virtual void readDomainDecomposition(std::ifstream& /*fileStream*/) {};
  
  //Specific to AMR method
  //----------------------
  virtual void procedureRaffinementInitialization(std::vector<Cell*>* /*cellsLvl*/, TypeMeshContainer<Cell*>* /*cellsLvlGhost*/,
    std::vector<CellInterface*>* /*cellInterfacesLvl*/, const std::vector<AddPhys*>& /*addPhys*/, int& nbCellsTotalAMR,
    std::vector<GeometricalDomain*>& /*domains*/, Eos** /*eos*/, const int& /*restartSimulation*/, std::string /*ordreCalcul*/, std::vector<GeometricalDomain*>& /*solidDomains*/) { nbCellsTotalAMR = m_numberCellsCalcul; };
  virtual void procedureRaffinement(std::vector<Cell*>* /*cellsLvl*/, TypeMeshContainer<Cell*>* /*cellsLvlGhost*/, std::vector<CellInterface*>* /*cellInterfacesLvl*/, const int& /*lvl*/,
    const std::vector<AddPhys*>& /*addPhys*/, int& /*nbCellsTotalAMR*/, Eos** /*eos*/) {};
 
    //Specific for parallel
  //---------------------
    virtual void initializePersistentCommunications(const TypeMeshContainer<Cell*>& cells, std::string ordreCalcul);
    virtual void finalizeParallele(const int& lvlMax);
  virtual void parallelLoadBalancingAMR(std::vector<Cell*>* /*cellsLvl*/, TypeMeshContainer<Cell*>* /*cellsLvlGhost*/,
    std::vector<CellInterface*>* /*cellInterfacesLvl*/, std::string /*ordreCalcul*/,
    const std::vector<AddPhys*>& /*addPhys*/, Eos** /*eos*/, int& /*nbCellsTotalAMR*/, std::vector<GeometricalDomain*>& /*solidDomains*/, bool /*init*/ = false) {};
 
  //Specific for mesh mapping restart
  //---------------------------------
  virtual std::string getMeshExtension() const { Errors::errorMessage("getMeshExtension not available for requested mesh"); return 0; };
  virtual void initCpuMeshSequential(TypeMeshContainer<Cell*>& /*cells*/, std::string& /*computeOrder*/) { 
    Errors::errorMessage("initCpuMeshSequential not available for requested mesh");
  }
  virtual void initCpuMeshParallel(TypeMeshContainer<Cell*>& /*cells*/, std::string& /*computeOrder*/, int /*cpu*/) { 
    Errors::errorMessage("initCpuMeshParallel not available for requested mesh");
  }
 
protected:
  mutable int m_numFichier;
 
  int m_problemDimension;                  /*indicator 1D/2D/3D*/
  int m_numberElements;                    /*Number d'elements au total (cells de computes internes de dimension n + elements limites de dimension n-1 + ghost cells de dimensions n)*/
  int m_numberFacesTotal;                  /*Number de faces entre deux cells ou entre une cell et une limite*/
  int m_numberCellsCalcul;                 /*Number de cells de compute internes au domain*/
    int m_numberCellsTotal;                  /*Cells de compute internes + cells fantomes dediees aux communications parallele*/
 
  TypeM m_type;
};
#endif // MESH_H