SimKernel.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef ISF_ALGS_SIMKERNEL_H
#define ISF_ALGS_SIMKERNEL_H 1
 
// STL includes
#include <string>
 
// FrameWork includes
#include "StoreGate/ReadHandle.h"
#include "StoreGate/WriteHandle.h"
#include "GaudiKernel/ToolHandle.h"
#include "GaudiKernel/ServiceHandle.h"
#include "AthenaBaseComps/AthAlgorithm.h"
#include "CxxUtils/checker_macros.h"
 
// ISF includes
#include "ISF_Event/SimSvcID.h"
#include "ISF_Interfaces/ISimulationSelector.h"
#include "ISF_Interfaces/IInputConverter.h"
#include "ISF_Interfaces/IGenEventFilter.h"
 
// DetectorDescription
#include "AtlasDetDescr/AtlasRegion.h"
 
// McEventCollection
#include "GeneratorObjects/McEventCollection.h"
#include "HepMC_Interfaces/IZeroLifetimePatcher.h"
 
// forward declarations
namespace PMonUtils {
  class CustomBenchmark;
}
 
namespace ISF {
 
    class IParticleMgr;
    class ITruthSvc;
    class ISimulationSvc;
    class IMonitoringTool;
    class IEventFilterTool;
 

  class ATLAS_NOT_THREAD_SAFE SimKernel : public AthAlgorithm {  // serial version
 
  public:
    SimKernel( const std::string& name, ISvcLocator* pSvcLocator );

    virtual ~SimKernel();

    StatusCode  initialize(); 
    StatusCode  execute();

    StatusCode  finalize();
 
  private:
    StatusCode initSimSvcs( SimSelectorToolArray &simSelectorTools);

    StatusCode prepareInput(SG::ReadHandle<McEventCollection>& inputTruth,
                            SG::WriteHandle<McEventCollection>& outputTruth,
                            std::unique_ptr<McEventCollection>& shadowTruth,
                            ISFParticleContainer& simParticles) const;
 

    SG::ReadHandle<McEventCollection>    m_inputHardScatterEvgen; 
    SG::ReadHandle<McEventCollection>    m_inputPileupEvgen;      
    SG::WriteHandle<McEventCollection>   m_outputHardScatterTruth;
    SG::WriteHandle<McEventCollection>   m_outputPileupTruth;     
    ServiceHandle<IInputConverter>       m_inputConverter;        
 
    ToolHandle<IGenEventFilter>  m_truthPreselectionTool{this, "TruthPreselectionTool", "", "Tool for filtering out quasi-stable particle daughters"};
 
    BooleanProperty m_useShadowEvent{this, "UseShadowEvent", false, "New approach to selecting particles for simulation" };

    ServiceHandle<IParticleBroker>       m_particleBroker;
    ServiceHandle<ITruthSvc>             m_truthRecordSvc;

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

    ServiceHandle<Simulation::IZeroLifetimePatcher> m_qspatcher;

    ToolHandleArray<IEventFilterTool>    m_eventFilters;

    bool                                 m_doMemMon;
    ToolHandle<IMonitoringTool>          m_memMon;
    unsigned int                         m_memUsageEvts;

    std::vector<ISimulationSvc*>         m_simSvcs;     
    std::vector<std::string>             m_simSvcNames; 
    ISF::SimSvcID                        m_numSimSvcs;  

    unsigned int                         m_numISFEvents;

    bool                                 m_doCPUMon;    
    //PMonUtils::CustomBenchmark          *m_benchPDGCode; //TODO: implement this if feasible
    //PMonUtils::CustomBenchmark          *m_benchGeoID;   //TODO: implement this if feasible
    PMonUtils::CustomBenchmark          *m_benchSimID;

    long int                             m_numParticles; 

    size_t                               m_maxParticleVectorSize; 
  };
}
 
 
#endif //> !ISF_ALGS_SIMKERNEL_H