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