PatchWriter.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/la/Vector.h"
 
namespace tarch {
  namespace plotter {
    namespace griddata {
      namespace blockstructured {
        class PatchWriter;
      } // namespace blockstructured
    }   // namespace griddata
  }     // namespace plotter
} // namespace tarch
 
 
class tarch::plotter::griddata::blockstructured::PatchWriter {
public:
  virtual ~PatchWriter() = default;
 
  virtual bool writeToFile() = 0;
 
  virtual bool isOpen() = 0;
 
  virtual void clear() = 0;
 
  class CellDataWriter {
  public:
    virtual ~CellDataWriter() = default;
 
    virtual void plotCell(int index, double value)   = 0;
    virtual void plotCell(int index, double* values) = 0;
 
    virtual void close() = 0;
 
    virtual void assignRemainingCellsDefaultValues() = 0;
 
    virtual int getFirstCellWithinPatch(int patchIndex) const = 0;
  };
 
  class VertexDataWriter {
  public:
    virtual ~VertexDataWriter() = default;
 
    virtual void plotVertex(int index, double value)   = 0;
    virtual void plotVertex(int index, double* values) = 0;
 
    virtual void close() = 0;
 
    virtual void assignRemainingVerticesDefaultValues() = 0;
 
    virtual int getFirstVertexWithinPatch(int patchIndex) const = 0;
  };
 
  virtual int plotPatch(const tarch::la::Vector<2, double>& offset, const tarch::la::Vector<2, double>& size) = 0;
 
  virtual int plotPatch(const tarch::la::Vector<3, double>& offset, const tarch::la::Vector<3, double>& size) = 0;
 
  virtual CellDataWriter* createCellDataWriter(
    const std::string& identifier, int unknownsPerAxis, int recordsPerCell, const std::string& description
  ) = 0;
 
  virtual CellDataWriter* createCellDataWriter(
    const std::string& identifier,
    int                unknownsPerAxis,
    int                recordsPerCell,
    const std::string& description,
    const std::string& metaData
  ) = 0;
 
  virtual CellDataWriter* createCellDataWriter(
    const std::string& identifier,
    int                unknownsPerAxis,
    int                recordsPerCell,
    const std::string& description,
    const std::string& metaData,
    double*            mapping
  ) = 0;
 
  virtual VertexDataWriter* createVertexDataWriter(
    const std::string& identifier, int unknownsPerAxis, int recordsPerVertex, const std::string& description
  ) = 0;
 
  virtual VertexDataWriter* createVertexDataWriter(
    const std::string& identifier,
    int                unknownsPerAxis,
    int                recordsPerVertex,
    const std::string& description,
    const std::string& metaData
  ) = 0;
 
  virtual VertexDataWriter* createVertexDataWriter(
    const std::string& identifier,
    int                unknownsPerAxis,
    int                recordsPerVertex,
    const std::string& description,
    const std::string& metaData,
    double*            mapping
  ) = 0;
};