| 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.8 2003/11/05 10:35:55 japost Exp $
>> 25 // GEANT4 tag $Name: geant4-06-00 $
>> 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 // <<
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 35
47 // Created: John Apostolakis, 10.03.1997 << 36 // History:
>> 37 // - Created: John Apostolakis, 10.03.1997
48 // ------------------------------------------- 38 // -------------------------------------------------------------------
>> 39
49 #ifndef G4FIELD_HH 40 #ifndef G4FIELD_HH
50 #define G4FIELD_HH 41 #define G4FIELD_HH
51 42
52 #include "G4Types.hh" 43 #include "G4Types.hh"
53 #include "globals.hh" <<
54 44
55 class G4Field 45 class G4Field
56 { 46 {
57 public: // with description 47 public: // with description
58 48
59 G4Field( G4bool gravityOn = false); << 49 virtual void GetFieldValue( const double Point[4],
60 G4Field( const G4Field& ); << 50 double *Bfield ) const = 0;
61 virtual ~G4Field(); << 51 G4Field(){;}
62 G4Field& operator = (const G4Field& p); << 52 virtual ~G4Field(){;}
63 << 53 inline G4Field& operator = (const G4Field &p);
64 virtual void GetFieldValue( const G4doub << 54
65 G4doub << 55 // A field signature function that can be used to insure
66 // Given the position time vector 'Poin << 56 // that the Equation of motion object and the G4Field object
67 // return the value of the field in the << 57 // have the same "field signature"?
68 // Notes: << 58
69 // 1) The 'Point' vector has the foll << 59 virtual G4bool DoesFieldChangeEnergy() const= 0 ;
70 // Point[0] is x ( position, << 60 // For electric field this should be true
71 // Point[1] is y << 61 // For pure magnetic field this should be false
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 62
96 G4bool fGravityActive = false; <<
97 }; 63 };
98 64
99 // Inline methods ... << 65 inline G4Field& G4Field::operator = (const G4Field &p)
100 <<
101 inline G4bool G4Field::IsGravityActive() const <<
102 { 66 {
103 return fGravityActive; << 67 if (&p != this) { *this = p; }
>> 68 return *this;
104 } 69 }
105 70
106 inline void G4Field::SetGravityActive( G4bool << 71 #endif /* G4FIELD_HH */
107 { <<
108 fGravityActive = OnOffFlag; <<
109 } <<
110 <<
111 #endif <<
112 72