| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 // TrackingManagerHelper
27 //
28 // Class description:
29 //
30 // Helper class for reducing the effort required to implement a custom tracking
31 // manager. It implements a stepping loop that calls user actions as the generic
32 // tracking and stepping managers do, and it implements navigation for charged
33 // particles in energy-preserving fields and for neutral particles.
34 //
35 // Original author: Jonas Hahnfeld, 2021
36
37 #ifndef TrackingManagerHelper_hh
38 #define TrackingManagerHelper_hh 1
39
40 #include "G4TrackVector.hh"
41 #include "globals.hh"
42
43 class G4Step;
44 class G4Track;
45
46 class TrackingManagerHelper
47 {
48 public:
49 class Physics
50 {
51 public:
52 virtual void StartTracking(G4Track*) {}
53 virtual void EndTracking() {}
54
55 // Combines AlongStep and PostStep; the implementation needs to remember
56 // the right value to pass as previousStepSize to G4VProcess.
57 virtual G4double GetPhysicalInteractionLength(const G4Track& track) = 0;
58
59 // This method is called for every step after navigation. The updated
60 // position is stored in the G4Step's post-step point. Any particle change
61 // should be applied directly to the step, UpdateTrack() will be called
62 // automatically after this method returns. If secondaries should be given
63 // back to the G4EventManager, put them into the container passed as the
64 // last argument.
65 virtual void AlongStepDoIt(G4Track& track, G4Step& step, G4TrackVector& secondaries) = 0;
66
67 // This method is called unless the track has been killed during this step.
68 // If secondaries should be given back to the G4EventManager, put them into
69 // the container passed as the last argument.
70 virtual void PostStepDoIt(G4Track& track, G4Step& step, G4TrackVector& secondaries) = 0;
71
72 virtual bool HasAtRestProcesses() { return false; }
73
74 // This method is called when a track is stopped, but still alive. If
75 // secondaries should be given back to the G4EventManager, put them into
76 // the container passed as the last argument.
77 virtual void AtRestDoIt(G4Track& track, G4Step& step, G4TrackVector& secondaries)
78 {
79 (void)track;
80 (void)step;
81 (void)secondaries;
82 }
83 };
84
85 class Navigation
86 {
87 public:
88 virtual G4double MakeStep(G4Track& track, G4Step& step, G4double physicalStep) = 0;
89
90 virtual void FinishStep(G4Track& track, G4Step& step) = 0;
91 };
92
93 template<typename PhysicsImpl, typename NavigationImpl>
94 static void TrackParticle(G4Track* aTrack, PhysicsImpl& physics, NavigationImpl& navigation);
95
96 template<typename PhysicsImpl>
97 static void TrackChargedParticle(G4Track* aTrack, PhysicsImpl& physics);
98
99 template<typename PhysicsImpl>
100 static void TrackNeutralParticle(G4Track* aTrack, PhysicsImpl& physics);
101 };
102
103 #include "TrackingManagerHelper.icc"
104
105 #endif
106