BDSAuxiliaryNavigator.hh

/* 
Beam Delivery Simulation (BDSIM) Copyright (C) Royal Holloway, 
University of London 2001 - 2024.
 
This file is part of BDSIM.
 
BDSIM is free software: you can redistribute it and/or modify 
it under the terms of the GNU General Public License as published 
by the Free Software Foundation version 3 of the License.
 
BDSIM is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License
along with BDSIM.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef BDSAUXILIARYNAVIGATOR_H
#define BDSAUXILIARYNAVIGATOR_H
 
#include "BDSMagnetStrength.hh"
 
#include "globals.hh" // geant4 types / globals
#include "G4AffineTransform.hh"
#include "G4Navigator.hh"
#include "G4ThreeVector.hh"
#include "G4Transform3D.hh"
 
class BDSStep;
class G4Step;
class G4VPhysicalVolume;
 
class BDSAuxiliaryNavigator
{
public:
  BDSAuxiliaryNavigator();
  ~BDSAuxiliaryNavigator();
 
  static void AttachWorldVolumeToNavigator(G4VPhysicalVolume* worldPVIn)
  {auxNavigator->SetWorldVolume(worldPVIn); worldPV = worldPVIn;}
 
  static void AttachWorldVolumeToNavigatorCL(G4VPhysicalVolume* curvilinearWorldPVIn)
  {auxNavigatorCL->SetWorldVolume(curvilinearWorldPVIn); curvilinearWorldPV = curvilinearWorldPVIn;}
 
  static void RegisterCurvilinearBridgeWorld(G4VPhysicalVolume* curvilinearBridgeWorldPVIn)
  {auxNavigatorCLB->SetWorldVolume(curvilinearBridgeWorldPVIn); curvilinearBridgeWorldPV = curvilinearBridgeWorldPVIn;}
 
  static void ResetNavigatorStates();
 
  G4VPhysicalVolume* LocateGlobalPointAndSetup(const G4ThreeVector& point,
                                               const G4ThreeVector* direction = nullptr,
                                               const G4bool pRelativeSearch   = true,
                                               const G4bool ignoreDirection   = true,
                                               G4bool useCurvilinear          = true) const;
 
  G4VPhysicalVolume* LocateGlobalPointAndSetup(G4Step const* const step,
                                               G4bool useCurvilinear = true) const;
 
  BDSStep ConvertToLocal(G4Step const* const step,
                         G4bool useCurvilinear = true) const;
 
  BDSStep ConvertToLocal(const G4ThreeVector& globalPosition,
                         const G4ThreeVector& globalDirection,
                         const G4double       stepLength     = 0,
                         const G4bool         useCurvilinear = true,
                         const G4double       marginLength   = 1) const;
 
  BDSStep ConvertToGlobalStep(const G4ThreeVector& localPosition,
                              const G4ThreeVector& localDirection,
                              const G4bool         useCurvilinear = true) const;
 
  G4ThreeVector ConvertToLocal(const G4double globalPoint[3],
                               const G4bool  useCurvilinear = true) const;
 
  G4ThreeVector ConvertToLocal(const G4ThreeVector& globalPosition,
                               const G4bool        useCurvilinear = true) const;
 
  G4ThreeVector ConvertToLocalNoSetup(const G4ThreeVector& globalPosition,
                                      const G4bool         useCurvilinear = true) const;
 
  G4ThreeVector ConvertAxisToLocal(const G4ThreeVector& globalAxis,
                                   const G4bool         useCurvilinear = true) const;
 
  G4ThreeVector ConvertAxisToLocal(const G4double globalPoint[3],
                                   const G4double globalAxis[3],
                                   const G4bool   useCurvilinear = true) const;
 
  G4ThreeVector ConvertAxisToLocal(const G4ThreeVector& globalPoint,
                                   const G4ThreeVector& globalAxis,
                                   const G4bool         useCurvilinear = true) const;
 
  G4ThreeVector ConvertAxisToGlobal(const G4ThreeVector& localAxis,
                                    const G4bool         useCurvilinear = true) const;
 
  std::pair<G4ThreeVector, G4ThreeVector> ConvertAxisToGlobal(const std::pair<G4ThreeVector, G4ThreeVector>& localAxis,
                                                              const G4bool useCurvilinear = true) const;
 
  G4ThreeVector ConvertToGlobal(const G4ThreeVector& localPosition,
                                const G4bool         useCurvilinear = true) const;
 
  G4ThreeVector ConvertAxisToGlobal(const G4ThreeVector& globalPosition,
                                    const G4ThreeVector& localAxis,
                                    const G4bool         useCurvilinear = true) const;
 
  G4ThreeVector ConvertToGlobal(const G4ThreeVector& globalPosition,
                                const G4ThreeVector& localPosition,
                                const G4bool         useCurvilinear = true) const;
 
  BDSStep GlobalToCurvilinear(const G4double       fieldArcLength,
                              const G4ThreeVector& unitField,
                              const G4double       angle,
                              const G4ThreeVector& position,
                              const G4ThreeVector& unitMomentum,
                              const G4double       h,
                              const G4bool         useCurvilinearWorld,
                              const G4double       FCof,
                              const G4double       tilt = 0);
 
  BDSStep GlobalToCurvilinear(const G4ThreeVector& position,
                              const G4ThreeVector& unitMomentum,
                              const G4double       h,
                              const G4bool         useCurvilinearWorld);
 
  BDSStep CurvilinearToGlobal(const G4ThreeVector& localPosition,
                              const G4ThreeVector& localMomentum,
                              const G4bool         useCurvilinearWorld);
 
  BDSStep CurvilinearToGlobal(const G4double       fieldArcLength,
                              const G4ThreeVector& unitField,
                              const G4double       angle,
                              const G4ThreeVector& CLPosition,
                              const G4ThreeVector& CLMomentum,
                              const G4bool         useCurvilinearWorld,
                              const G4double       FCof,
                              const G4double       tilt = 0);
 
protected:
  mutable G4AffineTransform globalToLocal;
  mutable G4AffineTransform localToGlobal;
  mutable G4AffineTransform globalToLocalCL;
  mutable G4AffineTransform localToGlobalCL;
  mutable G4bool            bridgeVolumeWasUsed;
  
  static G4Navigator* auxNavigator;
 
  static G4Navigator* auxNavigatorCL;
 
  static G4Navigator* auxNavigatorCLB;
 
private:
  G4Navigator* Navigator(G4bool curvilinear) const;
 
  const G4AffineTransform& GlobalToLocal(G4bool curvilinear) const;
  const G4AffineTransform& LocalToGlobal(G4bool curvilinear) const;
 
  void InitialiseTransform(const G4bool massworld        = true,
                           const G4bool curvilinearWorld = true) const;
  
  void InitialiseTransform(const G4ThreeVector& globalPosition) const;
 
  void InitialiseTransform(const G4ThreeVector& globalPosition,
                           const G4ThreeVector& globalMomentum,
                           const G4double       stepLength);
  
  static G4int numberOfInstances;
  
  static G4VPhysicalVolume* worldPV;
  static G4VPhysicalVolume* curvilinearWorldPV;
  static G4VPhysicalVolume* curvilinearBridgeWorldPV;
  
  G4double volumeMargin;
};
 
 
#endif