PeanoTextPatchFileWriter.h

Go to the documentation of this file.

// This file is part of the Peano project. For conditions of distribution and
// use, please see the copyright notice at www.peano-framework.org
#pragma once
 
#include "tarch/logging/Log.h"
#include "PatchWriter.h"
 
#include <fstream>
#include <vector>
 
#include <iostream>
#include <sstream>
#include <string>
#include <cctype>
#include <filesystem>
 
namespace tarch {
  namespace plotter {
    namespace griddata {
      namespace blockstructured {
        class PeanoTextPatchFileWriter;
 
        int restartPreprocess(const std::string  fileName, double restarTime);
      }
    }
  }
}
 
class tarch::plotter::griddata::blockstructured::PeanoTextPatchFileWriter: public tarch::plotter::griddata::blockstructured::PatchWriter {
  protected:
    static tarch::logging::Log _log;
    static const std::string HEADER;
 
    std::string  _fileName;
    std::string  _indexFile;
 
    bool _writtenToFile;
 
    int  _dimensions;
 
    int _patchCounter;
 
    std::stringstream _snapshotFileOut;
    bool              _haveWrittenAtLeastOnePatch;
 
    void writeMetaData(const std::string& metaData);
    void writeMapping(int totalEntries, double* values);
 
    void createBackupOfMetaFile();
    void createEmptyIndexFile();
    void addNewDatasetToIndexFile(double timestamp);
    void addNewFileToCurrentDataSetInIndexFile( const std::string&  filename );
 
    double getLatestTimeStepInIndexFile() const;
 
  public:
    class CellDataWriter: public tarch::plotter::griddata::blockstructured::PatchWriter::CellDataWriter {
      protected:
        tarch::plotter::griddata::blockstructured::PeanoTextPatchFileWriter& _writer;
 
        const std::string _identifier;
        const int         _numberOfCellsPerAxis;
        const int         _numberOfUnknowns;
        int               _entryCounter;
        std::stringstream _out;
 
        void flushIfPatchIsComplete();
      public:
        CellDataWriter(
          const std::string& identifier,
          int                unknownsPerAxis,
          int                numberOfUnknowns, const std::string& description,
          const std::string& metaData,
          double*            mapping,
          tarch::plotter::griddata::blockstructured::PeanoTextPatchFileWriter& writer
        );
        virtual ~CellDataWriter();
        
        void setPrecision(int precision);
 
        int getCellsPerPatch() const;
 
        virtual void plotCell( int index, double value ) override;
        virtual void plotCell( int index, double* values ) override;
 
        virtual void close() override;
 
        virtual void assignRemainingCellsDefaultValues() override;
 
        virtual int getFirstCellWithinPatch(int index) const override;
     };
 
    class VertexDataWriter: public tarch::plotter::griddata::blockstructured::PatchWriter::VertexDataWriter {
       protected:
         tarch::plotter::griddata::blockstructured::PeanoTextPatchFileWriter& _writer;
 
         const std::string _identifier;
         const int         _numberOfVerticesPerAxis;
         const int         _numberOfUnknowns;
 
         int               _entryCounter;
         std::stringstream _out;
 
         void flushIfPatchIsComplete();
 
       public:
         VertexDataWriter(
           const std::string& identifier,
           int                unknownsPerAxis,
           int                numberOfUnknowns, const std::string& description,
           const std::string& metaData,
           double*            mapping,
           tarch::plotter::griddata::blockstructured::PeanoTextPatchFileWriter& writer
         );
 
         ~VertexDataWriter();
 
         void setPrecision(int precision);
 
         int getVerticesPerPatch() const;
 
         virtual void plotVertex( int index, double value ) override;
         virtual void plotVertex( int index, double* values ) override;
 
          /*
          * Somewhat hacky, added to overload the plotVertex function in order to allow plotting of patches with
          * different variable types. Should likely have been handled more cleanly but since template functions cannot
          * be virtual this needed to be handled on the lowest level.
          */
         template <typename T>
         void plotVertex( int index, T* values );
 
         virtual void close() override;
 
         virtual void assignRemainingVerticesDefaultValues() override;
 
         virtual int getFirstVertexWithinPatch(int index) const override;
    };
 
    enum class IndexFileMode {
      CreateNew,
      AppendNewData,
      NoIndexFile
    };
 
    PeanoTextPatchFileWriter(int dimension, const std::string&  fileName, const std::string&  indexFileName, IndexFileMode appendToIndexFile, double timeStamp, int precision = 6);
 
    virtual ~PeanoTextPatchFileWriter();
 
    virtual CellDataWriter*    createCellDataWriter( const std::string& identifier, int unknownsPerAxis, int recordsPerCell, const std::string& description ) override;
    virtual CellDataWriter*    createCellDataWriter( const std::string& identifier, int unknownsPerAxis, int recordsPerCell, const std::string& description, const std::string& metaData ) override;
    virtual CellDataWriter*    createCellDataWriter( const std::string& identifier, int unknownsPerAxis, int recordsPerCell, const std::string& description, const std::string& metaData, double* mapping ) override;
 
    virtual VertexDataWriter*  createVertexDataWriter( const std::string& identifier, int unknownsPerAxis, int recordsPerVertex, const std::string& description ) override;
    virtual VertexDataWriter*  createVertexDataWriter( const std::string& identifier, int unknownsPerAxis, int recordsPerVertex, const std::string& description, const std::string& metaData  ) override;
    virtual VertexDataWriter*  createVertexDataWriter( const std::string& identifier, int unknownsPerAxis, int recordsPerVertex, const std::string& description, const std::string& metaData, double* mapping ) override;
 
 
    virtual int plotPatch(
      const tarch::la::Vector<2,double>& offset,
      const tarch::la::Vector<2,double>& size
    ) override;
 
    virtual int plotPatch(
      const tarch::la::Vector<3,double>& offset,
      const tarch::la::Vector<3,double>& size
    ) override;
 
    virtual bool writeToFile() override;
 
    virtual bool isOpen() override;
 
    virtual void clear() override;
};
 
#include "PeanoTextPatchFileWriter_VertexDataWriter.cpph"