include/Geant4/G4DELPHIMagField.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 // G4DELPHIMagField
0027 //
0028 // Class description:
0029 //
0030 // Class describing the DELPHI magnetic field. The axial symmetry
0031 // field is mainly directed along Z axis. The function MagneticField(yTrack,B)
0032 // calculates the magnetic induction vector B in point corresponding to
0033 // yTrack according to parametrization given in:
0034 //   P.Billoir, Precise tracking in a quasi-homogeneous magnetic field,
0035 //              DELPHI 87-6 PROG 65, 1987.
0036
0037 // Author: Vladimir Grichine (CERN), 03.02.1997
0038 // -------------------------------------------------------------------
0039 #ifndef G4DELPHIMAGFIELD_HH
0040 #define G4DELPHIMAGFIELD_HH
0041
0042 #include "G4MagneticField.hh"
0043
0044 /**
0045  * @brief describes the DELPHI magnetic field. The axial symmetry field is
0046  * mainly directed along Z axis. The function MagneticField(yTrack,B)
0047  * calculates the magnetic induction vector B in given point corresponding
0048  * according to parameterisation given in: P.Billoir, DELPHI 87-6 PROG 65, 1987.
0049  */
0050
0051 class G4DELPHIMagField : public G4MagneticField
0052 {
0053   public:
0054
0055     /**
0056      * Default Constructor and Destructor.
0057      */
0058     G4DELPHIMagField() = default;
0059     ~G4DELPHIMagField() override = default;
0060
0061     /**
0062      * Returns the field value on the given position 'yTrack'.
0063      *  @param[in] yTrack Time position array.
0064      *  @param[out] B The returned field array.
0065      */
0066     void GetFieldValue(const G4double yTrack[], G4double B[]) const override;
0067
0068     /**
0069      * Returns a pointer to a new allocated clone of this object.
0070      */
0071     G4Field* Clone() const override;
0072 };
0073
0074 #endif