oscaroutput.h

Go to the documentation of this file.

/*
 *
 *    Copyright (c) 2014-2020,2022,2024
 *      SMASH Team
 *
 *    GNU General Public License (GPLv3 or later)
 *
 */
 
#ifndef SRC_INCLUDE_SMASH_OSCAROUTPUT_H_
#define SRC_INCLUDE_SMASH_OSCAROUTPUT_H_
 
#include <memory>
#include <string>
#include <vector>
 
#include "file.h"
#include "forwarddeclarations.h"
#include "outputinterface.h"
#include "outputparameters.h"
#include "smash/outputformatter.h"
 
namespace smash {
 
enum OscarOutputFormat {
  OscarFormat2013,
  OscarFormat2013Extended,
  OscarFormat1999,
  ASCII
};
 
enum OscarOutputContents {
  OscarInteractions = 0x001,
  OscarTimesteps = 0x002,
  OscarAtEventstart = 0x004,
  OscarParticlesAtEventend = 0x008,
  OscarParticlesAtEventendIfNotEmpty = 0x010,
  OscarParticlesIC = 0x020
};
 
template <OscarOutputFormat Format, int Contents>
class OscarOutput : public OutputInterface {
 public:
  OscarOutput(const std::filesystem::path &path, const std::string &name,
              const std::vector<std::string> quantities = {});
 
  void at_eventstart(const Particles &particles, const EventLabel &event_label,
                     const EventInfo &event) override;
 
  void at_eventend(const Particles &particles, const EventLabel &event_label,
                   const EventInfo &event) override;
 
  void at_interaction(const Action &action, const double density) override;
 
  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;
 
 private:
  void write_particledata(const ParticleData &data);
 
  void write(const Particles &particles);
 
  RenamingFilePtr file_;
 
  OutputFormatter<ToASCII> formatter_;
};
 
std::unique_ptr<OutputInterface> create_oscar_output(
    const std::string &format, const std::string &content,
    const std::filesystem::path &path, const OutputParameters &out_par);
 
// @}
 
}  // namespace smash
 
#endif  // SRC_INCLUDE_SMASH_OSCAROUTPUT_H_