include/Geant4/G4HarmonicPolMagField.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 // G4HarmonicPolMagField
0027 //
0028 // Class description:
0029 //
0030 // Class describing magnetic field parametrised by harmonic polynom up to
0031 // 3rd order. The function MagneticField(yTrack,B) calculates the magnetic
0032 // field induction vector B for the trajectory point yTrack according to
0033 // formula given in:
0034 //   M.Metcalf, Analysis of the SFM Field
0035 //   OM Development Note AP-10 (revised), 1974
0036
0037 // Author: Vladimir Grichine (CERN), 03.02.1997
0038 // --------------------------------------------------------------------
0039 #ifndef G4HARMONICPOLMAGFIELD_HH
0040 #define G4HARMONICPOLMAGFIELD_HH
0041
0042 #include "G4MagneticField.hh"
0043
0044 /**
0045  * @brief G4HarmonicPolMagField describes a magnetic field parametrised
0046  * by harmonic polynom up to 3rd order.
0047  */
0048
0049 class G4HarmonicPolMagField : public G4MagneticField
0050 {
0051   public:
0052
0053     /**
0054      * Default Constructor and Destructor.
0055      */
0056     G4HarmonicPolMagField() = default;
0057     ~G4HarmonicPolMagField() override = default;
0058
0059     /**
0060      * Returns the field value on the given position 'yTrack'.
0061      *  @param[in] yTrack Time position array.
0062      *  @param[out] B The returned field array.
0063      */
0064     void GetFieldValue(const G4double yTrack[], G4double B[]) const override;
0065
0066     /**
0067      * Returns a pointer to a new allocated clone of this object.
0068      */
0069     G4HarmonicPolMagField* Clone() const override;
0070 };
0071
0072 #endif