OutputFormat.cpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#include "OutputFormat.h"
 
#include <cassert>
#include <exception>
#include <fstream>
#include <vector>
 
#include "BaseLib/DisableFPE.h"
#include "BaseLib/FileTools.h"
#include "MeshLib/IO/VtkIO/PVDFile.h"
#include "MeshLib/IO/VtkIO/VtuInterface.h"
#include "MeshLib/IO/XDMF/XdmfHdfWriter.h"
#include "ProcessLib/Process.h"
 
namespace ProcessLib
{
MeshLib::IO::PVDFile& OutputVTKFormat::findOrCreatePVDFile(
    std::string const& mesh_name) const
{
    auto const it = mesh_name_to_pvd_file.find(mesh_name);
    if (it == mesh_name_to_pvd_file.end())
    {
        auto const filename = constructPVDName(mesh_name);
        auto p = mesh_name_to_pvd_file.emplace(std::piecewise_construct,
                                               std::forward_as_tuple(mesh_name),
                                               std::forward_as_tuple(filename));
        return p.first->second;
    }
 
    return it->second;
}
 
void outputMeshVtk(std::string const& file_name, MeshLib::Mesh const& mesh,
                   std::set<std::string> const& output_variables,
                   bool const compress_output, int const data_mode)
{
    DBUG("Writing output to '{:s}'.", file_name);
 
    MeshLib::IO::VtuInterface vtu_interface(&mesh, output_variables, data_mode,
                                            compress_output);
    vtu_interface.writeToFile(file_name);
}
 
void outputMeshVtk(OutputVTKFormat const& output_file,
                   MeshLib::IO::PVDFile& pvd_file, MeshLib::Mesh const& mesh,
                   std::set<std::string> const& output_variables,
                   double const t, int const timestep, int const iteration,
                   bool const converged)
{
    auto const name = output_file.constructFilename(mesh.getName(), timestep, t,
                                                    iteration, converged);
    pvd_file.addVTUFile(name, t);
 
    auto const path = BaseLib::joinPaths(output_file.directory, name);
    // Output of NaN's triggers floating point exceptions. Because we are not
    // debugging VTK (or other libraries) at this point, the possibly set
    // exceptions are temporarily disabled and are restored at the end of the
    // function.
    [[maybe_unused]] DisableFPE disable_fpe;
    outputMeshVtk(path, mesh, output_variables, output_file.compression,
                  output_file.data_mode);
}
 
std::string OutputVTKFormat::constructPVDName(
    std::string const& mesh_name) const
{
    return BaseLib::joinPaths(
        directory,
        BaseLib::constructFormattedFileName(prefix, mesh_name, 0, 0, 0, true) +
            ".pvd");
}
 
OutputFormat::OutputFormat(std::string const& directory, std::string prefix,
                           std::string suffix, bool const compression)
    : directory(directory),
      prefix(std::move(prefix)),
      suffix(std::move(suffix)),
      compression(compression)
{
}
 
std::string OutputVTKFormat::constructFilename(std::string const& mesh_name,
                                               int const timestep,
                                               double const t,
                                               int const iteration,
                                               bool const converged) const
{
    return BaseLib::constructFormattedFileName(prefix, mesh_name, timestep, t,
                                               iteration, converged) +
           BaseLib::constructFormattedFileName(suffix, mesh_name, timestep, t,
                                               iteration, converged) +
           ".vtu";
}
 
std::string OutputXDMFHDF5Format::constructFilename(
    std::string const& mesh_name, int const timestep, double const t,
    int const iteration, bool const converged) const
{
    return BaseLib::constructFormattedFileName(prefix, mesh_name, timestep, t,
                                               iteration, converged) +
           ".xdmf";
}
 
void OutputXDMFHDF5Format::outputMeshXdmf(
    std::set<std::string> const& output_variables,
    std::vector<std::reference_wrapper<const MeshLib::Mesh>> const& meshes,
    int const timestep, double const t, int const iteration,
    bool const converged) const
{
    // \TODO The XdmfOutput will create on construction the XdmfHdfWriter
    if (!mesh_xdmf_hdf_writer)
    {
        auto name = constructFilename(meshes[0].get().getName(), timestep, t,
                                      iteration, converged);
        std::filesystem::path path(BaseLib::joinPaths(directory, name));
        mesh_xdmf_hdf_writer = std::make_unique<MeshLib::IO::XdmfHdfWriter>(
            meshes, path, timestep, t, output_variables, compression, n_files,
            chunk_size_bytes);
    }
    else
    {
        mesh_xdmf_hdf_writer->writeStep(t);
    };
}
 
void OutputVTKFormat::outputMeshes(
    const int timestep, const double t, const int iteration,
    bool const converged,
    std::vector<std::reference_wrapper<const MeshLib::Mesh>> const& meshes,
    std::set<std::string> const& output_variables) const
{
    for (auto const& mesh : meshes)
    {
        auto& pvd_file = findOrCreatePVDFile(mesh.get().getName());
        outputMeshVtk(*this, pvd_file, mesh, output_variables, t, timestep,
                      iteration, converged);
    }
}
}  // namespace ProcessLib