ExportContext.hpp

Go to the documentation of this file.

#ifndef PRECICE_IO_EXPORTCONTEXT_HPP_
#define PRECICE_IO_EXPORTCONTEXT_HPP_
 
#include <memory>
#include <string>
#include <utility>
#include "io/Export.hpp"
 
namespace precice::io {
 
struct ConfiguredExport {
  // @brief Path to export location.
  std::string location;
 
  // @brief Exporting every N time windows (equals -1 when not set).
  int everyNTimeWindows = -1;
 
  // @brief If true, export is done in every iteration (also implicit).
  bool everyIteration = false;
 
  // @brief If true, updates the series file after every export. Otherwise only at the end
  bool updateSeries = false;
 
  // @brief type of the exporter (e.g. vtk).
  std::string type;
 
  // @brief Configured mesh name to export (empty means export all meshes).
  std::string configuredMeshName;
};
 
struct ExportContext : public ConfiguredExport {
  // @brief Exporters performing the actual export.
  std::unique_ptr<Export> exporter;
 
  // @brief Name of the mesh to export.
  std::string meshName;
};

inline ExportContext makeExportContext(ConfiguredExport config, std::unique_ptr<io::Export> exporter, std::string meshName)
{
  return {std::move(config), std::move(exporter), std::move(meshName)};
}
 
} // namespace precice::io
 
#endif /* PRECICE_IO_EXPORTCONTEXT_HPP_ */