FastCaloSim.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef G4FASTSIMULATION_FASTCALOSIM_H
#define G4FASTSIMULATION_FASTCALOSIM_H
 
// Service handle to define smart pointer to FastCaloSim parametrisation service
#include "GaudiKernel/ServiceHandle.h"
// Geant4 fast simulation base class
#include "G4VFastSimulationModel.hh"
// FastCaloSim parametrisation service interface
#include "ISF_FastCaloSimInterfaces/IFastCaloSimParamSvc.h"
// FastCaloSim extrapolation tool interface
#include "ISF_FastCaloSimParametrization/IFastCaloSimCaloExtrapolation.h"
// FastCaloSim ATLAS transportation tool interface
#include "ISF_FastCaloSimParametrization/IFastCaloSimCaloTransportation.h"
// Geant4 transportation tool interface
#include "G4AtlasInterfaces/IG4CaloTransportTool.h"
// Geant4 Punchthrough G4 Tool
#include "G4AtlasInterfaces/IPunchThroughSimWrapper.h"
 
// Random generator service interface
#include "AthenaKernel/IAthRNGSvc.h"
// FastCaloSim tool
#include "FastCaloSimTool.h"
 
 
class CaloCellContainerSD;
class G4FieldTrack;
class G4SafetyHelper;
 
class FastCaloSim: public G4VFastSimulationModel
{
 public:
 
  FastCaloSim(const std::string& name, 
              const ServiceHandle<IAthRNGSvc>& rndmGenSvc,
              const Gaudi::Property<std::string>& randomEngineName,
              const PublicToolHandle<IFastCaloSimCaloTransportation>& FastCaloSimCaloTransportation,
              const PublicToolHandle<IFastCaloSimCaloExtrapolation>& FastCaloSimCaloExtrapolation,
              const PublicToolHandle<IG4CaloTransportTool>& G4CaloTransportTool,
              const PublicToolHandle<IPunchThroughSimWrapper>& PunchThroughSimWrapper,
              const ServiceHandle<ISF::IFastCaloSimParamSvc>& FastCaloSimSvc,
              const Gaudi::Property<std::string>& CaloCellContainerSDName,
              const Gaudi::Property<bool>& doG4Transport,
              const Gaudi::Property<bool>& doPhotons,
              const Gaudi::Property<bool>& doElectrons,
              const Gaudi::Property<bool>& doHadrons,
              const Gaudi::Property<float>& AbsEtaMin,
              const Gaudi::Property<float>& AbsEtaMax,
              const Gaudi::Property<float>& EkinMinPhotons,
              const Gaudi::Property<float>& EkinMaxPhotons,
              const Gaudi::Property<float>& EkinMinElectrons,
              const Gaudi::Property<float>& EkinMaxElectrons,
              const Gaudi::Property<bool>& doEMECFCS,
              const Gaudi::Property<bool>& doPunchThrough,
              FastCaloSimTool * FastCaloSimTool);
  ~FastCaloSim() {}
 
  G4bool IsApplicable(const G4ParticleDefinition&) override final;
  void DoIt(const G4FastTrack&, G4FastStep&) override final;
  void StartOfAthenaEvent(const EventContext& ctx);
  void EndOfAthenaEvent(const EventContext& ctx);
 
  G4bool ModelTrigger(const G4FastTrack &) override final;
 
  CaloCellContainerSD * getCaloCellContainerSD();
 
  G4bool passedIDCaloBoundary(const G4FastTrack& fastTrack);
  
 private:
 
  // Random generator services
  ServiceHandle<IAthRNGSvc> m_rndmGenSvc;
  Gaudi::Property<std::string> m_randomEngineName;
  ATHRNG::RNGWrapper* m_rngWrapper{};
 
  // FastCaloSimCaloTransportation tool to transport particles through the detector with the ATLAS tracking tools 
  PublicToolHandle<IFastCaloSimCaloTransportation> m_FastCaloSimCaloTransportation;
  // FastCaloSimCaloExtrapolation tool to extrapolate particle shower positions to layers
  PublicToolHandle<IFastCaloSimCaloExtrapolation> m_FastCaloSimCaloExtrapolation;
  // Geant4 transportation tool
  PublicToolHandle<IG4CaloTransportTool> m_G4CaloTransportTool;
  // Geant4 Punchthrough G4 Tool
  PublicToolHandle<IPunchThroughSimWrapper> m_PunchThroughSimWrapper;
 
  // Main FastCaloSim service
  ServiceHandle<ISF::IFastCaloSimParamSvc> m_FastCaloSimSvc;
  // Name of associated CaloCellContainer sensitive detector
  Gaudi::Property<std::string> m_CaloCellContainerSDName;
  // Boolean flag to enable Geant4 transportation
  Gaudi::Property<bool> m_doG4Transport;
 
  // Boundaries to enable AF3 transportation
  Gaudi::Property<bool> m_doPhotons;
  Gaudi::Property<bool> m_doElectrons;
  Gaudi::Property<bool> m_doHadrons;
  Gaudi::Property<float> m_AbsEtaMin;
  Gaudi::Property<float> m_AbsEtaMax;
  Gaudi::Property<float> m_EkinMinPhotons;
  Gaudi::Property<float> m_EkinMaxPhotons;
  Gaudi::Property<float> m_EkinMinElectrons;
  Gaudi::Property<float> m_EkinMaxElectrons;
  Gaudi::Property<float> m_doEMECFCS;
 
  //For PunchThrough
  Gaudi::Property<bool> m_doPunchThrough;
 
  // Fast simulation FastCaloSimTool 
  FastCaloSimTool * m_FastCaloSimTool;
};
 
#endif //G4FASTSIMULATION_FASTCALOSIM_H