Run.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 RUN_H
#define RUN_H
 
class Run;
 
#include <fstream>
#include <ctime>
#include <sstream>
#include "Tools.h"
#include "Order1/Cell.h"
#include "Models/HeaderPhase.h"
#include "Order1/CellInterface.h"
#include "Parallel/Parallel.h"
#include "Meshes/HeaderMesh.h"
#include "BoundConds/HeaderBoundCond.h"
#include "Eos/HeaderEquationOfState.h"
#include "Models/HeaderModel.h"
#include "Gradients/HeaderGradient.h"
#include "Geometries/HeaderGeometricalDomain.h"
#include "Order2/HeaderLimiter.h"
#include "AdditionalPhysics/HeaderQuantitiesAddPhys.h"
#include "AdditionalPhysics/HeaderAddPhys.h"
 
#include "InputOutput/Input.h"
#include "InputOutput/Output.h"
#include "timeStats.h"
 
#include "Relaxations/HeaderRelaxations.h"

class Run
{
  public:
    Run(std::string nameCasTest, const int& number);
    ~Run();

    void initialize();
    void solver();
    void finalize();
 
    void resumeSimulation();
    void restartSimulationMeshMapping(std::vector<GeometricalDomain*>& domains, Mesh* mesh);
 
    //Accessors
    const int& getNumberPhases() const { return m_numberPhases; };
 
  private:
    //Specific solvers
    void integrationProcedure(double& dt, int lvl, double& dtMax, int& nbCellsTotalAMR);
    void advancingProcedure(double& dt, int& lvl, double& dtMax);
    void solveHyperbolic(double& dt, int& lvl, double& dtMax);
    void solveHyperbolicO2(double& dt, int& lvl, double& dtMax);
    void solveAdditionalPhysics(double& dt, int& lvl);
    void solveSourceTerms(double& dt, int& lvl);
    void solveRelaxations(double& dt, int& lvl);
    void verifyErrors();
    void saveInfosLES(std::vector<Cell*>* cellsLvl);
 
    // clang-format off
    int m_numTest;                             
 
    //Input attributes
    std::string m_simulationName;              
    bool m_timeControlIterations;              
    int m_nbIte, m_freq;                       
    double m_finalPhysicalTime, m_timeFreq;    
    double m_cfl;                              
    int m_numberPhases;                        
    int m_numberSolids;                        
    int m_numberEos;                           
    int m_numberTransports;                    
    int m_numberAddPhys;                       
    int m_numberSources;                       
    int m_dimension;                           
    int m_MRF;                                 
    bool m_viscous;                            
    bool m_StrangSplitting;                    
    bool m_extractRefLength;                   
    std::vector<GeometricalDomain*> m_solidDomains; 
 
    //Specific to AMR method
    int m_lvlMax;                              
    int m_nbCellsTotalAMR;                     
    //Geometrical attributes
    bool m_parallelPreTreatment;               
    bool m_smoothCrossSection1d;               
 
    //Calcul attributes
    Mesh* m_mesh;                              
    Model* m_model;                            
    Gradient* m_gradient;                      
    TypeMeshContainer<Cell*>* m_cellsLvl;      
    TypeMeshContainer<Cell*>* m_cellsLvlGhost; 
    TypeMeshContainer<CellInterface*>* m_cellInterfacesLvl; 
    Eos** m_eos;                               
    std::vector<AddPhys*> m_addPhys;           
    Symmetry* m_symmetry;                      
    std::vector<Source*> m_sources;            
    Limiter* m_globalLimiter;                  
    Limiter* m_interfaceLimiter;               
    Limiter* m_globalVolumeFractionLimiter;    
    Limiter* m_interfaceVolumeFractionLimiter; 
    std::vector<std::string> m_nameGTR;        
    std::vector<std::string> m_nameQPA;        
    std::vector<std::string> m_nameGPH;        
    double m_dt;                               
    double m_dtNext;                           
    double m_physicalTime;                     
    int m_iteration;                           
    int m_resumeSimulation;                    
    int m_resumeAMRsaveFreq;                   
 
    //Input/Output attributes
    Input* m_input;                            
    Output* m_outPut;                          
    std::vector<Output*> m_cuts;               
    std::vector<Output*> m_probes;             
    std::vector<Output*> m_globalQuantities;   
    std::vector<Output*> m_recordBoundaries;   
    timeStats m_stat;                          
    double* m_pMax;                            
    double* m_pMaxWall;                        
    double m_volumePhaseK;                     
    double m_massWanted, m_alphaWanted;        
    bool m_recordPsat;                         
 
    //Mesh mapping restart
    bool m_restartMeshMapping;                 
    Output* m_outputMeshMapping;               
    std::string m_meshFileMapped;              
 
    //LES statistics (used by Output::saveInfos)
    double m_globalVolume;                     
    double m_globalUiui;                       
    double m_globalEnstrophy;                  
    double m_globalTT;                         
    double m_globalT;                          
    double m_globalThetaTheta;                 
    double m_meanTemp;                         
 
    //Print message in case of warning
    bool m_warn;                               
 
    // clang-format on
 
    friend class Input;
    friend class Output;
    friend class OutputVTK;
#ifdef ENABLE_HDF5
    friend class OutputVTKHDF;
#endif
    friend class OutputGNU;
    friend class OutputProbeGNU;
    friend class OutputCutGNU;
    friend class OutputGlobalGNU;
    friend class OutputBoundaryGNU;
    friend class OutputBoundaryFluxGNU;
    friend class OutputBoundaryAllGNU;
    friend class Mesh;
};
 
#endif // RUN_H