Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/geometry/navigation/include/G4SafetyHelper.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

Diff markup

Differences between /geometry/navigation/include/G4SafetyHelper.hh (Version 11.3.0) and /geometry/navigation/include/G4SafetyHelper.hh (Version 9.4.p4)


  1 //                                                  1 //
  2 // *******************************************      2 // ********************************************************************
  3 // * License and Disclaimer                         3 // * License and Disclaimer                                           *
  4 // *                                                4 // *                                                                  *
  5 // * The  Geant4 software  is  copyright of th      5 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
  6 // * the Geant4 Collaboration.  It is provided      6 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
  7 // * conditions of the Geant4 Software License      7 // * conditions of the Geant4 Software License,  included in the file *
  8 // * LICENSE and available at  http://cern.ch/      8 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
  9 // * include a list of copyright holders.           9 // * include a list of copyright holders.                             *
 10 // *                                               10 // *                                                                  *
 11 // * Neither the authors of this software syst     11 // * Neither the authors of this software system, nor their employing *
 12 // * institutes,nor the agencies providing fin     12 // * institutes,nor the agencies providing financial support for this *
 13 // * work  make  any representation or  warran     13 // * work  make  any representation or  warranty, express or implied, *
 14 // * regarding  this  software system or assum     14 // * regarding  this  software system or assume any liability for its *
 15 // * use.  Please see the license in the file      15 // * use.  Please see the license in the file  LICENSE  and URL above *
 16 // * for the full disclaimer and the limitatio     16 // * for the full disclaimer and the limitation of liability.         *
 17 // *                                               17 // *                                                                  *
 18 // * This  code  implementation is the result      18 // * This  code  implementation is the result of  the  scientific and *
 19 // * technical work of the GEANT4 collaboratio     19 // * technical work of the GEANT4 collaboration.                      *
 20 // * By using,  copying,  modifying or  distri     20 // * By using,  copying,  modifying or  distributing the software (or *
 21 // * any work based  on the software)  you  ag     21 // * any work based  on the software)  you  agree  to acknowledge its *
 22 // * use  in  resulting  scientific  publicati     22 // * use  in  resulting  scientific  publications,  and indicate your *
 23 // * acceptance of all terms of the Geant4 Sof     23 // * acceptance of all terms of the Geant4 Software license.          *
 24 // *******************************************     24 // ********************************************************************
 25 //                                                 25 //
                                                   >>  26 //
                                                   >>  27 // $Id: G4SafetyHelper.hh,v 1.7 2007-05-02 15:32:13 japost Exp $
                                                   >>  28 // GEANT4 tag $Name: not supported by cvs2svn $
                                                   >>  29 //
                                                   >>  30 //
 26 // class G4SafetyHelper                            31 // class G4SafetyHelper
 27 //                                                 32 //
 28 // Class description:                              33 // Class description:
 29 //                                                 34 //
 30 // This class is a helper for physics processe     35 // This class is a helper for physics processes which require 
 31 // knowledge of the safety, and the step size      36 // knowledge of the safety, and the step size for the 'mass' geometry
 32                                                    37 
 33 // First version:  J.Apostolakis,  July 5th, 2 <<  38 // First version:  J. Apostolakis,  July 5th, 2006
                                                   >>  39 // Modified:
                                                   >>  40 //  10.04.07 V.Ivanchenko  Use unique G4SafetyHelper
 34 // -------------------------------------------     41 // --------------------------------------------------------------------
                                                   >>  42 
 35 #ifndef G4SAFETYHELPER_HH                          43 #ifndef G4SAFETYHELPER_HH
 36 #define G4SAFETYHELPER_HH 1                        44 #define G4SAFETYHELPER_HH 1
 37                                                    45 
 38 #include <vector>                                  46 #include <vector>
 39                                                    47 
 40 #include "G4Types.hh"                              48 #include "G4Types.hh"
 41 #include "G4ThreeVector.hh"                        49 #include "G4ThreeVector.hh"
 42 #include "G4Navigator.hh"                          50 #include "G4Navigator.hh"
 43                                                    51 
 44 class G4PathFinder;                                52 class G4PathFinder;
 45                                                    53 
 46 class G4SafetyHelper                               54 class G4SafetyHelper
 47 {                                                  55 {
 48   public: // with description                  <<  56 public: // with description
 49                                                << 
 50     G4SafetyHelper();                          << 
 51    ~G4SafetyHelper();                          << 
 52       // Constructor and destructor            << 
 53                                                << 
 54     G4double CheckNextStep( const G4ThreeVecto << 
 55                             const G4ThreeVecto << 
 56                             const G4double cur << 
 57                                   G4double& ne << 
 58       // Return linear step for mass geometry  << 
 59                                                << 
 60     G4double ComputeSafety( const G4ThreeVecto << 
 61                             G4double maxRadius << 
 62       // Return safety for all geometries.     << 
 63       //                                       << 
 64       // The 2nd argument is the radius of you << 
 65       // displacement). Giving this you can re << 
 66       // cost. If the second argument is not g << 
 67       // isotropic safety                      << 
 68                                                << 
 69     void Locate(const G4ThreeVector& pGlobalPo << 
 70                 const G4ThreeVector& direction << 
 71       // Locate the point for all geometries   << 
 72                                                << 
 73     void ReLocateWithinVolume(const G4ThreeVec << 
 74       // Relocate the point in the volume of i << 
 75                                                << 
 76     inline void EnableParallelNavigation(G4boo << 
 77       //  To have parallel worlds considered,  << 
 78       //  Alternative is to use single (mass)  << 
 79                                                << 
 80     void InitialiseNavigator();                << 
 81       // Check for new navigator for tracking, << 
 82                                                << 
 83     inline G4int SetVerboseLevel( G4int lev ); << 
 84     inline G4VPhysicalVolume* GetWorldVolume() << 
 85     inline void SetCurrentSafety(G4double val, << 
 86                                                    57 
 87   public: // without description               <<  58   G4SafetyHelper(); 
 88                                                <<  59   ~G4SafetyHelper();
 89     void InitialiseHelper();                   <<  60      //
 90                                                <<  61      // Constructor and destructor
 91   private:                                     <<  62 
 92                                                <<  63   G4double CheckNextStep( const G4ThreeVector& position, 
 93     G4PathFinder* fpPathFinder = nullptr;      <<  64                           const G4ThreeVector& direction,
 94     G4Navigator* fpMassNavigator = nullptr;    <<  65                           const G4double currentMaxStep,
 95                                                <<  66                                 G4double& newSafety );
 96     G4bool fUseParallelGeometries = false;     <<  67      //
 97       // Flag whether to use PathFinder or sin <<  68      // Return linear step for mass geometry
 98       // By default, one geometry only         <<  69 
 99     G4bool fFirstCall = true;                  <<  70   G4double ComputeSafety( const G4ThreeVector& pGlobalPoint ); 
100       // Flag of first call                    <<  71      //
101     G4int fVerbose = 0;                        <<  72      // Return safety for all geometries
102       // Whether to print warning in case of m <<  73 
103                                                <<  74   void Locate(const G4ThreeVector& pGlobalPoint,
104     // State used during tracking -- for optim <<  75               const G4ThreeVector& direction);
105                                                <<  76      //
106     G4ThreeVector fLastSafetyPosition;         <<  77      // Locate the point for all geometries
107     G4double fLastSafety = 0.0;                <<  78 
108                                                <<  79   void ReLocateWithinVolume(const G4ThreeVector& pGlobalPoint );
109     // const G4double fRecomputeFactor = 0.0;  <<  80      //
                                                   >>  81      // Relocate the point in the volume of interest
                                                   >>  82 
                                                   >>  83   inline void EnableParallelNavigation(G4bool parallel);
                                                   >>  84      // 
                                                   >>  85      //  To have parallel worlds considered, must be true.
                                                   >>  86      //  Alternative is to use single (mass) Navigator directly
                                                   >>  87 
                                                   >>  88   void InitialiseNavigator();
                                                   >>  89      //
                                                   >>  90      // Check for new navigator for tracking, and reinitialise pointer
                                                   >>  91 
                                                   >>  92   inline G4VPhysicalVolume* GetWorldVolume();
                                                   >>  93   inline void SetCurrentSafety(G4double val, const G4ThreeVector& pos);
                                                   >>  94 
                                                   >>  95 public: // without description
                                                   >>  96 
                                                   >>  97   void InitialiseHelper();
                                                   >>  98 
                                                   >>  99 private:
                                                   >> 100 
                                                   >> 101   G4PathFinder* fpPathFinder;
                                                   >> 102   G4Navigator*  fpMassNavigator;
                                                   >> 103   G4int         fMassNavigatorId;
                                                   >> 104 
                                                   >> 105   G4bool        fUseParallelGeometries; 
                                                   >> 106     // Flag whether to use PathFinder or single (mass) Navigator directly
                                                   >> 107   G4bool fFirstCall;
                                                   >> 108     // Flag of first call
                                                   >> 109 
                                                   >> 110   // State used during tracking -- for optimisation
                                                   >> 111   G4ThreeVector fLastSafetyPosition;
                                                   >> 112   G4double      fLastSafety;
                                                   >> 113   const G4double  fRecomputeFactor;   
110        // parameter for further optimisation:     114        // parameter for further optimisation: 
111        // if ( move < fact*safety )  do fast r    115        // if ( move < fact*safety )  do fast recomputation of safety
112                                                << 116   // End State (tracking)
113     // End State (tracking)                    << 
114 };                                                117 };
115                                                   118 
116 // ------------------------------------------- << 
117 // Inline definitions                             119 // Inline definitions
118 // ------------------------------------------- << 
119                                                << 
120 inline G4int G4SafetyHelper::SetVerboseLevel(  << 
121 {                                              << 
122   G4int oldlv = fVerbose;                      << 
123   fVerbose = lev;                              << 
124   return oldlv;                                << 
125 }                                              << 
126                                                   120 
127 inline                                            121 inline
128 void G4SafetyHelper::EnableParallelNavigation(    122 void G4SafetyHelper::EnableParallelNavigation(G4bool parallel) 
129 {                                                 123 {
130   fUseParallelGeometries = parallel;              124   fUseParallelGeometries = parallel;
131 }                                                 125 } 
132                                                   126 
133 inline                                            127 inline
134 G4VPhysicalVolume* G4SafetyHelper::GetWorldVol    128 G4VPhysicalVolume* G4SafetyHelper::GetWorldVolume()
135 {                                                 129 {
136   return fpMassNavigator->GetWorldVolume();       130   return fpMassNavigator->GetWorldVolume();
137 }                                                 131 }
138                                                   132 
139 inline                                            133 inline
140 void G4SafetyHelper::SetCurrentSafety(G4double    134 void G4SafetyHelper::SetCurrentSafety(G4double val, const G4ThreeVector& pos)
141 {                                                 135 {
142   fLastSafety = val;                              136   fLastSafety = val;
143   fLastSafetyPosition = pos;                      137   fLastSafetyPosition = pos;
144 }                                                 138 }
145                                                   139 
146 #endif                                            140 #endif
147                                                   141