BeamHaloGenerator.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef BEAMHALOGENERATOR_H
#define BEAMHALOGENERATOR_H
 
#include "BeamHaloGenerator/BeamHaloParticle.h"
#include <string>
#include <vector>
#include <memory>
#include "AtlasHepMC/GenEvent.h"
 
namespace HepPDT {
  class ParticleDataTable;
}
namespace CLHEP {
  class HepRandomEngine;
}
class BeamHaloGeneratorAlg;
class AsciiInput;
class BeamHaloGeneratorSettings;
class BeamHaloParticleBuffer;

class BeamHaloGenerator {
 public:
 
  BeamHaloGenerator(const HepPDT::ParticleDataTable* particleTable,
            const std::string& inputFile,
            const std::vector<std::string>& generatorSettings);
 
  virtual ~BeamHaloGenerator();

  virtual int genInitialize();

  virtual int genFinalize();

  virtual int fillEvt(HepMC::GenEvent* evt,
            CLHEP::HepRandomEngine* engine) = 0;
  
 protected:

  virtual int readEvent(std::vector<BeamHaloParticle> *beamHaloEvent,
                        CLHEP::HepRandomEngine* engine) = 0;

  virtual int readParticle(BeamHaloParticle *beamHaloParticle) = 0;
 
 public:
 

  void setInterfacePlane(double interfacePlane) { m_interfacePlane = interfacePlane; }

  void setEnableFlip(bool enableFlip) { m_enableFlip = enableFlip; }

  void setFlipProbability(float flipProbability) { m_flipProbability = flipProbability; }

  void setEnableSampling(bool enableSampling) { m_enableSampling = enableSampling; }

  void setBufferFileName(const std::string& bufferFileName) { m_bufferFileName = bufferFileName; }

  void setDebugEnable(bool debug) { m_debug = debug; }
 
 protected:

  enum enumGeneratorProcessIds {
    MARS_READ,
    MARS_SINGLE,
    MARS_SHOWER,
    FLUKA_READ,
    FLUKA_SINGLE,
    FLUKA_SHOWER };
 

  bool flipEvent(CLHEP::HepRandomEngine* engine);

  int convertEvent(std::vector<BeamHaloParticle>* beamHaloEvent,
                   HepMC::GenEvent* evt,
                   CLHEP::HepRandomEngine* engine);

  const HepPDT::ParticleDataTable* m_particleTable;

  std::string m_inputFile;

  double m_interfacePlane;
  
  bool m_enableFlip;

  float m_flipProbability;
  
  bool m_enableSampling;

  std::string m_bufferFileName;

  std::unique_ptr<BeamHaloParticleBuffer> m_beamHaloParticleBuffer;

  std::unique_ptr<AsciiInput> m_asciiInput;

  std::unique_ptr<BeamHaloGeneratorSettings> m_beamHaloGeneratorSettings;

  long m_eventNumber;

  enum enumCounters {
    TOT_READ, 
    TOT_AFTER,
    TOT_GEN,
    NUM_COUNTERS};

  long m_counters[NUM_COUNTERS];

  double m_wsums[NUM_COUNTERS];

  bool m_debug;
 
 private:

  std::vector<std::string> m_generatorSettings;
 
};
 
#endif