| 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 // G4BFieldIntegrationDriver
27 //
28 // Class description:
29 //
30 // Specialized integration driver for pure magnetic field
31
32 // Author: D.Sorokin
33 // --------------------------------------------------------------------
34 #ifndef G4BFIELD_INTEGRATION_DRIVER_HH
35 #define G4BFIELD_INTEGRATION_DRIVER_HH
36
37 #include "G4VIntegrationDriver.hh"
38 #include "G4Mag_EqRhs.hh"
39
40 #include <memory>
41
42 class G4BFieldIntegrationDriver : public G4VIntegrationDriver
43 {
44 public:
45
46 G4BFieldIntegrationDriver(
47 std::unique_ptr<G4VIntegrationDriver> smallStepDriver,
48 std::unique_ptr<G4VIntegrationDriver> largeStepDriver);
49
50 G4BFieldIntegrationDriver(const G4BFieldIntegrationDriver &) = delete;
51 const G4BFieldIntegrationDriver& operator =(const G4BFieldIntegrationDriver &) = delete;
52
53 G4double AdvanceChordLimited(G4FieldTrack& track,
54 G4double hstep,
55 G4double eps,
56 G4double chordDistance) override;
57
58 G4bool AccurateAdvance(G4FieldTrack& track,
59 G4double hstep,
60 G4double eps,
61 G4double hinitial = 0) override
62 {
63 return fCurrDriver->AccurateAdvance(track, hstep, eps, hinitial);
64 }
65
66 G4bool DoesReIntegrate() const override
67 {
68 return fCurrDriver->DoesReIntegrate();
69 }
70
71 //[[deprecated("will be removed")]]
72 void GetDerivatives(const G4FieldTrack& track,
73 G4double dydx[]) const override
74 {
75 fCurrDriver->GetDerivatives(track, dydx);
76 }
77
78 //[[deprecated("will be removed")]]
79 void GetDerivatives(const G4FieldTrack& track,
80 G4double dydx[],
81 G4double field[]) const override
82 {
83 fCurrDriver->GetDerivatives(track, dydx, field);
84 }
85
86 void SetEquationOfMotion(G4EquationOfMotion* equation) override;
87
88 G4EquationOfMotion* GetEquationOfMotion() override
89 {
90 return fCurrDriver->GetEquationOfMotion();
91 }
92
93 //[[deprecated("use GetEquationOfMotion() instead of GetStepper()->GetEquationOfMotion()")]]
94 const G4MagIntegratorStepper* GetStepper() const override
95 {
96 return fCurrDriver->GetStepper();
97 }
98
99 G4MagIntegratorStepper* GetStepper() override
100 {
101 return fCurrDriver->GetStepper();
102 }
103
104 G4double ComputeNewStepSize(G4double errMaxNorm,
105 G4double hstepCurrent) override
106 {
107 return fCurrDriver->ComputeNewStepSize(errMaxNorm, hstepCurrent);
108 }
109
110 void SetVerboseLevel(G4int level) override
111 {
112 fSmallStepDriver->SetVerboseLevel(level);
113 fLargeStepDriver->SetVerboseLevel(level);
114 }
115
116 G4int GetVerboseLevel() const override
117 {
118 return fCurrDriver->GetVerboseLevel();
119 }
120
121 void OnComputeStep(const G4FieldTrack* track) override
122 {
123 fSmallStepDriver->OnComputeStep(track);
124 fLargeStepDriver->OnComputeStep(track);
125 }
126
127 void OnStartTracking() override
128 {
129 fSmallStepDriver->OnStartTracking();
130 fLargeStepDriver->OnStartTracking();
131 }
132
133 void StreamInfo( std::ostream& os ) const override
134 {
135 os << "Small Step Driver Info: " << std::endl;
136 fSmallStepDriver->StreamInfo(os);
137 os << "Large Step Driver Info: " << std::endl;
138 fLargeStepDriver->StreamInfo(os);
139 }
140 // Write out the parameters / state of the driver
141
142 void PrintStatistics() const;
143
144 private:
145
146 G4double CurvatureRadius(const G4FieldTrack& track) const;
147
148 void GetFieldValue(const G4FieldTrack& track,
149 G4double Field[] ) const;
150
151 std::unique_ptr<G4VIntegrationDriver> fSmallStepDriver;
152 std::unique_ptr<G4VIntegrationDriver> fLargeStepDriver;
153 G4VIntegrationDriver* fCurrDriver = nullptr;
154 G4Mag_EqRhs* fEquation = nullptr;
155
156 G4int fSmallDriverSteps = 0;
157 G4int fLargeDriverSteps = 0;
158 };
159
160 #endif
161