Geant4  10.00.p01
G4EquationOfMotion.hh
Go to the documentation of this file.
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 //
27 // $Id: G4EquationOfMotion.hh 71664 2013-06-20 08:36:05Z gcosmo $
28 //
29 //
30 // class G4EquationOfMotion
31 //
32 // Class description:
33 //
34 // Abstract Base Class for the right hand size of the equation of
35 // motion of a particle in a field.
36 
37 // History:
38 // - Created. J.Apostolakis
39 // -------------------------------------------------------------------
40 
41 #ifndef G4_EquationOfMotion_DEF
42 #define G4_EquationOfMotion_DEF
43 
44 #include "G4Types.hh" // "globals.hh"
45 #include "G4Field.hh" // required in inline method implementations
46 
47 #include "G4ChargeState.hh"
48 
50 {
51  public: // with description
52 
53  G4EquationOfMotion( G4Field *Field );
54  virtual ~G4EquationOfMotion();
55  // Constructor and virtual destructor. No operations.
56 
57  virtual void EvaluateRhsGivenB( const G4double y[],
58  const G4double B[3],
59  G4double dydx[] ) const = 0;
60  // Given the value of the field "B", this function
61  // calculates the value of the derivative dydx.
62  // --------------------------------------------------------
63  // This is the _only_ function a subclass must define.
64  // The other two functions use Rhs_givenB.
65 
66  virtual void SetChargeMomentumMass(G4ChargeState particleCharge,
67  G4double MomentumXc,
68  G4double MassXc2) = 0;
69  // Set the charge, momentum and mass of the current particle
70  // --> used to set the equation's coefficients ...
71 
72  inline
73  void RightHandSide( const G4double y[],
74  G4double dydx[] ) const;
75  // This calculates the value of the derivative dydx at y.
76  // It is the usual enquiry function.
77  // ---------------------------
78  // (It is not virtual, but calls the virtual function above.)
79 
80  void EvaluateRhsReturnB( const G4double y[],
81  G4double dydx[],
82  G4double Field[] ) const;
83  // Same as RHS above, but also returns the value of B.
84  // Should be made the new default ? after putting dydx & B in a class.
85 
86  void GetFieldValue( const G4double Point[4],
87  G4double Field[] ) const;
88  // Obtain only the field - the stepper assumes it is pure Magnetic.
89  // Not protected, because G4RKG3_Stepper uses it directly.
90 
91  const G4Field* GetFieldObj() const;
92  void SetFieldObj(G4Field* pField);
93 
94  private:
95  // const int G4maximum_number_of_field_components = 24;
97 
99 
100 };
101 
102 #include "G4EquationOfMotion.icc"
103 
104 #endif /* G4_EquationOfMotion_DEF */
void RightHandSide(const G4double y[], G4double dydx[]) const
virtual void SetChargeMomentumMass(G4ChargeState particleCharge, G4double MomentumXc, G4double MassXc2)=0
virtual void EvaluateRhsGivenB(const G4double y[], const G4double B[3], G4double dydx[]) const =0
G4EquationOfMotion(G4Field *Field)
void GetFieldValue(const G4double Point[4], G4double Field[]) const
void EvaluateRhsReturnB(const G4double y[], G4double dydx[], G4double Field[]) const
void SetFieldObj(G4Field *pField)
const G4Field * GetFieldObj() const
double G4double
Definition: G4Types.hh:76