pvtuwriter.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_PVTUWRITER_HH
#define DUNE_GRID_IO_FILE_VTK_PVTUWRITER_HH

#include <ostream>
#include <string>

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

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

namespace Dune {


  namespace VTK {


    class PVTUWriter {
      std::ostream& stream;

      std::string fileType;

      Indent indent;

    public:

      inline PVTUWriter(std::ostream& stream_, FileType fileType_)
        : stream(stream_)
      {
        switch(fileType_) {
        case polyData :
          fileType = "PPolyData";
          break;
        case unstructuredGrid :
          fileType = "PUnstructuredGrid";
          break;
        default :
          DUNE_THROW(IOError, "PVTUWriter: 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 ~PVTUWriter() {
        --indent;
        stream << indent << "</VTKFile>\n"
               << std::flush;
      }


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


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


      inline void beginPoints() {
        stream << indent << "<PPoints>\n";
        ++indent;
      }
      inline void endPoints() {
        --indent;
        stream << indent << "</PPoints>\n";
      }


      inline void beginMain(unsigned ghostLevel = 0) {
        stream << indent << "<" << fileType
               << " GhostLevel=\"" << ghostLevel << "\">\n";
        ++indent;
      }
      inline void endMain() {
        --indent;
        stream << indent << "</" << fileType << ">\n";
      }


      void addArray(const std::string& name, unsigned ncomps, Precision prec) {
        stream << indent << "<PDataArray"
               << " type=\"" << toString(prec) << "\""
               << " Name=\"" << name << "\""
               << " NumberOfComponents=\"" << ncomps << "\"/>\n";
      }

      inline void addPiece(const std::string& filename) {
        stream << indent << "<Piece "
               << " Source=\"" << filename << "\"/>\n";
      }
    };

  } // namespace VTK


} // namespace Dune

#endif // DUNE_GRID_IO_FILE_VTK_PVTUWRITER_HH