StepEngine.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
// StepEngine.h, (c) ATLAS Detector software
 
#ifndef TRKEXENINGE_STEPENGINE_H
#define TRKEXENINGE_STEPENGINE_H
 
#ifndef TRKEXENINGE_OUTPUTHELPER 
#define TRKEXENINGE_OUTPUTHELPER 
#define OH_CHECKFOUND(object) ( object ? "found" : "not found")
#endif
 
// Gaudi
#include "AthenaBaseComps/AthAlgTool.h"
#include "GaudiKernel/ToolHandle.h"
// Trk
#include "TrkExInterfaces/IExtrapolationEngine.h"
#include "TrkExInterfaces/ExtrapolationMacros.h"
#include "TrkExInterfaces/IPropagator.h"
#include "TrkExUtils/ExtrapolationCell.h"
#include "TrkExUtils/TargetSurfaces.h"
#include "TrkParameters/TrackParameters.h"
#include "TrkNeutralParameters/NeutralParameters.h"
 
#include "CxxUtils/checker_macros.h"
 
namespace Trk {
 
  class IMaterialEffectsEngine;
  class INavigationEngine;        
    
  class ATLAS_NOT_THREAD_SAFE StepEngine : public AthAlgTool, virtual public IExtrapolationEngine {
 
      public:
          
        enum ResolveLayerType {
          StartLayer                = 0,
          NavigationLayer           = 1,
          PassThroughLayer          = 2,
          SubStructureLayer         = 3,
          DestinationLayer          = 4,
          StartAndDestinationLayer  = 6,
          UndefinedLayer            = 5
        };          
        
        StepEngine(const std::string&,const std::string&,const IInterface*);
        
        virtual ~StepEngine();
 
        virtual StatusCode initialize() override;
        
        virtual StatusCode finalize() override;
        
        using IExtrapolationEngine::extrapolate;
        
        virtual ExtrapolationCode extrapolate(ExCellCharged& ecCharged,
                                              const Surface* sf = 0,
                                              const BoundaryCheck& bcheck = true) const override;
 
 
        virtual ExtrapolationCode extrapolate(ExCellNeutral& ecNeutral,
                                              const Surface* sf = 0,
                                              const BoundaryCheck& bcheck = true) const override;
                         
        virtual GeometryType geometryType() const override;
                         
     private:
        template <class T> Trk::ExtrapolationCode targetSurfacesT(ExtrapolationCell<T>& eCell,
                                   Trk::TargetSurfaceVector& ts,
                                   bool trueOrderedIntersections, 
                                   const Surface* sf = 0,
                                   const BoundaryCheck& bcheck = true ) const;
 
    template<class T> Trk::ExtrapolationCode resolveFrameBoundaryT(ExtrapolationCell<T>& eCell,
                                       Amg::Vector3D position,
                                                                       unsigned int index ) const;
        void evaluateDistance(Trk::TargetSurface& tt, const Amg::Vector3D& pos, const Amg::Vector3D& mom,
                              Trk::TargetSurfaceVector&ts, bool trueOrdered) const;
                                                           
    Trk::ExtrapolationCode handleIntersection(ExCellCharged& ecCharged, 
                          Trk::TargetSurfaceVector& solutions) const;
 
        ToolHandle<IPropagator> m_propagator
      {this, "Propagator", "", "the used propagation engine"};
        ToolHandle<IMaterialEffectsEngine> m_materialEffectsEngine
      {this, "MaterialEffectsEngine", "", "the material effects updated"};
        ToolHandle<INavigationEngine> m_navigationEngine
      {this, "NavigationEngine", "", "access to tracking geometry"};
 
        // local variables
    double m_tolerance = 0.01;
 
        // target surfaces
        mutable TargetSurfaces                             m_targetSurfaces;
 
        // debugging mode & switch         
        BooleanProperty m_debugAndFix{this, "DebugAndFixMode", true};
        mutable bool m_debugCall = false;       // mode
 
        StringProperty m_sopPrefix_prop{this, "OutputPrefix", ""};
        StringProperty m_sopPostfix_prop{this, "OutputPostfix", ""};
 
    };
 
  inline GeometryType StepEngine::geometryType() const 
      { return Trk::Dense; }
 
 
} // end of namespace
 
#include "StepEngine.icc"  
 
#endif // TRKEXINTERFACES_IStepEngine_H