Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/geometry/magneticfield/include/G4Field.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

Diff markup

Differences between /geometry/magneticfield/include/G4Field.hh (Version 11.3.0) and /geometry/magneticfield/include/G4Field.hh (Version 9.1.p1)


  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,v 1.10 2006/06/29 18:22:13 gunter Exp $
                                                   >>  28 // GEANT4 tag $Name: geant4-09-01-patch-01 $
                                                   >>  29 //
                                                   >>  30 //
                                                   >>  31 // class G4Field
 27 //                                                 32 //
 28 // Class description:                              33 // Class description:
 29 //                                                 34 //
 30 // Abstract class for any kind of Field.           35 // Abstract class for any kind of Field.
 31 // It allows any kind of field (vector, scalar     36 // It allows any kind of field (vector, scalar, tensor and any set of them)
 32 // to be defined by implementing the inquiry f     37 // to be defined by implementing the inquiry function interface.
 33 //                                                 38 //
 34 // The key method is  GetFieldValue( const  do     39 // The key method is  GetFieldValue( const  double Point[4],
 35 //                    *************         do     40 //                    *************         double *fieldArr ) 
 36 // Given an input position/time vector 'Point'     41 // Given an input position/time vector 'Point', 
 37 // this method must return the value of the fi     42 // this method must return the value of the field in "fieldArr".
 38 //                                                 43 //
 39 // A field must also specify whether it change     44 // A field must also specify whether it changes a track's energy:
 40 //                    DoesFieldChangeEnergy()      45 //                    DoesFieldChangeEnergy() 
 41 //                    *********************        46 //                    *********************
 42 // A field must co-work with a corresponding E     47 // A field must co-work with a corresponding Equation of Motion, to
 43 // enable the integration of a particle's posi     48 // enable the integration of a particle's position, momentum and, optionally, 
 44 // spin.  For this a field and its equation of     49 // spin.  For this a field and its equation of motion must follow the
 45 // same convention for the order of field comp     50 // same convention for the order of field components in the array "fieldArr"
 46                                                << 
 47 // Created: John Apostolakis, 10.03.1997       << 
 48 // -------------------------------------------     51 // -------------------------------------------------------------------
                                                   >>  52 // History:
                                                   >>  53 // - Created:  John Apostolakis, 10.03.1997
                                                   >>  54 // - Modified: 
                                                   >>  55 //   V. Grichine     8 Nov 2001: Extended "Point" arg to [4] array to add time
                                                   >>  56 //   J. Apostolakis  5 Nov 2003: Added virtual method DoesFieldChangeEnergy()
                                                   >>  57 //   J. Apostolakis 31 Aug 2004: Information on convention for components
                                                   >>  58 // -------------------------------------------------------------------
                                                   >>  59 
 49 #ifndef G4FIELD_HH                                 60 #ifndef G4FIELD_HH
 50 #define G4FIELD_HH                                 61 #define G4FIELD_HH
 51                                                    62 
 52 #include "G4Types.hh"                              63 #include "G4Types.hh"
 53 #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(){;}
 79         // Each type/class of field should res <<  84       virtual ~G4Field(){;}
 80         // For example:                        <<  85       inline G4Field& operator = (const G4Field &p); 
 81         //   - an electric field     should re <<  86 
 82         //   - a pure magnetic field should re <<  87      // A field signature function that can be used to insure
 83                                                <<  88      // that the Equation of motion object and the G4Field object
 84       inline G4bool IsGravityActive() const;   <<  89      // have the same "field signature"?
 85         //  Does this field include gravity?   <<  90  
 86                                                <<  91       virtual G4bool   DoesFieldChangeEnergy() const= 0 ;
 87       inline void SetGravityActive( G4bool OnO <<  92        //  Each type/class of field should respond this accordingly
 88                                                <<  93        //  For example:
 89       virtual G4Field* Clone() const;          <<  94        //    - an electric field     should return "true"
 90         // Implements cloning, needed by multi <<  95        //    - a pure magnetic field should return "false"
 91                                                << 
 92       static constexpr G4int MAX_NUMBER_OF_COM << 
 93                                                << 
 94   private:                                     << 
 95                                                    96 
 96       G4bool fGravityActive = false;           << 
 97 };                                                 97 };
 98                                                    98 
 99 // Inline methods ...                          <<  99 inline G4Field& G4Field::operator = (const G4Field &p)
100                                                << 
101 inline G4bool G4Field::IsGravityActive() const << 
102 {                                                 100 {
103   return fGravityActive;                       << 101   if (&p != this) { *this = p; }
                                                   >> 102   return *this;
104 }                                                 103 }
105                                                   104 
106 inline void G4Field::SetGravityActive( G4bool  << 105 #endif /* G4FIELD_HH */
107 {                                              << 
108   fGravityActive = OnOffFlag;                  << 
109 }                                              << 
110                                                << 
111 #endif                                         << 
112                                                   106