include/Geant4/G4BrentLocator.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 G4BrentLocator
0027 //
0028 // class description:
0029 //
0030 // Implementing the calculation of the intersection point with a boundary when
0031 // PropagationInField is used. Second order locator based on Brent Method
0032 // for finding the intersection point by means of a 'depth' algorithm in case
0033 // of slow progress (intersection is not found after 100 trials).
0034
0035 // History:
0036 // -------
0037 // 27.10.08 - Tatiana Nikitina: First implementation using
0038 //                              LocateIntersectionPoint() from
0039 //                              G4PropagatorInField class
0040 // ---------------------------------------------------------------------------
0041
0042 #ifndef G4BRENTLOCATOR_HH
0043 #define G4BRENTLOCATOR_HH
0044
0045 #include "G4VIntersectionLocator.hh"
0046
0047 class G4BrentLocator : public G4VIntersectionLocator
0048 {
0049   public:  // with description
0050
0051     G4BrentLocator(G4Navigator *theNavigator);
0052       // Constructor
0053     ~G4BrentLocator() 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   private:
0070
0071     static const G4int max_depth = 4;
0072     G4FieldTrack* ptrInterMedFT[max_depth+1];
0073       // Used to store intermediate tracks values in case of too slow progress
0074 };
0075
0076 #endif