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