vtkoutput.h

Go to the documentation of this file.

/*
 *
 *    Copyright (c) 2014-2022,2024,2026
 *      SMASH Team
 *
 *    GNU General Public License (GPLv3 or later)
 *
 */
 
#ifndef SRC_INCLUDE_SMASH_VTKOUTPUT_H_
#define SRC_INCLUDE_SMASH_VTKOUTPUT_H_
 
#include <filesystem>
#include <map>
#include <memory>
#include <string>
#include <utility>
 
#include "density.h"
#include "forwarddeclarations.h"
#include "outputinterface.h"
#include "outputparameters.h"
 
namespace smash {
 
/**
 * \ingroup output
 * Output format processible by <a href="http://paraview.org">ParaView
 * </a>, intended for simple visualization.
 */
class VtkOutput : public OutputInterface {
 public:
  /**
   * Create a new VTK output.
   *
   * \param path Path to the output file.
   * \param name Name of the output.
   * \param out_par Additional information on the configured output.
   */
  VtkOutput(const std::filesystem::path &path, const std::string &name,
            const OutputParameters &out_par);
  ~VtkOutput();
 
  /**
   * Writes the initial particle information list of an event to the VTK
   * output.
   *
   * \param particles Current list of all particles.
   * \param event_label Numbers of the current event and ensemble.
   * \param event Event info, see \ref event_info
   */
  void at_eventstart(const Particles &particles, const EventLabel &event_label,
                     const EventInfo &event) override;
 
  /**
   * Writes the final particle information list of an event to the VTK
   * output. This currently does not do anything, because it is not
   * required for the VTK output.
   *
   * \param particles Unused, needed since inherited.
   * \param event_label Unused, needed since inherited.
   * \param[in] event Event info, see \ref event_info
   */
  void at_eventend(const Particles &particles, const EventLabel &event_label,
                   const EventInfo &event) override;
 
  /**
   * Writes out all current particles.
   *
   * \param particles Current list of particles.
   * \param clock Unused, needed since inherited.
   * \param dens_param Unused, needed since inherited.
   * \param event_label Numbers of the current event and ensemble.
   * \param event Event info, see \ref event_info
   */
  void at_intermediate_time(const Particles &particles,
                            const std::unique_ptr<Clock> &clock,
                            const DensityParameters &dens_param,
                            const EventLabel &event_label,
                            const EventInfo &event) override;
 
  /**
   * Prints the density lattice in VTK format on a grid.
   *
   * \param tq The quantity whose density should be written,
   *           see ThermodynamicQuantity.
   * \param dt The type of the density, see DensityType.
   * \param lattice The lattice from which the quantity is taken.
   */
  void thermodynamics_output(
      const ThermodynamicQuantity tq, const DensityType dt,
      RectangularLattice<DensityOnLattice> &lattice) override;
 
  /**
   * Prints the energy-momentum-tensor lattice in VTK format on a grid.
   *
   * \param tq The quantity whose density should be written,
               see ThermodynamicQuantity.
   * \param dt The type of the density, see DensityType
   * \param lattice The lattice from which the quantity is taken.
   */
  void thermodynamics_output(
      const ThermodynamicQuantity tq, const DensityType dt,
      RectangularLattice<EnergyMomentumTensor> &lattice) override;
 
  /**
   * Printout of all thermodynamic quantities from the thermalizer class.
   *
   * \param gct Grand-canonical thermalizer from which the quantities are
   *            taken.
   */
  void thermodynamics_output(const GrandCanThermalizer &gct) override;
 
  /// \copydoc OutputInterface::fields_output
  void fields_output(
      const std::string name1, const std::string name2,
      RectangularLattice<std::pair<ThreeVector, ThreeVector>> &lat) override;
 
 private:
  /**
   * Write the given particles to the output.
   *
   * \param particles The particles.
   */
  void write(const Particles &particles);
 
  /**
   * Make a file name given a description and a counter.
   *
   * \param description The description.
   * \param counter The counter enumerating the outputs.
   */
  std::string make_filename(const std::string &description, int counter);
 
  /**
   * Make a variable name given quantity and density type.
   *
   * \param tq The quantity.
   * \param dens_type The density type.
   */
  std::string make_varname(const ThermodynamicQuantity tq,
                           const DensityType dens_type);
 
  /**
   * Write the VTK header.
   *
   * \param file Output file.
   * \param lat Lattice corresponding to output.
   * \param description Description of the output.
   */
  template <typename T>
  void write_vtk_header(std::ofstream &file, RectangularLattice<T> &lat,
                        const std::string &description);
 
  /**
   * Write a VTK scalar.
   *
   * \param file Output file.
   * \param lat Lattice corresponding to output.
   * \param varname Name of the output variable.
   * \param function Function that gets the scalar given a lattice node.
   */
  template <typename T, typename F>
  void write_vtk_scalar(std::ofstream &file, RectangularLattice<T> &lat,
                        const std::string &varname, F &&function);
 
  /**
   * Write a VTK vector.
   *
   * \param file Output file.
   * \param lat Lattice corresponding to output.
   * \param varname Name of the output variable.
   * \param function Function that gets the vector given a lattice node.
   */
  template <typename T, typename F>
  void write_vtk_vector(std::ofstream &file, RectangularLattice<T> &lat,
                        const std::string &varname, F &&function);
 
  /**
   * Create the key to access the \c vtk_output_counter_ map.
   *
   * \return std::pair<int, int> The key to access the map.
   */
  std::pair<int, int> counter_key() {
    return {current_event_, current_ensemble_};
  }
 
  /// filesystem path for output
  const std::filesystem::path base_path_;
 
  /// Event number
  int current_event_ = 0;
  /// Ensemble number
  int current_ensemble_ = 0;
  /**
   * Counters to keep track of time steps per event and per ensemble. The first
   * pair index runs over events and the second one over ensembles, but this is
   * encapsulated in the \c counter_key method which is used to change this map.
   */
  std::map<std::pair<int, int>, int> vtk_output_counter_{};
 
  /// Number of density lattice vtk output in current event
  int vtk_density_output_counter_ = 0;
  /// Number of energy-momentum tensor lattice vtk output in current event
  int vtk_tmn_output_counter_ = 0;
  /// Number of Landau frame energy-momentum tensor vtk output in current event
  int vtk_tmn_landau_output_counter_ = 0;
  /// Number of Landau rest frame velocity vtk output in current event
  int vtk_v_landau_output_counter_ = 0;
  /// Number of fluidization output
  int vtk_fluidization_counter_ = 0;
  /// Number of fields output in current event
  int vtk_fields_output_counter_ = 0;
  /// Is the VTK output a thermodynamics output
  bool is_thermodynamics_output_;
  /// Is the VTK output an output for fields
  bool is_fields_output_;
};
 
}  // namespace smash
 
#endif  // SRC_INCLUDE_SMASH_VTKOUTPUT_H_