Output.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 OUTPUT_H
#define OUTPUT_H
 
//Macro for system interactions (creation/destruction of folders)
#ifdef WIN32
  #include <direct.h>
#else
  #include <sys/types.h>
  #include <sys/stat.h>
#endif
 
#include <fstream>
#include "../libTierces/tinyxml2.h"
#include "../Errors.h"
#include "../Meshes/HeaderMesh.h"
#include "../Order1/Cell.h"
#include "IO.h"
 
class Output;
 
#include "Input.h"
 
class Output
{
  public:
    Output();

    Output(std::string casTest, std::string nameRun, tinyxml2::XMLElement* element, std::string fileName, Input* entree);

    Output(std::string nameRun, int fileNumberRestartMeshMapping, Input* input);

    Output(tinyxml2::XMLElement* element);
 
    virtual ~Output();
 
    virtual void probeDisplacement(const double& /*dt*/) { throw ErrorECOGEN("probeDisplacement not available for requested output format"); };
 
    virtual void locateProbeInMesh(const TypeMeshContainer<Cell*>& /*cells*/, const int& /*nbCells*/, bool /*localSeeking*/ = false)
    {
      try {
        throw ErrorECOGEN("locateProbeInMesh not available for requested output format");
      }
      catch (ErrorECOGEN&) {
        throw;
      }
    };
    virtual Cell* locateProbeInAMRSubMesh(std::vector<Cell*>* /*cells*/, const int& /*nbCells*/)
    {
      try {
        throw ErrorECOGEN("locateProbeInMesh not available for requested output format");
      }
      catch (ErrorECOGEN&) {
        throw;
      }
      return 0;
    };
 
    void copyInputFiles() const;
    void initializeOutput(const Cell& cell);
    void initializeOutput(std::vector<CellInterface*>* cellInterfacesLvl); 
    void initializeOutputMeshMapping(const Cell& cell);                    
    virtual void initializeOutputInfos();
    virtual void writeResults(Mesh* /*mesh*/, std::vector<Cell*>* /*cellsLvl*/)
    {
      try {
        throw ErrorECOGEN("writeResults not available for requested output format");
      }
      catch (ErrorECOGEN&) {
        throw;
      }
    };
    virtual void writeResults(std::vector<CellInterface*>* /*cellInterfacesLvl*/)
    {
      try {
        throw ErrorECOGEN("writeResults not available for requested output format");
      }
      catch (ErrorECOGEN&) {
        throw;
      }
    };

    virtual void printTree(Mesh* mesh, const std::vector<Cell*>* cellsLvl, int m_resumeAMRsaveFreq) const;
    virtual void writeInfos();
    virtual void writeProgress();
 
    virtual void initializeSpecificOutput()
    {
      try {
        throw ErrorECOGEN("initializeSpecificOutput not available for requested output format");
      }
      catch (ErrorECOGEN&) {
        throw;
      }
    };
    virtual void initializeSpecificOutput(std::vector<CellInterface*>* /*cellInterfacesLvl*/)
    {
      try {
        throw ErrorECOGEN("initializeSpecificOutput not available for requested output format");
      }
      catch (ErrorECOGEN&) {
        throw;
      }
    }; 

    void readInfos();
    int readNbCpu();
    virtual void readResults(Mesh* /*mesh*/, std::vector<Cell*>* /*cellsLvl*/, int /*cpu*/ = -1)
    {
      try {
        throw ErrorECOGEN("readResults not available for requested output format");
      }
      catch (ErrorECOGEN&) {
        throw;
      }
    };
    void readDomainDecompostion(Mesh* mesh);

    virtual void readTree(Mesh* mesh,
                          TypeMeshContainer<Cell*>* cellsLvl,
                          TypeMeshContainer<Cell*>* cellsLvlGhost,
                          TypeMeshContainer<CellInterface*>* cellInterfacesLvl,
                          const std::vector<AddPhys*>& addPhys,
                          int& nbCellsTotalAMR);
 
    virtual void prepareErrorFiles() const;
    virtual void writeErrorInFile(std::vector<Errors>& v, const int& ErrorType, const int& iteration, bool& warn) const;

    void readTree_common(Mesh* mesh,
                         TypeMeshContainer<Cell*>* cellsLvl,
                         TypeMeshContainer<Cell*>* cellsLvlGhost,
                         TypeMeshContainer<CellInterface*>* cellInterfacesLvl,
                         const std::vector<AddPhys*>& addPhys,
                         int& lvl);
 
    //Accessor
    int getNumFile() const { return m_numFile; };
    virtual double getNextTime()
    {
      try {
        throw ErrorECOGEN("getNextTime not available for requested output format");
      }
      catch (ErrorECOGEN&) {
        throw;
      }
      return 0.;
    }
    virtual bool possesses()
    {
      try {
        throw ErrorECOGEN("possesses not available for requested output format");
      }
      catch (ErrorECOGEN&) {
        throw;
      }
      return false;
    };

    virtual const void* getTransferMode() const
    {
      try {
        throw ErrorECOGEN("getTransferMode not available for requested output format");
      }
      catch (ErrorECOGEN&) {
        throw;
      }
      return nullptr;
    }
 
    const std::string& getFolderOutput() { return m_folderOutput; }
    const TypeOutput& getType() const { return m_type; };
    bool getReducedOutput() const { return m_reducedOutput; };
 
    std::string outputPhaseName(int phase, std::string phaseName, std::string& eosName) const
    {
      return "F" + std::to_string(phase) + "_" + phaseName + eosName;
    }
 
  protected:
    //General data
    void printWritingInfo() const;
    void saveInfos() const;
    std::string createFilename(const char* name, int lvl = -1, int proc = -1, int numFichier = -1) const;
 
    void writeDataset(std::vector<double> dataset, std::ofstream& fileStream, TypeData typeData) const;
    void getDataset(std::istringstream& data, std::vector<double>& dataset) const;
 
    Input* m_input;    
    Run* m_run;        
    TypeOutput m_type; 
 
    //Attributes names file/folder
    std::string m_simulationName;             
    std::string m_infoCalcul;                 
    std::string m_treeStructure;              
    std::string m_domainDecomposition;        
    std::string m_fileNameResults;            
    std::string m_filenameCollectionParaview; 
    std::string m_filenameCollectionVisIt;    
    std::string m_filenameVTKHDFTimeseries;   
    std::string m_folderOutput;               
    std::string m_folderSavesInput;           
    std::string m_folderDatasets;             
    std::string m_folderInfoMesh;             
    std::string m_folderCuts;                 
    std::string m_folderProbes;               
    std::string m_folderGlobalQuantities;     
    std::string m_folderBoundaries;           
    std::string m_fileCollectionParaview;     
    std::string m_fileCollectionVisIt;        
    std::string m_folderErrorsAndWarnings;    
 
    //Attributes of print parameters
    bool m_writeBinary;   
    bool m_splitData;     
    int m_precision;      
    bool m_reducedOutput; 
 
    int m_numFile;
    std::string m_endianMode;
    int m_nbCpusRestarted; 
 
    //Useful to print cell data
    Cell m_cellRef; 
};
 
#endif //OUTPUT_H