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 // 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 // Author: Tatiana Nikitina (CERN), 27 October 2008
0037 // ---------------------------------------------------------------------------
0038 #ifndef G4MULTILEVELLOCATOR_HH
0039 #define G4MULTILEVELLOCATOR_HH 1
0040
0041 #include "G4VIntersectionLocator.hh"
0042
0043 /**
0044  * @brief G4MultiLevelLocator implements the calculation of the intersection
0045  * point with a boundary when G4PropagationInField is used. Derived from method
0046  * LocateIntersectionPoint() from G4PropagatorInField, it is based on a linear
0047  * method for finding the intersection point by means of a 'depth' algorithm
0048  * in case of slow progress (intersection is not found after 100 trials).
0049  */
0050
0051 class G4MultiLevelLocator : public G4VIntersectionLocator
0052 {
0053   public:
0054
0055     /**
0056      * Constructor and Destructor.
0057      */
0058     G4MultiLevelLocator(G4Navigator *theNavigator);
0059     ~G4MultiLevelLocator() override;
0060
0061     /**
0062      * If such an intersection exists, this method calculates the intersection
0063      * point of the true path of the particle with the surface of the current
0064      * volume (or of one of its daughters).
0065      * Should use lateral displacement as measure of convergence.
0066      *  @param[in] curveStartPointTangent Start point tangent track.
0067      *  @param[in] curveEndPointTangent End point tangent track.
0068      *  @param[in] trialPoint Trial point.
0069      *  @param[out] intersectPointTangent Intersection point tangent track.
0070      *  @param[out] recalculatedEndPoint Flagging if end point was recomputed.
0071      *  @param[in,out] fPreviousSafety Previous safety distance.
0072      *  @param[in,out] fPreviousSftOrigin Previous safety point origin.
0073      *  @returns Whether intersection exists or not.
0074      */
0075     G4bool EstimateIntersectionPoint(
0076         const  G4FieldTrack&       curveStartPointTangent,           // A
0077         const  G4FieldTrack&       curveEndPointTangent,             // B
0078         const  G4ThreeVector&      trialPoint,                       // E
0079                G4FieldTrack&       intersectPointTangent,            // Output
0080                G4bool&             recalculatedEndPoint,             // Out
0081                G4double&           fPreviousSafety,                  // In/Out
0082                G4ThreeVector&      fPreviousSftOrigin) override;     // In/Out
0083
0084     /**
0085      * Dumps statistics.
0086      */
0087     void ReportStatistics();
0088
0089     /**
0090      * Setters.
0091      */
0092     inline void SetMaxSteps(unsigned int valMax) { fMaxSteps = valMax; }
0093     inline void SetWarnSteps(unsigned int valWarn) { fWarnSteps = valWarn; }
0094
0095   private:
0096
0097     void ReportFieldValue( const G4FieldTrack& locationPV,
0098                            const char* nameLoc,
0099                            const G4EquationOfMotion* equation );
0100
0101     // Invariants -- parameters
0102     // ====================================
0103     static const G4int max_depth = 10;
0104     unsigned int fMaxSteps = 10000; // Effort abandoned; signal is looping
0105     unsigned int fWarnSteps = 1000; // Warn about many steps (but succeeded)
0106
0107     // State - varies during simulation
0108     // ====================================
0109     G4FieldTrack* ptrInterMedFT[max_depth+1];  // Used to store intermediate
0110                                                // tracks values in case of too
0111                                                // slow progress
0112     // Counters for statistics & debugging
0113     // ====================================
0114     unsigned long int fNumCalls = 0;
0115     unsigned long int fNumAdvanceFull = 0,
0116                       fNumAdvanceGood = 0,
0117                       fNumAdvanceTrials = 0;
0118 };
0119
0120 #endif