VecGeomG4Navigator.h

Go to the documentation of this file.

// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
 
#ifndef O2_SIMSETUP_VECGEOMG4NAVIGATOR_H_
#define O2_SIMSETUP_VECGEOMG4NAVIGATOR_H_
 
#include "VecGeomG4NavigatorBase.h"
 
namespace o2::simsetup
{
 
class VecGeomG4Navigator : public VecGeomG4NavigatorBase
{
 public:
  VecGeomG4Navigator(VecGeomG4Map const& map, double pushDepth, bool zeroSafety);
  ~VecGeomG4Navigator() override;
 
  G4double ComputeStep(const G4ThreeVector& globalPoint, const G4ThreeVector& direction,
                       const G4double proposedStepLength, G4double& newSafety) override;
 
  G4VPhysicalVolume* ResetHierarchyAndLocate(const G4ThreeVector& point, const G4ThreeVector& direction,
                                             const G4TouchableHistory& history) override;
 
  G4VPhysicalVolume* LocateGlobalPointAndSetup(const G4ThreeVector& point, const G4ThreeVector* direction = nullptr,
                                               const G4bool relativeSearch = true,
                                               const G4bool ignoreDirection = true) override;
 
  void LocateGlobalPointWithinVolume(const G4ThreeVector& position) override;
 
  G4double ComputeSafety(const G4ThreeVector& globalPoint, const G4double proposedMaxLength = DBL_MAX,
                         const G4bool keepState = true) override;
 
  // Both point out of the volume left; the local one is in the frame of the final volume.
  G4ThreeVector GetLocalExitNormal(G4bool* valid) override;
  G4ThreeVector GetGlobalExitNormal(const G4ThreeVector& point, G4bool* valid) override;
 
 private:
  G4VPhysicalVolume* updateG4History();
  void locateFromWorld(const V3& point);
  void leaveFlushVolumes(const V3& point, const V3& dir, int minLevel, vecgeom::VPlacedVolume const* avoid);
  void updateCrossingFlags(bool entering);
  void clearLastExited()
  {
    mCurState.SetLastExited(mEmptyState.GetLastExitedState());
    mExitBlockPending = false;
  }
  void setExited(vecgeom::NavigationState const& st, bool normalFromPush)
  {
    mExitedState = st;
    mExitBlockPending = true;
    mExitNormalFromPush = normalFromPush && mPushNormalValid;
  }
  double boundaryPush(const V3& point, const V3& dir);
  bool computeExitNormal(const G4ThreeVector& point, V3& globalNormal) const;
 
  double mPushDepth = 1.e-9; 
  bool mZeroSafety = false;
 
  vecgeom::NavigationState mCurState;     
  vecgeom::NavigationState mNextState;    
  vecgeom::NavigationState mStepState;    
  vecgeom::NavigationState mReloScratch;  
  vecgeom::NavigationState mPathScratch;  
  vecgeom::NavigationState mHistoryState; 
  vecgeom::NavigationState mEmptyState;   
  vecgeom::NavigationState mNormalState;  
  vecgeom::NavigationState mExitedState;  
  bool mExitBlockPending = false;         
  bool mExitNormalFromPush = false;       
  V3 mPushNormal;                         
  bool mPushNormalValid = false;
  bool mHistoryValid = false;
 
  bool mWouldEnter = false; 
  bool mWouldExit = false;  
  G4ThreeVector mNextPoint{-1e8, -1e8, -1e8};
  G4ThreeVector mLastLocatedPoint{-1e8, -1e8, -1e8};
  bool mLocatedOnBoundary = false;
  G4ThreeVector mSafetyOrig{-1e8, -1e8, -1e8}; 
  double mLastSafety = 0.;                     
  bool mNormalEnter = false;
  bool mNormalValid = false;
  G4ThreeVector mNormalPoint{-1e8, -1e8, -1e8};
 
  static constexpr int kActionThresholdNoZeroSteps = 10;
  static constexpr int kAbandonThresholdNoZeroSteps = 25;
  int mNzeroSteps = 0;
 
  // What the navigator had to work around, reported at the end.
  long mZeroStepCount = 0;
  long mStuckPushCount = 0;
  long mAbandonCount = 0;
  long mNegativeSafetyCount = 0;
  long mUnmappableHistoryCount = 0;
  long mRelocatedResumeCount = 0;
  long mNoNormalCount = 0;
};
 
} // namespace o2::simsetup
 
#endif