listmodus.h

Go to the documentation of this file.

/*
 *    Copyright (c) 2015-2025
 *      SMASH Team
 *
 *    GNU General Public License (GPLv3 or later)
 */
#ifndef SRC_INCLUDE_SMASH_LISTMODUS_H_
#define SRC_INCLUDE_SMASH_LISTMODUS_H_
 
#include <cmath>
#include <cstdint>
#include <list>
#include <string>
#include <utility>
#include <vector>
 
#include "forwarddeclarations.h"
#include "modusdefault.h"
 
namespace smash {
 
class ListModus : public ModusDefault {
 public:
  explicit ListModus(Configuration modus_config,
                     const ExperimentParameters &parameters);
 
  ListModus() = default;
 
  double initial_conditions(Particles *particles,
                            const ExperimentParameters &parameters);
 
  void try_create_particle(
      Particles &particles, PdgCode pdgcode, double t, double x, double y,
      double z, double mass, double E, double px, double py, double pz,
      const std::vector<std::string> &optional_quantities = {});
 
  struct LoadFailure : public std::runtime_error {
    using std::runtime_error::runtime_error;
  };
 
  struct InvalidEvents : public std::invalid_argument {
    using std::invalid_argument::invalid_argument;
  };
 
  bool is_list() const { return true; }
 
 protected:
  double start_time_ = 0.;
 
 private:
  void read_particles_from_next_event_(Particles &particles);
 
  bool file_has_events_(std::filesystem::path filepath,
                        std::streampos last_position);
 
  std::filesystem::path file_path_(std::optional<int> file_id);
 
  std::string next_event_();
 
  void validate_list_of_particles_of_all_events_() const;
 
  void validate_optional_fields_() const;
 
  void backpropagate_to_same_time_if_needed_(Particles &particles);
 
  void insert_optional_quantities_to_(
      ParticleData &p,
      const std::vector<std::string> &optional_quantities) const;
 
  std::string particle_list_file_directory_;
 
  std::string particle_list_filename_or_prefix_;
 
  std::optional<int> file_id_;
 
  std::vector<std::string> optional_fields_{};
  int event_id_;
 
  std::streampos last_read_position_ = 0;
 
  bool warn_about_mass_discrepancy_ = true;
  bool warn_about_off_shell_particles_ = true;
 
  SpinInteractionType spin_interaction_type_ = SpinInteractionType::Off;
 
  bool verbose_ = true;
 
  friend std::ostream &operator<<(std::ostream &out, const ListModus &m);
};
 
class ListBoxModus : public ListModus {
 public:
  explicit ListBoxModus(Configuration modus_config,
                        const ExperimentParameters &parameters);
 
  bool is_box() const { return true; }
 
  int impose_boundary_conditions(Particles *particles,
                                 const OutputsList &output_list = {});
 
  Grid<GridOptions::PeriodicBoundaries> create_grid(
      const Particles &particles, double min_cell_length,
      double timestep_duration, CollisionCriterion crit,
      const bool include_unformed_particles,
      CellSizeStrategy strategy = CellSizeStrategy::Optimal) const {
    CellNumberLimitation limit = CellNumberLimitation::ParticleNumber;
    if (crit == CollisionCriterion::Stochastic) {
      limit = CellNumberLimitation::None;
    }
    return {{{0, 0, 0}, {length_, length_, length_}},
            particles,
            min_cell_length,
            timestep_duration,
            limit,
            include_unformed_particles,
            strategy};
  }
 
 private:
  const double length_;
};
 
}  // namespace smash
 
#endif  // SRC_INCLUDE_SMASH_LISTMODUS_H_