include/Geant4/G4SextupoleMagField.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 // Class description:
0027 //
0028 // Sextupole magnetic field
0029 //   fGradient - is the gradient value for a sextupole magnet
0030 //   the magnetic field components are:
0031 //   Bx = B[0] = fGradient*X*Y,
0032 //   By = B[1] = fGradient*(X*X-Y*Y)/2,
0033 //   Bz = B[2] = 0
0034
0035 // Author: Helmut Burkhardt (CERN), 23.10.2019
0036 // -------------------------------------------------------------------
0037 #ifndef G4SEXTUPOLEMAGFIELD_HH
0038 #define G4SEXTUPOLEMAGFIELD_HH
0039
0040 #include "G4MagneticField.hh"
0041 #include "G4ThreeVector.hh"
0042 #include "G4RotationMatrix.hh"
0043
0044 /**
0045  * @brief G4SextupoleMagField is a class for defining a sextupole
0046  * magnetic field.
0047  */
0048
0049 class G4SextupoleMagField : public G4MagneticField
0050 {
0051   public:
0052
0053     /**
0054      * Constructor for G4SextupoleMagField.
0055      *  @param[in] pGradient Field gradient value.
0056      */
0057     G4SextupoleMagField(G4double pGradient);
0058
0059     /**
0060      * Constructor for G4QuadrupoleMagField.
0061      *  @param[in] pGradient Field gradient value.
0062      *  @param[in] pOrigin Origin position.
0063      *  @param[in] pMatrix Rotation matrix.
0064      */
0065     G4SextupoleMagField(G4double pGradient,
0066                         const G4ThreeVector& pOrigin,
0067                         G4RotationMatrix* pMatrix);
0068
0069     /**
0070      * Default Destructor.
0071      */
0072     ~G4SextupoleMagField() override = default;
0073
0074     /**
0075      * Returns the field value on the given position 'yTrack'.
0076      *  @param[in] yTrack Time position array.
0077      *  @param[out] B The returned field array.
0078      */
0079     void GetFieldValue(const G4double yTrack[], G4double B[]) const override;
0080
0081     /**
0082      * Returns a pointer to a new allocated clone of this object.
0083      */
0084     G4Field* Clone() const override;
0085
0086   private:
0087
0088     G4double          fGradient = 0.0;
0089     G4ThreeVector     fOrigin   = G4ThreeVector(0.0, 0.0, 0.0);
0090     G4RotationMatrix* fpMatrix  = nullptr;
0091 };
0092
0093 #endif