| Geant4 Cross Reference |
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 // G4ElectroMagneticField
27 //
28 // Class description:
29 //
30 // A full electromagnetic field, containing both electric and magnetic fields.
31 // It is an abstract class, and a derived type of this field must be
32 // created by the user to describe his/her field configuration.
33 //
34 // We have established a convention for the electromagnetic field components:
35 // In the GetValue() method, the return values of Bfield will have
36 // the following meaning
37 // - Components 0, 1 and 2 are the Magnetic Field (x, y, z respectively);
38 // - Components 3, 4 and 5 are the Electric field (x, y, z respectively).
39 //
40 // Note 1: one or the other field could optional, depending on the Equation
41 // Note 2: such a convention is required between any field and its
42 // corresponding equation of motion.
43
44 // Created: J.Apostolakis, 12.11.1998
45 // Modified: V.Grichine, 08.11.2001: Extended "Point" to add time
46 // -------------------------------------------------------------------
47 #ifndef G4ELECTROMAGNETIC_FIELD_HH
48 #define G4ELECTROMAGNETIC_FIELD_HH
49
50 #include "G4Field.hh"
51
52 class G4ElectroMagneticField : public G4Field
53 {
54 public:
55
56 G4ElectroMagneticField();
57 ~G4ElectroMagneticField() override;
58
59 G4ElectroMagneticField(const G4ElectroMagneticField& r);
60 G4ElectroMagneticField& operator = (const G4ElectroMagneticField& p);
61 // Copy constructor & assignment operators.
62
63 void GetFieldValue(const G4double Point[4],
64 G4double *Bfield ) const override = 0;
65 // Return as Bfield[0], [1], [2] the magnetic field x, y & z components
66 // and as Bfield[3], [4], [5] the electric field x, y & z components
67
68 G4bool DoesFieldChangeEnergy() const override = 0;
69 // For field with an electric component this should be true
70 // For pure magnetic field this should be false
71 // Alternative: default safe implementation { return true; }
72 };
73
74 #endif
75