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