include/Geant4/G4MagneticField.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 // G4MagneticField
0027 //
0028 // Class description:
0029 //
0030 // Magnetic Field abstract class, implements inquiry function interface.
0031
0032 // Author: John Apostolakis (CERN), 13.01.1996
0033 // --------------------------------------------------------------------
0034 #ifndef G4MAGNETIC_FIELD_HH
0035 #define G4MAGNETIC_FIELD_HH
0036
0037 #include "G4Types.hh"
0038 #include "G4Field.hh"
0039
0040 class G4MagneticField : public G4Field
0041 {
0042   public:
0043
0044     /**
0045      * Default Constructor and Destructor.
0046      */
0047     G4MagneticField();
0048     ~G4MagneticField() override = default;
0049
0050     /**
0051      * Copy constructor and assignment operator.
0052      */
0053     G4MagneticField(const G4MagneticField& r);
0054     G4MagneticField& operator= (const G4MagneticField& p);
0055
0056     /**
0057      * Since a pure magnetic field does not change track energy, returns false.
0058      */
0059     inline G4bool DoesFieldChangeEnergy() const override { return false; }
0060
0061     /**
0062      * Given the position time vector 'Point', returns the value of the
0063      * field in the array 'Bfield'.
0064      *  @param[in] Point The position time vector.
0065      *  @param[out] Bfield The field array in output.
0066      */
0067     void GetFieldValue( const G4double Point[4],
0068                               G4double* Bfield ) const override = 0;
0069
0070     /**
0071      * Returns the field type-ID, "kMagnetic".
0072      * This should be overriden in derived classes.
0073      */
0074     inline G4FieldType GetFieldType() const override { return kMagnetic; }
0075 };
0076
0077 #endif