| Geant4 Cross Reference |
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 // G4Field << 26 //
>> 27 // $Id: G4Field.hh 97486 2016-06-03 10:45:04Z gcosmo $
>> 28 //
>> 29 //
>> 30 // class G4Field
27 // 31 //
28 // Class description: 32 // Class description:
29 // 33 //
30 // Abstract class for any kind of Field. 34 // Abstract class for any kind of Field.
31 // It allows any kind of field (vector, scalar 35 // It allows any kind of field (vector, scalar, tensor and any set of them)
32 // to be defined by implementing the inquiry f 36 // to be defined by implementing the inquiry function interface.
33 // 37 //
34 // The key method is GetFieldValue( const do 38 // The key method is GetFieldValue( const double Point[4],
35 // ************* do 39 // ************* double *fieldArr )
36 // Given an input position/time vector 'Point' 40 // Given an input position/time vector 'Point',
37 // this method must return the value of the fi 41 // this method must return the value of the field in "fieldArr".
38 // 42 //
39 // A field must also specify whether it change 43 // A field must also specify whether it changes a track's energy:
40 // DoesFieldChangeEnergy() 44 // DoesFieldChangeEnergy()
41 // ********************* 45 // *********************
42 // A field must co-work with a corresponding E 46 // A field must co-work with a corresponding Equation of Motion, to
43 // enable the integration of a particle's posi 47 // enable the integration of a particle's position, momentum and, optionally,
44 // spin. For this a field and its equation of 48 // spin. For this a field and its equation of motion must follow the
45 // same convention for the order of field comp 49 // same convention for the order of field components in the array "fieldArr"
46 <<
47 // Created: John Apostolakis, 10.03.1997 <<
48 // ------------------------------------------- 50 // -------------------------------------------------------------------
>> 51 // History:
>> 52 // - Created: John Apostolakis, 10.03.1997
>> 53 // - Modified:
>> 54 // V. Grichine 8 Nov 2001: Extended "Point" arg to [4] array to add time
>> 55 // J. Apostolakis 5 Nov 2003: Added virtual method DoesFieldChangeEnergy()
>> 56 // J. Apostolakis 31 Aug 2004: Information on convention for components
>> 57 // -------------------------------------------------------------------
>> 58
49 #ifndef G4FIELD_HH 59 #ifndef G4FIELD_HH
50 #define G4FIELD_HH 60 #define G4FIELD_HH
51 61
52 #include "G4Types.hh" 62 #include "G4Types.hh"
53 #include "globals.hh" 63 #include "globals.hh"
54 64
55 class G4Field 65 class G4Field
56 { 66 {
57 public: // with description 67 public: // with description
58 68
59 G4Field( G4bool gravityOn = false); << 69 virtual void GetFieldValue( const double Point[4],
60 G4Field( const G4Field& ); << 70 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 71 // Given the position time vector 'Point',
67 // return the value of the field in the 72 // return the value of the field in the array fieldArr.
68 // Notes: 73 // Notes:
69 // 1) The 'Point' vector has the foll 74 // 1) The 'Point' vector has the following structure:
70 // Point[0] is x ( position, 75 // Point[0] is x ( position, in Geant4 units )
71 // Point[1] is y 76 // Point[1] is y
72 // Point[2] is z 77 // Point[2] is z
73 // Point[3] is t ( time, in 78 // Point[3] is t ( time, in Geant4 units )
74 // 2) The convention for the componen 79 // 2) The convention for the components of the field
75 // array 'fieldArr' are determined 80 // array 'fieldArr' are determined by the type of field.
76 // See for example the class G4Ele 81 // See for example the class G4ElectroMagneticField.
77 82
78 virtual G4bool DoesFieldChangeEnergy() c << 83 G4Field( G4bool gravityOn= false);
79 // Each type/class of field should res << 84 G4Field( const G4Field & );
80 // For example: << 85 virtual ~G4Field();
81 // - an electric field should re << 86 G4Field& operator = (const G4Field &p);
82 // - a pure magnetic field should re <<
83 87
84 inline G4bool IsGravityActive() const; << 88 // A field signature function that can be used to insure
85 // Does this field include gravity? << 89 // that the Equation of motion object and the G4Field object
>> 90 // have the same "field signature"?
>> 91
>> 92 virtual G4bool DoesFieldChangeEnergy() const= 0 ;
>> 93 // Each type/class of field should respond this accordingly
>> 94 // For example:
>> 95 // - an electric field should return "true"
>> 96 // - a pure magnetic field should return "false"
86 97
>> 98 G4bool IsGravityActive() const { return fGravityActive;}
>> 99 // Does this field include gravity?
87 inline void SetGravityActive( G4bool OnO 100 inline void SetGravityActive( G4bool OnOffFlag );
88 101
89 virtual G4Field* Clone() const; 102 virtual G4Field* Clone() const;
90 // Implements cloning, needed by multi << 103 // Implements cloning, needed by G4 MT
91 <<
92 static constexpr G4int MAX_NUMBER_OF_COM <<
93 104
94 private: 105 private:
95 106
96 G4bool fGravityActive = false; << 107 G4bool fGravityActive;
97 }; 108 };
98 109
99 // Inline methods ... << 110 inline void G4Field::SetGravityActive( G4bool OnOffFlag )
100 <<
101 inline G4bool G4Field::IsGravityActive() const <<
102 { <<
103 return fGravityActive; <<
104 } <<
105 <<
106 inline void G4Field::SetGravityActive( G4bool <<
107 { 111 {
108 fGravityActive = OnOffFlag; << 112 fGravityActive= OnOffFlag;
109 } << 113 }
110 << 114 #endif /* G4FIELD_HH */
111 #endif <<
112 115