include/Geant4/G4SimpleLocator.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 // G4SimpleLocator
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; the difference compared to G4MultiLevelLocator is that
0034 // no 'depth' algorithm is used in case of slow progress for finding the
0035 // intersection point.
0036
0037 // Author: Tatiana Nikitina (CERN), 27 October 20008.
0038 // ---------------------------------------------------------------------------
0039 #ifndef G4SIMPLELOCATOR_HH
0040 #define G4SIMPLELOCATOR_HH 1
0041
0042 #include "G4VIntersectionLocator.hh"
0043
0044 /**
0045  * @brief G4SimpleLocator implements the calculation of the intersection point
0046  * with a boundary when G4PropagationInField is used. It is based on a linear
0047  * method for finding the intersection point; the difference compared to
0048  * G4MultiLevelLocator is that no 'depth' algorithm is used in case of slow
0049  * progress for finding the intersection point.
0050  */
0051
0052 class G4SimpleLocator : public G4VIntersectionLocator
0053 {
0054    public:
0055
0056     /**
0057      * Constructor and default Destructor.
0058      */
0059      G4SimpleLocator(G4Navigator* aNavigator);
0060      ~G4SimpleLocator() override;
0061
0062     /**
0063      * If such an intersection exists, this function calculates the
0064      * intersection point of the true path of the particle with the surface
0065      * of the current volume (or of one of its daughters).
0066      *  @note Should use lateral displacement as measure of convergence.
0067      *  @param[in] curveStartPointTangent Start point tangent track.
0068      *  @param[in] curveEndPointTangent End point tangent track.
0069      *  @param[in] trialPoint Trial point.
0070      *  @param[out] intersectPointTangent Intersection point tangent track.
0071      *  @param[out] recalculatedEndPoint Flagging if end point was recomputed.
0072      *  @param[in,out] fPreviousSafety Previous safety distance.
0073      *  @param[in,out] fPreviousSftOrigin Previous safety point origin.
0074      *  @returns Whether intersection exists or not.
0075      */
0076      G4bool EstimateIntersectionPoint(
0077          const  G4FieldTrack&       curveStartPointTangent,           // A
0078          const  G4FieldTrack&       curveEndPointTangent,             // B
0079          const  G4ThreeVector&      trialPoint,                       // E
0080                 G4FieldTrack&       intersectPointTangent,            // Output
0081             G4bool&             recalculatedEndPoint,             // Out
0082                 G4double&           fPreviousSafety,                  // In/Out
0083                 G4ThreeVector&      fPreviousSftOrigin) override;     // In/Out
0084 };
0085
0086 #endif