include/Geant4/G4MultiLevelLocator.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // Class G4MultiLevelLocator
0027 //
0028 // class description:
0029 //
0030 // Implementing the calculation of the intersection point with a boundary when
0031 // PropagationInField is used. Derived from method LocateIntersectionPoint()
0032 // from G4PropagatorInField, it is based on a linear method for finding the
0033 // intersection point by means of a 'depth' algorithm in case of slow progress
0034 // (intersection is not found after 100 trials).
0035
0036 // History:
0037 // -------
0038 // 27.10.08 - Tatiana Nikitina: Derived from LocateIntersectionPoint() from
0039 //                              G4PropagatorInField class
0040 // ---------------------------------------------------------------------------
0041
0042 #ifndef G4MULTILEVELLOCATOR_HH
0043 #define G4MULTILEVELLOCATOR_HH
0044
0045 #include "G4VIntersectionLocator.hh"
0046
0047 class G4MultiLevelLocator : public G4VIntersectionLocator
0048 {
0049    public:  // with description
0050
0051      G4MultiLevelLocator(G4Navigator *theNavigator);
0052        // Constructor
0053      ~G4MultiLevelLocator() override;
0054        // Default destructor
0055
0056      G4bool EstimateIntersectionPoint(
0057          const  G4FieldTrack&       curveStartPointTangent,           // A
0058          const  G4FieldTrack&       curveEndPointTangent,             // B
0059          const  G4ThreeVector&      trialPoint,                       // E
0060                 G4FieldTrack&       intersectPointTangent,            // Output
0061                 G4bool&             recalculatedEndPoint,             // Out
0062                 G4double&           fPreviousSafety,                  // In/Out
0063                 G4ThreeVector&      fPreviousSftOrigin) override;     // In/Out
0064       // If such an intersection exists, this function calculates the
0065       // intersection point of the true path of the particle with the surface
0066       // of the current volume (or of one of its daughters).
0067       // Should use lateral displacement as measure of convergence
0068
0069      void ReportStatistics();
0070
0071      inline void SetMaxSteps(unsigned int valMax) { fMaxSteps= valMax; }
0072      inline void SetWarnSteps(unsigned int valWarn) { fWarnSteps= valWarn; }
0073
0074    private:
0075
0076      void ReportFieldValue( const G4FieldTrack& locationPV,
0077                             const char* nameLoc,
0078                             const G4EquationOfMotion* equation );
0079
0080      // Invariants -- parameters
0081      // ====================================
0082      static const G4int max_depth = 10;
0083      unsigned int fMaxSteps = 10000; // Effort abandoned; signal is looping
0084      unsigned int fWarnSteps = 1000; // Warn about many steps (but succeeded)
0085
0086      // State - varies during simulation
0087      // ====================================
0088      G4FieldTrack* ptrInterMedFT[max_depth+1];
0089        // Used to store intermediate tracks values in case of too slow progress
0090
0091      unsigned long int fNumCalls = 0;
0092      unsigned long int fNumAdvanceFull = 0,
0093                        fNumAdvanceGood = 0,
0094                        fNumAdvanceTrials = 0;
0095        // Counters for statistics & debugging
0096 };
0097
0098 #endif