| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer << 3 // * DISCLAIMER *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th << 5 // * The following disclaimer summarizes all the specific disclaimers *
6 // * the Geant4 Collaboration. It is provided << 6 // * of contributors to this software. The specific disclaimers,which *
7 // * conditions of the Geant4 Software License << 7 // * govern, are listed with their locations in: *
8 // * LICENSE and available at http://cern.ch/ << 8 // * http://cern.ch/geant4/license *
9 // * include a list of copyright holders. <<
10 // * 9 // * *
11 // * Neither the authors of this software syst 10 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 11 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 12 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 13 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file << 14 // * use. *
16 // * for the full disclaimer and the limitatio <<
17 // * 15 // * *
18 // * This code implementation is the result << 16 // * This code implementation is the intellectual property of the *
19 // * technical work of the GEANT4 collaboratio << 17 // * GEANT4 collaboration. *
20 // * By using, copying, modifying or distri << 18 // * By copying, distributing or modifying the Program (or any work *
21 // * any work based on the software) you ag << 19 // * based on the Program) you indicate your acceptance of this *
22 // * use in resulting scientific publicati << 20 // * statement, and all its terms. *
23 // * acceptance of all terms of the Geant4 Sof <<
24 // ******************************************* 21 // ********************************************************************
25 // 22 //
26 // G4Field << 23 //
>> 24 // $Id: G4Field.hh,v 1.9 2004/09/01 09:59:06 japost Exp $
>> 25 // GEANT4 tag $Name: geant4-07-00-cand-03 $
>> 26 //
>> 27 //
>> 28 // class G4Field
27 // 29 //
28 // Class description: 30 // Class description:
29 // 31 //
30 // Abstract class for any kind of Field. 32 // Abstract class for any kind of Field.
31 // It allows any kind of field (vector, scalar 33 // It allows any kind of field (vector, scalar, tensor and any set of them)
32 // to be defined by implementing the inquiry f 34 // to be defined by implementing the inquiry function interface.
33 // 35 //
34 // The key method is GetFieldValue( const do 36 // The key method is GetFieldValue( const double Point[4],
35 // ************* do 37 // ************* double *fieldArr )
36 // Given an input position/time vector 'Point' 38 // Given an input position/time vector 'Point',
37 // this method must return the value of the fi 39 // this method must return the value of the field in "fieldArr".
38 // 40 //
39 // A field must also specify whether it change 41 // A field must also specify whether it changes a track's energy:
40 // DoesFieldChangeEnergy() 42 // DoesFieldChangeEnergy()
41 // ********************* 43 // *********************
42 // A field must co-work with a corresponding E 44 // A field must co-work with a corresponding Equation of Motion, to
43 // enable the integration of a particle's posi 45 // enable the integration of a particle's position, momentum and, optionally,
44 // spin. For this a field and its equation of 46 // spin. For this a field and its equation of motion must follow the
45 // same convention for the order of field comp 47 // same convention for the order of field components in the array "fieldArr"
46 <<
47 // Created: John Apostolakis, 10.03.1997 <<
48 // ------------------------------------------- 48 // -------------------------------------------------------------------
>> 49 // History:
>> 50 // - Created: John Apostolakis, 10.03.1997
>> 51 // - Modified:
>> 52 // V. Grichine 8 Nov 2001: Extended "Point" arg to [4] array to add time
>> 53 // J. Apostolakis 5 Nov 2003: Added virtual method DoesFieldChangeEnergy()
>> 54 // J. Apostolakis 31 Aug 2004: Information on convention for components
>> 55 // -------------------------------------------------------------------
>> 56
49 #ifndef G4FIELD_HH 57 #ifndef G4FIELD_HH
50 #define G4FIELD_HH 58 #define G4FIELD_HH
51 59
52 #include "G4Types.hh" 60 #include "G4Types.hh"
53 #include "globals.hh" <<
54 61
55 class G4Field 62 class G4Field
56 { 63 {
57 public: // with description 64 public: // with description
58 65
59 G4Field( G4bool gravityOn = false); << 66 virtual void GetFieldValue( const double Point[4],
60 G4Field( const G4Field& ); << 67 double *fieldArr ) const = 0;
61 virtual ~G4Field(); <<
62 G4Field& operator = (const G4Field& p); <<
63 <<
64 virtual void GetFieldValue( const G4doub <<
65 G4doub <<
66 // Given the position time vector 'Poin 68 // Given the position time vector 'Point',
67 // return the value of the field in the 69 // return the value of the field in the array fieldArr.
68 // Notes: 70 // Notes:
69 // 1) The 'Point' vector has the foll 71 // 1) The 'Point' vector has the following structure:
70 // Point[0] is x ( position, 72 // Point[0] is x ( position, in Geant4 units )
71 // Point[1] is y 73 // Point[1] is y
72 // Point[2] is z 74 // Point[2] is z
73 // Point[3] is t ( time, in 75 // Point[3] is t ( time, in Geant4 units )
74 // 2) The convention for the componen 76 // 2) The convention for the components of the field
75 // array 'fieldArr' are determined 77 // array 'fieldArr' are determined by the type of field.
76 // See for example the class G4Ele 78 // See for example the class G4ElectroMagneticField.
77 79
78 virtual G4bool DoesFieldChangeEnergy() c << 80 G4Field(){;}
79 // Each type/class of field should res << 81 virtual ~G4Field(){;}
80 // For example: << 82 inline G4Field& operator = (const G4Field &p);
81 // - an electric field should re << 83
82 // - a pure magnetic field should re << 84 // A field signature function that can be used to insure
83 << 85 // that the Equation of motion object and the G4Field object
84 inline G4bool IsGravityActive() const; << 86 // have the same "field signature"?
85 // Does this field include gravity? << 87
86 << 88 virtual G4bool DoesFieldChangeEnergy() const= 0 ;
87 inline void SetGravityActive( G4bool OnO << 89 // Each type/class of field should respond this accordingly
88 << 90 // For example:
89 virtual G4Field* Clone() const; << 91 // - an electric field should return "true"
90 // Implements cloning, needed by multi << 92 // - a pure magnetic field should return "false"
91 <<
92 static constexpr G4int MAX_NUMBER_OF_COM <<
93 <<
94 private: <<
95 93
96 G4bool fGravityActive = false; <<
97 }; 94 };
98 95
99 // Inline methods ... << 96 inline G4Field& G4Field::operator = (const G4Field &p)
100 <<
101 inline G4bool G4Field::IsGravityActive() const <<
102 { 97 {
103 return fGravityActive; << 98 if (&p != this) { *this = p; }
>> 99 return *this;
104 } 100 }
105 101
106 inline void G4Field::SetGravityActive( G4bool << 102 #endif /* G4FIELD_HH */
107 { <<
108 fGravityActive = OnOffFlag; <<
109 } <<
110 <<
111 #endif <<
112 103