VtuInterface.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
#include <vtkSmartPointer.h>
#include <vtkUnstructuredGrid.h>
#include <vtkXMLWriter.h>
 
#include <filesystem>
#include <set>
#include <string>
 
namespace MeshLib
{
class Mesh;
 
namespace IO
{
 
#ifdef USE_PETSC
std::string getVtuFileNameForPetscOutputWithoutExtension(
    std::string const& file_name);
#endif

class VtuInterface final
{
public:
    explicit VtuInterface(
        const MeshLib::Mesh* mesh,
        std::set<std::string> const& output_variable_names = {},
        int dataMode = vtkXMLWriter::Appended,
        bool compress = false);

    static MeshLib::Mesh* readVTUFile(
        std::string const& file_name,
        bool const compute_element_neighbors = false);
 
    static vtkSmartPointer<vtkUnstructuredGrid>
    readVtuFileToVtkUnstructuredGrid(std::string const& file_name);

    static MeshLib::Mesh* readVTKFile(
        std::string const& file_name,
        bool const compute_element_neighbors = false);

    bool writeToFile(std::filesystem::path const& file_path);

    template <typename UnstructuredGridWriter>
    bool writeVTU(std::string const& file_name, const int num_partitions = 1,
                  const int rank = 1);
 
private:
    const MeshLib::Mesh* _mesh;
    std::set<std::string> _output_variable_names;
    int _data_mode;
    bool _use_compressor;
};
 
}  // end namespace IO
}  // end namespace MeshLib
 
#include "VtuInterface-impl.h"