Geant4  10.02.p01
G4ElectroMagneticField.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 //
27 // $Id: G4ElectroMagneticField.hh 68055 2013-03-13 14:43:28Z gcosmo $
28 //
29 //
30 // class G4ElectroMagneticField
31 //
32 // Class description:
33 //
34 // A full Electromagnetic field, containing both electric and magnetic fields.
35 // It is an abstract class, and a derived type of this field must be
36 // created by the user to describe his/her field configuration.
37 
38 // We have established a convention for the electromagnetic field components:
39 // In the GetValue method, the return values of Bfield will have
40 // the following meaning
41 // - Components 0, 1 and 2 are the Magnetic Field (x, y, z respectively);
42 // - Components 3, 4 and 5 are the Electric field (x, y, z respectively).
43 //
44 // Note 1: one or the other field could optional, depending on the Equation
45 // Note 2: such a convention is required between any field and its
46 // corresponding equation of motion.
47 //
48 // History:
49 // - Created: J. Apostolakis, November 12th, 1998
50 // - Modified:
51 // V. Grichine 8 Nov 2001: Extended "Point" arg to [4] array to add time
52 // G. Cosmo 2 Apr 2003: Reorgansised, moved inline methods to .cc
53 // J. Apostolakis 5 Nov 2003: Derive directly from G4Field
54 // J. Apostolakis 31 Aug 2004: Information on convention for components
55 // -------------------------------------------------------------------
56 
57 #ifndef G4ELECTROMAGNETIC_FIELD_DEF
58 #define G4ELECTROMAGNETIC_FIELD_DEF
59 
60 #include "G4Field.hh"
61 
63 {
64  public: // with description
65 
67  virtual ~G4ElectroMagneticField();
68 
71  // Copy constructor & assignment operators.
72 
73  virtual void GetFieldValue(const G4double Point[4],
74  G4double *Bfield ) const = 0;
75  // Return as Bfield[0], [1], [2] the magnetic field x, y & z components
76  // and as Bfield[3], [4], [5] the electric field x, y & z components
77 
78  virtual G4bool DoesFieldChangeEnergy() const = 0;
79 
80  // For field with an electric component this should be true
81  // For pure magnetic field this should be false
82  // Alternative: default safe implementation { return true; }
83 
84 };
85 
86 #endif /* G4ELECTROMAGNETIC_FIELD_DEF */
G4ElectroMagneticField & operator=(const G4ElectroMagneticField &p)
virtual G4bool DoesFieldChangeEnergy() const =0
virtual void GetFieldValue(const G4double Point[4], G4double *Bfield) const =0
bool G4bool
Definition: G4Types.hh:79
double G4double
Definition: G4Types.hh:76