SimKernelMT.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/

 
#ifndef ISF_SIMKERNELMT_H
#define ISF_SIMKERNELMT_H 1
 
// Interfaces to ISF Tools and Services
#include "ISF_Interfaces/IInputConverter.h"
#include "ISF_Interfaces/ISimulatorTool.h"
#include "ISF_Interfaces/IGeoIDSvc.h"
#include "ISF_Interfaces/ISimulationSelector.h"
#include "ISF_Interfaces/SimulationFlavor.h"
#include "ISF_Interfaces/IEntryLayerTool.h"
#include "ISF_Interfaces/ITruthSvc.h"
#include "ISF_Interfaces/IParticleOrderingTool.h"
#include "ISF_Interfaces/IGenEventFilter.h"
 
// DetectorDescription
#include "AtlasDetDescr/AtlasRegion.h"
 
// McEventCollection
#include "GeneratorObjects/McEventCollection.h"
#include "HepMC_Interfaces/IZeroLifetimePatcher.h"
 
// TrackRecordCollection (and TrackRecord)
#include "TrackRecord/TrackRecordCollection.h"
 
// Framework includes
#include "AthenaBaseComps/AthAlgorithm.h"
#include "StoreGate/ReadHandle.h"
#include "StoreGate/WriteHandle.h"
#include "GaudiKernel/ServiceHandle.h"
 
// STL includes
#include <array>
#include <map>
 
// forward declarations
namespace ISFTesting {
  class SimKernelMT_test;
}
 
 
namespace ISF {

class SimKernelMT final : public AthAlgorithm {

  friend class ISFTesting::SimKernelMT_test;
 
public:
  // delegate Constructor
  using AthAlgorithm::AthAlgorithm;

  StatusCode initialize() override;

  StatusCode execute() override;

  StatusCode finalize() override;
 
  bool isClonable() const override { return true; }
 
private:
  ISimulatorTool& identifySimulator(const ISF::ISFParticle& particle);

  SG::ReadHandleKey<McEventCollection> m_inputEvgenKey{this, "InputEvgenCollection", "", "Input EVGEN collection."};
  SG::WriteHandleKey<McEventCollection> m_outputTruthKey{this, "OutputTruthCollection", "", "Output Truth collection."};
  SG::WriteHandleKey<TrackRecordCollection> m_caloEntryLayerKey{this, "CaloEntryLayerKey", "CaloEntryLayer", ""};
  SG::WriteHandleKey<TrackRecordCollection> m_muonEntryLayerKey{this, "MuonEntryLayerKey", "MuonEntryLayer", ""};
  SG::WriteHandleKey<TrackRecordCollection> m_muonExitLayerKey{this, "MuonExitLayerKey", "MuonExitLayer", ""};
 
  BooleanProperty m_useShadowEvent{this, "UseShadowEvent", false, "New approach to selecting particles for simulation" };
  Gaudi::Property<bool> m_forceGeoIDSvc{this, "AlwaysUseGeoIDSvc", false, "Force geoID recalculation for each particle" };
 
  ToolHandle<IGenEventFilter>  m_truthPreselectionTool{this, "TruthPreselectionTool", "", "Tool for filtering out quasi-stable particle daughters"};

  ServiceHandle<IInputConverter> m_inputConverter{this, "InputConverter", "", "Input McEventCollection->ISFParticleContainer conversion service."};

  ServiceHandle<ITruthSvc> m_truthRecordSvc{this,"TruthRecordService", "ISF_MC15aPlusTruthService", ""};

  ServiceHandle<Simulation::IZeroLifetimePatcher> m_qspatcher{this, "QuasiStablePatcher", "", "Quasi-Stable Particle Simulation Patcher"};

  ToolHandleArray<ISimulatorTool> m_simulationTools{this, "SimulationTools", {}, ""};

  ISimulatorTool *m_particleKillerTool{};

  PublicToolHandle<IEntryLayerTool> m_entryLayerTool{this, "EntryLayerTool", "ISF_EntryLayerToolMT", ""};

  ServiceHandle<IGeoIDSvc> m_geoIDSvc{this, "GeoIDSvc", "", "Service to set particle GeoIDs"};

  ToolHandle<IParticleOrderingTool> m_orderingTool{this, "ParticleOrderingTool", "", "Tool to set order of particles"};

  std::array<PublicToolHandleArray<ISimulationSelector>, AtlasDetDescr::fNumAtlasRegions> m_simSelectors{{
    {}, // fUndefinedAtlasRegion
    {this, "IDSimulationSelectors", {} }, // fAtlasID
    {this, "BeamPipeSimulationSelectors", {} }, // fAtlasFoward
    {this, "CaloSimulationSelectors", {} }, // fAtlasCalo
    {this, "MSSimulationSelectors", {} }, // fAtlasMS
    {this, "CavernSimulationSelectors", {} } // fAtlasCavern
    }};

  std::map<ISF::SimulationFlavor, ISimulatorTool*> m_simToolMap;

  Gaudi::Property<size_t> m_maxParticleVectorSize{this, "MaximumParticleVectorSize", 10240};
};
 
} // namespace ISF
 
#endif // ISF_SIMKERNELMT_H