BDSHepMC3Reader.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway, 
University of London 2001 - 2022.
 
This file is part of BDSIM.
 
BDSIM is free software: you can redistribute it and/or modify 
it under the terms of the GNU General Public License as published 
by the Free Software Foundation version 3 of the License.
 
BDSIM is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with BDSIM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifdef USE_HEPMC3
 
#ifndef BDSHEPMC3READER_H
#define BDSHEPMC3READER_H
 
#include "BDSEventGeneratorFileType.hh"
 
#include "globals.hh"
#include "G4RotationMatrix.hh"
#include "G4ThreeVector.hh"
#include "G4VPrimaryGenerator.hh"
 
class BDSBunchEventGenerator;
class G4Event;
class G4VSolid;
 
namespace HepMC3
{
  class GenEvent;
  class Reader;
}
 
class BDSHepMC3Reader: public G4VPrimaryGenerator
{
public:
  BDSHepMC3Reader() = delete;
  BDSHepMC3Reader(const G4String& distrType,
                  const G4String& fileNameIn,
                  BDSBunchEventGenerator* bunchIn,
                  G4bool removeUnstableWithoutDecayIn = true,
                  G4bool warnAboutSkippedParticlesIn  = true);
  virtual ~BDSHepMC3Reader();
 
  inline HepMC3::GenEvent* GetHepMCGenEvent() const {return hepmcEvent;}
 
  // The default behavior is that a single HepMC event generated by
  // GenerateHepMCEvent() will be converted to G4Event through HepMC2G4().
  virtual void GeneratePrimaryVertex(G4Event* anEvent);
 
  virtual void RecreateAdvanceToEvent(G4int eventOffset);
 
protected:
  void OpenFile();
 
  void CloseFile();
 
  void ReadSingleEvent();
 
  void HepMC2G4(const HepMC3::GenEvent* hepmcevt, G4Event* g4event);
  
  // We  have to take care for the position of primaries because
  // primary vertices outside the world volume would give rise to a G4Exception.
  virtual G4bool VertexInsideWorld(const G4ThreeVector& pos) const;
  
  // Note that the life of HepMC event object must be handled by users.
  // In the default implementation, a current HepMC event will be
  // deleted at GeneratePrimaryVertex() in the next event.
  HepMC3::GenEvent* hepmcEvent; // (care for single event case only)
 
private:
  HepMC3::Reader*           reader;
  G4String                  fileName;
  BDSBunchEventGenerator*   bunch;
  G4bool                    removeUnstableWithoutDecay;
  G4bool                    warnAboutSkippedParticles;
  BDSEventGeneratorFileType fileType;
  G4RotationMatrix          referenceBeamMomentumOffset;
  mutable G4VSolid*         worldSolid;
};
 
#endif
#endif