vtuwriter.hh

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright © DUNE Project contributors, see file LICENSE.md in module root
// SPDX-License-Identifier: LicenseRef-GPL-2.0-only-with-DUNE-exception
// -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:

#ifndef DUNE_GRID_IO_FILE_VTK_VTUWRITER_HH
#define DUNE_GRID_IO_FILE_VTK_VTUWRITER_HH

#include <ostream>
#include <string>

#include <dune/common/exceptions.hh>
#include <dune/common/indent.hh>

#include <dune/grid/io/file/vtk/common.hh>
#include <dune/grid/io/file/vtk/dataarraywriter.hh>

namespace Dune {


  namespace VTK {


    class VTUWriter {
    public:
      std::ostream& stream;
      enum Phase { main, appended } phase;

    private:
      DataArrayWriterFactory factory;
      Indent indent;

      std::string fileType;
      std::string cellName;

      bool doAppended;

    public:

      inline VTUWriter(std::ostream& stream_, OutputType outputType,
                       FileType fileType_)
        : stream(stream_), factory(outputType, stream)
      {
        switch(fileType_) {
        case polyData :
          fileType = "PolyData";
          cellName = "Lines";
          break;
        case unstructuredGrid :
          fileType = "UnstructuredGrid";
          cellName = "Cells";
          break;
        default :
          DUNE_THROW(IOError, "VTUWriter: Unknown fileType: " << fileType_);
        }
        const std::string& byteOrder = getEndiannessString();

        stream << indent << "<?xml version=\"1.0\"?>\n";
        stream << indent << "<VTKFile"
               << " type=\"" << fileType << "\""
               << " version=\"0.1\""
               << " byte_order=\"" << byteOrder << "\">\n";
        ++indent;
      }

      inline ~VTUWriter() {
        --indent;
        stream << indent << "</VTKFile>\n"
               << std::flush;
      }


      inline void beginPointData(const std::string& scalars = "",
                                 const std::string& vectors = "") {
        switch(phase) {
        case main :
          stream << indent << "<PointData";
          if(scalars != "") stream << " Scalars=\"" << scalars << "\"";
          if(vectors != "") stream << " Vectors=\"" << vectors << "\"";
          stream << ">\n";
          ++indent;
          break;
        case appended :
          break;
        }
      }
      inline void endPointData() {
        switch(phase) {
        case main :
          --indent;
          stream << indent << "</PointData>\n";
          break;
        case appended :
          break;
        }
      }


      inline void beginCellData(const std::string& scalars = "",
                                const std::string& vectors = "") {
        switch(phase) {
        case main :
          stream << indent << "<CellData";
          if(scalars != "") stream << " Scalars=\"" << scalars << "\"";
          if(vectors != "") stream << " Vectors=\"" << vectors << "\"";
          stream << ">\n";
          ++indent;
          break;
        case appended :
          break;
        }
      }
      inline void endCellData() {
        switch(phase) {
        case main :
          --indent;
          stream << indent << "</CellData>\n";
          break;
        case appended :
          break;
        }
      }


      inline void beginPoints() {
        switch(phase) {
        case main :
          stream << indent << "<Points>\n";
          ++indent;
          break;
        case appended :
          break;
        }
      }
      inline void endPoints() {
        switch(phase) {
        case main :
          --indent;
          stream << indent << "</Points>\n";
          break;
        case appended :
          break;
        }
      }


      inline void beginCells() {
        switch(phase) {
        case main :
          stream << indent << "<" << cellName << ">\n";
          ++indent;
          break;
        case appended :
          break;
        }
      }
      inline void endCells() {
        switch(phase) {
        case main :
          --indent;
          stream << indent << "</" << cellName << ">\n";
          break;
        case appended :
          break;
        }
      }


      inline void beginMain(unsigned ncells, unsigned npoints) {
        stream << indent << "<" << fileType << ">\n";
        ++indent;
        stream << indent << "<Piece"
               << " NumberOf" << cellName << "=\"" << ncells << "\""
               << " NumberOfPoints=\"" << npoints << "\">\n";
        ++indent;
        phase = main;
      }
      inline void endMain() {
        --indent;
        stream << indent << "</Piece>\n";
        --indent;
        stream << indent << "</" << fileType << ">\n";
      }


      inline bool beginAppended() {
        doAppended = factory.beginAppended();
        if(doAppended) {
          const std::string& encoding = factory.appendedEncoding();
          stream << indent << "<AppendedData"
                 << " encoding=\"" << encoding << "\">\n";
          ++indent;
          // mark begin of data
          stream << indent << "_";
        }
        phase = appended;
        return doAppended;
      }
      inline void endAppended() {
        if(doAppended) {
          stream << "\n";
          --indent;
          stream << indent << "</AppendedData>\n";
        }
      }


      DataArrayWriter* makeArrayWriter(const std::string& name,
                                       unsigned ncomps, unsigned nitems,
                                       Precision prec) {
        return factory.make(name, ncomps, nitems, indent, prec);
      }
    };

  } // namespace VTK


} // namespace Dune

#endif // DUNE_GRID_IO_FILE_VTK_VTUWRITER_HH