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
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 class G4VExternalNavigation : public G4VNavigation
0046 {
0047   public:  // with description
0048
0049     G4VExternalNavigation();
0050       // Constructor
0051
0052     virtual ~G4VExternalNavigation();
0053       // Destructor
0054
0055     virtual G4VExternalNavigation* Clone() = 0;
0056
0057     // Optional methods - may be necessary under particular circumstances
0058
0059     virtual EInside Inside( const G4VSolid*      solid,
0060                             const G4ThreeVector& position,
0061                             const G4ThreeVector& direction );
0062      // Special 'Inside' call that includes direction of next motion
0063      //   provided for potential optimisations.
0064
0065     virtual void RelocateWithinVolume( G4VPhysicalVolume*  motherPhysical,
0066                                        const G4ThreeVector& localPoint );
0067      //   Update any relevant internal state to take account that
0068      //      - the location has been moved to 'localPoint'
0069      //      - it remains in the current (mother) physical volume 'motherPhysical'
0070 };
0071
0072 #endif