| 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 /// \file field/BlineTracer/include/G4BlineTracer.hh
27 /// \brief Definition of the G4BlineTracer class
28 //
29 //
30 //
31 //
32 // --------------------------------------------------------------------
33 //
34 // G4BlineTracer
35 //
36 // Class description:
37 //
38 // Defines a tool to trace and visualise magnetic field lines
39 // To use this tool in a Geant4 application the user should
40 // create an instance of this class in the code as a run action.
41 // It will only work if a G4MagneticField field object is declared.
42
43 // --------------------------------------------------------------------
44 // Author: Laurent Desorgher (desorgher@phim.unibe.ch)
45 // Created - 2003-10-06
46 // --------------------------------------------------------------------
47 #ifndef G4BlineTracer_h
48 #define G4BlineTracer_h 1
49
50 #include "CLHEP/Units/SystemOfUnits.h"
51
52 #include "G4Types.hh"
53 #include "G4UserRunAction.hh"
54
55 #include <vector>
56
57 class G4VUserPrimaryGeneratorAction;
58 class G4MagneticField;
59 class G4FieldManager;
60 class G4ChordFinder;
61
62 class G4BlineTracerMessenger;
63 class G4BlineSteppingAction;
64 class G4BlineEventAction;
65 class G4BlinePrimaryGeneratorAction;
66 class G4BlineEquation;
67
68 class G4BlineTracer : public G4UserRunAction
69 {
70 public: // with description
71 G4BlineTracer();
72 ~G4BlineTracer() override;
73
74 void BeginOfRunAction(const G4Run* aRun) override;
75 void EndOfRunAction(const G4Run* aRun) override;
76
77 void ComputeBlines(G4int nlines);
78
79 inline void SetMaxTrackingStep(G4double max_step) { fMaxTrackingStep = max_step; }
80 inline G4BlineEventAction* GetEventAction() { return fEventAction; }
81
82 private:
83 void ResetChordFinders();
84
85 private:
86 G4BlineTracerMessenger* fMessenger = nullptr;
87 G4BlineSteppingAction* fSteppingAction = nullptr;
88 G4BlineEventAction* fEventAction = nullptr;
89 G4BlinePrimaryGeneratorAction* fPrimaryGeneratorAction = nullptr;
90 G4double fMaxTrackingStep = 1000. * CLHEP::m;
91 G4bool fWas_ResetChordFinders_already_called = false;
92
93 // G4VUserPrimaryGeneratorAction* fUserPrimaryAction;
94 // User defined primary generator action
95
96 std::vector<G4ChordFinder*> fVecChordFinders;
97 std::vector<G4FieldManager*> fVecFieldManagers;
98 std::vector<G4MagneticField*> fVecMagneticFields;
99 std::vector<G4BlineEquation*> fVecEquationOfMotion;
100 // ChordFinders, detector fields, equation of motions, and field
101 // manager for the different local and global magnetic fields.
102 };
103
104 #endif
105