include/Geant4/G4VExternalNavigation.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 // G4VExternalNavigation
0027 //
0028 // Class description:
0029 //
0030 // Pure virtual class to be specialised by the user for tracking with
0031 // an external navigation
0032
0033 // Authors: V.Vlachoudis, G.Cosmo (CERN), 2019
0034 // --------------------------------------------------------------------
0035 #ifndef G4VEXTERNALNAVIGATION_HH
0036 #define G4VEXTERNALNAVIGATION_HH 1
0037
0038 #include "G4LogicalVolume.hh"
0039 #include "G4NavigationHistory.hh"
0040 #include "G4ThreeVector.hh"
0041 #include "G4VNavigation.hh"
0042 #include "G4VPhysicalVolume.hh"
0043 #include "G4VSolid.hh"
0044
0045 /**
0046  * @brief G4VExternalNavigation is a pure virtual class to be specialised
0047  * by the user for tracking with an external navigation.
0048  */
0049
0050 class G4VExternalNavigation : public G4VNavigation
0051 {
0052   public:
0053
0054     /**
0055      * Constructor and Destructor.
0056      */
0057     G4VExternalNavigation();
0058     ~G4VExternalNavigation() override;
0059
0060     /**
0061      * Cloning method, pure virtual.
0062      */
0063     virtual G4VExternalNavigation* Clone() = 0;
0064
0065     // Optional methods - may be necessary under particular circumstances
0066
0067     /**
0068      * Special 'Inside' call that includes direction of next motion.
0069      * Provided for potential optimisations.
0070      *  @param[in] solid Solid to be considered.
0071      *  @param[in] position Point to be checked.
0072      *  @param[in] direction Not used.
0073      *  @returns Whether the point is inside the solid or not.
0074      */
0075     virtual EInside Inside( const G4VSolid*      solid,
0076                             const G4ThreeVector& position,
0077                             const G4ThreeVector& direction );
0078
0079     /**
0080      * Updates any relevant internal state to take account that the location
0081      * has been moved to 'localPoint' and that it remains in the current
0082      * (mother) physical volume 'motherPhysical'.
0083      *  @note Default action is do-nothing; only implemented by the concrete
0084      *        navigator class.
0085      *  @param[in] motherPhysical Volume to be considered.
0086      *  @param[in] localPoint Point to be checked.
0087      */
0088      void RelocateWithinVolume( G4VPhysicalVolume* motherPhysical,
0089                                 const G4ThreeVector& localPoint ) override;
0090 };
0091
0092 #endif