Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/geometry/magneticfield/include/G4BFieldIntegrationDriver.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

Diff markup

Differences between /geometry/magneticfield/include/G4BFieldIntegrationDriver.hh (Version 11.3.0) and /geometry/magneticfield/include/G4BFieldIntegrationDriver.hh (Version 11.1)


  1 //                                                  1 //
  2 // *******************************************      2 // ********************************************************************
  3 // * License and Disclaimer                         3 // * License and Disclaimer                                           *
  4 // *                                                4 // *                                                                  *
  5 // * The  Geant4 software  is  copyright of th      5 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
  6 // * the Geant4 Collaboration.  It is provided      6 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
  7 // * conditions of the Geant4 Software License      7 // * conditions of the Geant4 Software License,  included in the file *
  8 // * LICENSE and available at  http://cern.ch/      8 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
  9 // * include a list of copyright holders.           9 // * include a list of copyright holders.                             *
 10 // *                                               10 // *                                                                  *
 11 // * Neither the authors of this software syst     11 // * Neither the authors of this software system, nor their employing *
 12 // * institutes,nor the agencies providing fin     12 // * institutes,nor the agencies providing financial support for this *
 13 // * work  make  any representation or  warran     13 // * work  make  any representation or  warranty, express or implied, *
 14 // * regarding  this  software system or assum     14 // * regarding  this  software system or assume any liability for its *
 15 // * use.  Please see the license in the file      15 // * use.  Please see the license in the file  LICENSE  and URL above *
 16 // * for the full disclaimer and the limitatio     16 // * for the full disclaimer and the limitation of liability.         *
 17 // *                                               17 // *                                                                  *
 18 // * This  code  implementation is the result      18 // * This  code  implementation is the result of  the  scientific and *
 19 // * technical work of the GEANT4 collaboratio     19 // * technical work of the GEANT4 collaboration.                      *
 20 // * By using,  copying,  modifying or  distri     20 // * By using,  copying,  modifying or  distributing the software (or *
 21 // * any work based  on the software)  you  ag     21 // * any work based  on the software)  you  agree  to acknowledge its *
 22 // * use  in  resulting  scientific  publicati     22 // * use  in  resulting  scientific  publications,  and indicate your *
 23 // * acceptance of all terms of the Geant4 Sof     23 // * acceptance of all terms of the Geant4 Software license.          *
 24 // *******************************************     24 // ********************************************************************
 25 //                                                 25 //
 26 // G4BFieldIntegrationDriver                       26 // G4BFieldIntegrationDriver
 27 //                                                 27 //
 28 // Class description:                              28 // Class description:
 29 //                                                 29 //
 30 // Specialized integration driver for pure mag     30 // Specialized integration driver for pure magnetic field
 31                                                    31 
 32 // Author: D.Sorokin                               32 // Author: D.Sorokin
 33 // -------------------------------------------     33 // --------------------------------------------------------------------
 34 #ifndef G4BFIELD_INTEGRATION_DRIVER_HH             34 #ifndef G4BFIELD_INTEGRATION_DRIVER_HH
 35 #define G4BFIELD_INTEGRATION_DRIVER_HH             35 #define G4BFIELD_INTEGRATION_DRIVER_HH
 36                                                    36 
 37 #include "G4VIntegrationDriver.hh"                 37 #include "G4VIntegrationDriver.hh"
 38 #include "G4Mag_EqRhs.hh"                          38 #include "G4Mag_EqRhs.hh"
 39                                                    39 
 40 #include <memory>                                  40 #include <memory>
 41                                                    41 
 42 class G4BFieldIntegrationDriver : public G4VIn     42 class G4BFieldIntegrationDriver : public G4VIntegrationDriver
 43 {                                                  43 {
 44   public:                                          44   public:
 45                                                    45 
 46     G4BFieldIntegrationDriver(                     46     G4BFieldIntegrationDriver(
 47         std::unique_ptr<G4VIntegrationDriver>      47         std::unique_ptr<G4VIntegrationDriver> smallStepDriver, 
 48         std::unique_ptr<G4VIntegrationDriver>      48         std::unique_ptr<G4VIntegrationDriver> largeStepDriver);
 49                                                    49 
 50     G4BFieldIntegrationDriver(const G4BFieldIn     50     G4BFieldIntegrationDriver(const G4BFieldIntegrationDriver &) = delete;
 51     const G4BFieldIntegrationDriver& operator      51     const G4BFieldIntegrationDriver& operator =(const G4BFieldIntegrationDriver &) = delete;
 52                                                    52 
 53     G4double AdvanceChordLimited(G4FieldTrack& <<  53     virtual G4double AdvanceChordLimited(G4FieldTrack& track,
 54                                  G4double hste <<  54                                          G4double hstep,
 55                                  G4double eps, <<  55                                          G4double eps,
 56                                  G4double chor <<  56                                          G4double chordDistance) override;
 57                                                    57 
 58     G4bool AccurateAdvance(G4FieldTrack& track <<  58     virtual G4bool AccurateAdvance(G4FieldTrack& track,
 59                            G4double hstep,     <<  59                                    G4double hstep,
 60                            G4double eps,       <<  60                                    G4double eps,
 61                            G4double hinitial = <<  61                                    G4double hinitial = 0) override
 62     {                                              62     {
 63       return fCurrDriver->AccurateAdvance(trac <<  63         return fCurrDriver->AccurateAdvance(track, hstep, eps, hinitial);
 64     }                                              64     }
 65                                                    65 
 66     G4bool DoesReIntegrate() const override    <<  66     virtual G4bool DoesReIntegrate() const override
 67     {                                              67     {
 68       return fCurrDriver->DoesReIntegrate();   <<  68        return fCurrDriver->DoesReIntegrate();
 69     }                                              69     }
 70                                                    70    
 71     //[[deprecated("will be removed")]]            71     //[[deprecated("will be removed")]]
 72     void GetDerivatives(const G4FieldTrack& tr <<  72     virtual void GetDerivatives(const G4FieldTrack& track,
 73                               G4double dydx[]) <<  73                                 G4double dydx[]) const override
 74     {                                              74     {
 75       fCurrDriver->GetDerivatives(track, dydx) <<  75         fCurrDriver->GetDerivatives(track, dydx);
 76     }                                              76     }
 77                                                    77 
 78     //[[deprecated("will be removed")]]            78     //[[deprecated("will be removed")]]
 79     void GetDerivatives(const G4FieldTrack& tr <<  79     virtual void GetDerivatives(const G4FieldTrack& track,
 80                               G4double dydx[], <<  80                                 G4double dydx[],
 81                               G4double field[] <<  81                                 G4double field[]) const override
 82     {                                              82     {
 83       fCurrDriver->GetDerivatives(track, dydx, <<  83         fCurrDriver->GetDerivatives(track, dydx, field);
 84     }                                              84     }
 85                                                    85 
 86     void SetEquationOfMotion(G4EquationOfMotio <<  86     virtual void SetEquationOfMotion(G4EquationOfMotion* equation) override;
 87                                                    87 
 88     G4EquationOfMotion* GetEquationOfMotion()  <<  88     virtual G4EquationOfMotion* GetEquationOfMotion() override
 89     {                                              89     {
 90       return fCurrDriver->GetEquationOfMotion( <<  90         return fCurrDriver->GetEquationOfMotion();
 91     }                                              91     }
 92                                                    92 
 93     //[[deprecated("use GetEquationOfMotion()      93     //[[deprecated("use GetEquationOfMotion() instead of GetStepper()->GetEquationOfMotion()")]]
 94     const G4MagIntegratorStepper* GetStepper() <<  94     virtual const G4MagIntegratorStepper* GetStepper() const override
 95     {                                              95     {
 96       return fCurrDriver->GetStepper();        <<  96         return fCurrDriver->GetStepper();
 97     }                                              97     }
 98                                                    98 
 99     G4MagIntegratorStepper* GetStepper() overr <<  99     virtual G4MagIntegratorStepper* GetStepper() override
100     {                                             100     {
101       return fCurrDriver->GetStepper();        << 101         return fCurrDriver->GetStepper();
102     }                                             102     }
103                                                   103 
104     G4double ComputeNewStepSize(G4double errMa << 104     virtual G4double ComputeNewStepSize(G4double errMaxNorm,
105                                 G4double hstep << 105                                         G4double hstepCurrent) override
106     {                                             106     {
107       return fCurrDriver->ComputeNewStepSize(e << 107         return fCurrDriver->ComputeNewStepSize(errMaxNorm, hstepCurrent);
108     }                                             108     }
109                                                   109 
110     void SetVerboseLevel(G4int level) override << 110     virtual void SetVerboseLevel(G4int level) override
111     {                                             111     {
112       fSmallStepDriver->SetVerboseLevel(level) << 112         fSmallStepDriver->SetVerboseLevel(level);
113       fLargeStepDriver->SetVerboseLevel(level) << 113         fLargeStepDriver->SetVerboseLevel(level);
114     }                                             114     }
115                                                   115 
116     G4int GetVerboseLevel() const override     << 116     virtual G4int GetVerboseLevel() const override
117     {                                             117     {
118       return fCurrDriver->GetVerboseLevel();   << 118         return fCurrDriver->GetVerboseLevel();
119     }                                             119     }
120                                                   120 
121     void OnComputeStep(const G4FieldTrack* tra << 121     virtual void OnComputeStep() override
122     {                                             122     {
123       fSmallStepDriver->OnComputeStep(track);  << 123         fSmallStepDriver->OnComputeStep();
124       fLargeStepDriver->OnComputeStep(track);  << 124         fLargeStepDriver->OnComputeStep();
125     }                                             125     }
126                                                   126 
127     void OnStartTracking() override            << 127     virtual void OnStartTracking() override
128     {                                             128     {
129       fSmallStepDriver->OnStartTracking();     << 129         fSmallStepDriver->OnStartTracking();
130       fLargeStepDriver->OnStartTracking();     << 130         fLargeStepDriver->OnStartTracking();
131     }                                             131     }
132                                                   132 
133     void  StreamInfo( std::ostream& os ) const << 133     virtual void  StreamInfo( std::ostream& os ) const override
134     {                                             134     {
135       os << "Small Step Driver Info: " << std: << 135        os << "Small Step Driver Info: " << std::endl;
136       fSmallStepDriver->StreamInfo(os);        << 136        fSmallStepDriver->StreamInfo(os);
137       os << "Large Step Driver Info: " << std: << 137        os << "Large Step Driver Info: " << std::endl;        
138       fLargeStepDriver->StreamInfo(os);        << 138        fLargeStepDriver->StreamInfo(os);
139     }                                             139     }
140     // Write out the parameters / state of the    140     // Write out the parameters / state of the driver
141                                                   141    
142     void PrintStatistics() const;                 142     void PrintStatistics() const;
143                                                   143 
144   private:                                        144   private:
145                                                   145 
146     G4double CurvatureRadius(const G4FieldTrac    146     G4double CurvatureRadius(const G4FieldTrack& track) const;
147                                                   147 
148     void GetFieldValue(const G4FieldTrack& tra    148     void GetFieldValue(const G4FieldTrack& track, 
149                              G4double      Fie    149                              G4double      Field[] ) const;
150                                                   150    
151     std::unique_ptr<G4VIntegrationDriver> fSma    151     std::unique_ptr<G4VIntegrationDriver> fSmallStepDriver;
152     std::unique_ptr<G4VIntegrationDriver> fLar    152     std::unique_ptr<G4VIntegrationDriver> fLargeStepDriver;
153     G4VIntegrationDriver* fCurrDriver = nullpt    153     G4VIntegrationDriver* fCurrDriver = nullptr;
154     G4Mag_EqRhs* fEquation = nullptr;             154     G4Mag_EqRhs* fEquation = nullptr;
155                                                   155 
156     G4int fSmallDriverSteps = 0;                  156     G4int fSmallDriverSteps = 0;
157     G4int fLargeDriverSteps = 0;                  157     G4int fLargeDriverSteps = 0;
158 };                                                158 };
159                                                   159 
160 #endif                                            160 #endif
161                                                   161