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 10.5)


  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 //
                                                   >>  27 //
                                                   >>  28 //
                                                   >>  29 // class G4BFieldIntegrationDriver
 27 //                                                 30 //
 28 // Class description:                              31 // Class description:
 29 //                                                 32 //
 30 // Specialized integration driver for pure mag     33 // Specialized integration driver for pure magnetic field
 31                                                    34 
 32 // Author: D.Sorokin                           <<  35 // History:
                                                   >>  36 // - Created. D.Sorokin
 33 // -------------------------------------------     37 // --------------------------------------------------------------------
 34 #ifndef G4BFIELD_INTEGRATION_DRIVER_HH         << 
 35 #define G4BFIELD_INTEGRATION_DRIVER_HH         << 
 36                                                    38 
 37 #include "G4VIntegrationDriver.hh"             <<  39 #ifndef G4BFieldIntegrationDriver_HH
 38 #include "G4Mag_EqRhs.hh"                      <<  40 #define G4BFieldIntegrationDriver_HH
 39                                                    41 
 40 #include <memory>                              <<  42 #include "G4IntegrationDriver.hh"
                                                   >>  43 #include "G4HelixExplicitEuler.hh"
 41                                                    44 
 42 class G4BFieldIntegrationDriver : public G4VIn <<  45 template <class T>
 43 {                                              <<  46 class G4BFieldIntegrationDriver : public G4IntegrationDriver<T> {
 44   public:                                      <<  47 public:
 45                                                <<  48     G4BFieldIntegrationDriver(  G4double hminimum,
 46     G4BFieldIntegrationDriver(                 <<  49                                 T*       stepper,
 47         std::unique_ptr<G4VIntegrationDriver>  <<  50                                 G4int    numberOfComponents = 6,
 48         std::unique_ptr<G4VIntegrationDriver>  <<  51                                 G4int    statisticsVerbosity = 1);
 49                                                    52 
 50     G4BFieldIntegrationDriver(const G4BFieldIn     53     G4BFieldIntegrationDriver(const G4BFieldIntegrationDriver &) = delete;
 51     const G4BFieldIntegrationDriver& operator      54     const G4BFieldIntegrationDriver& operator =(const G4BFieldIntegrationDriver &) = delete;
 52                                                    55 
 53     G4double AdvanceChordLimited(G4FieldTrack& <<  56     virtual G4bool QuickAdvance(
 54                                  G4double hste <<  57         G4FieldTrack& fieldTrack,
 55                                  G4double eps, <<  58         const G4double dydx[],
 56                                  G4double chor <<  59         G4double hstep,
 57                                                <<  60         G4double inverseCurvatureRadius,
 58     G4bool AccurateAdvance(G4FieldTrack& track <<  61         G4double& dchord_step,
 59                            G4double hstep,     <<  62         G4double& dyerr) override;
 60                            G4double eps,       <<  63 
 61                            G4double hinitial = <<  64     virtual void SetEquationOfMotion(G4EquationOfMotion* equation) override;
 62     {                                          <<  65 
 63       return fCurrDriver->AccurateAdvance(trac <<  66     virtual G4double GetInverseCurvatureRadius(const G4FieldTrack& track,
 64     }                                          <<  67                                                G4double field[]) const override;
 65                                                <<  68 
 66     G4bool DoesReIntegrate() const override    <<  69 private:
 67     {                                          <<  70     G4double fallbackThreshold;
 68       return fCurrDriver->DoesReIntegrate();   <<  71     G4Mag_EqRhs* fequation;
 69     }                                          <<  72     G4HelixExplicitEuler fallbackStepper;
 70                                                << 
 71     //[[deprecated("will be removed")]]        << 
 72     void GetDerivatives(const G4FieldTrack& tr << 
 73                               G4double dydx[]) << 
 74     {                                          << 
 75       fCurrDriver->GetDerivatives(track, dydx) << 
 76     }                                          << 
 77                                                << 
 78     //[[deprecated("will be removed")]]        << 
 79     void GetDerivatives(const G4FieldTrack& tr << 
 80                               G4double dydx[], << 
 81                               G4double field[] << 
 82     {                                          << 
 83       fCurrDriver->GetDerivatives(track, dydx, << 
 84     }                                          << 
 85                                                << 
 86     void SetEquationOfMotion(G4EquationOfMotio << 
 87                                                << 
 88     G4EquationOfMotion* GetEquationOfMotion()  << 
 89     {                                          << 
 90       return fCurrDriver->GetEquationOfMotion( << 
 91     }                                          << 
 92                                                << 
 93     //[[deprecated("use GetEquationOfMotion()  << 
 94     const G4MagIntegratorStepper* GetStepper() << 
 95     {                                          << 
 96       return fCurrDriver->GetStepper();        << 
 97     }                                          << 
 98                                                << 
 99     G4MagIntegratorStepper* GetStepper() overr << 
100     {                                          << 
101       return fCurrDriver->GetStepper();        << 
102     }                                          << 
103                                                << 
104     G4double ComputeNewStepSize(G4double errMa << 
105                                 G4double hstep << 
106     {                                          << 
107       return fCurrDriver->ComputeNewStepSize(e << 
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* tra << 
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 << 
134     {                                          << 
135       os << "Small Step Driver Info: " << std: << 
136       fSmallStepDriver->StreamInfo(os);        << 
137       os << "Large Step Driver Info: " << std: << 
138       fLargeStepDriver->StreamInfo(os);        << 
139     }                                          << 
140     // Write out the parameters / state of the << 
141                                                << 
142     void PrintStatistics() const;              << 
143                                                << 
144   private:                                     << 
145                                                << 
146     G4double CurvatureRadius(const G4FieldTrac << 
147                                                << 
148     void GetFieldValue(const G4FieldTrack& tra << 
149                              G4double      Fie << 
150                                                << 
151     std::unique_ptr<G4VIntegrationDriver> fSma << 
152     std::unique_ptr<G4VIntegrationDriver> fLar << 
153     G4VIntegrationDriver* fCurrDriver = nullpt << 
154     G4Mag_EqRhs* fEquation = nullptr;          << 
155                                                << 
156     G4int fSmallDriverSteps = 0;               << 
157     G4int fLargeDriverSteps = 0;               << 
158 };                                                 73 };
                                                   >>  74 
                                                   >>  75 #include "G4BFieldIntegrationDriver.icc"
159                                                    76 
160 #endif                                             77 #endif
161                                                    78