include/Geant4/G4Mag_SpinEqRhs.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 // G4Mag_SpinEqRhs
0027 //
0028 // Class description:
0029 //
0030 // This is the equation of motion for a particle with spin in a pure
0031 // magnetic field. The three components of the particle's spin are
0032 // treated utilising BMT equation.
0033
0034 // Created: J.Apostolakis, P.Gumplinger - 08.02.1999
0035 // --------------------------------------------------------------------
0036 #ifndef G4MAG_SPIN_EQRHS_HH
0037 #define G4MAG_SPIN_EQRHS_HH
0038
0039 #include "G4Types.hh"
0040 #include "G4Mag_EqRhs.hh"
0041 #include "G4ChargeState.hh"
0042
0043 class G4MagneticField;
0044
0045 class G4Mag_SpinEqRhs : public G4Mag_EqRhs
0046 {
0047    public:
0048
0049      G4Mag_SpinEqRhs( G4MagneticField* MagField );
0050     ~G4Mag_SpinEqRhs() override;
0051        // Constructor and destructor. No actions.
0052
0053      void SetChargeMomentumMass(G4ChargeState particleCharge,
0054                                 G4double MomentumXc,
0055                                 G4double mass) override;
0056
0057      void EvaluateRhsGivenB( const  G4double y[],
0058                              const  G4double B[3],
0059                                     G4double dydx[] ) const override;
0060        // Given the value of the magnetic field B, this function
0061        // calculates the value of the derivative dydx.
0062
0063      inline void SetAnomaly(G4double a) { anomaly = a; }
0064      inline G4double GetAnomaly() const { return anomaly; }
0065        // set/get magnetic anomaly
0066
0067    private:
0068
0069      G4double charge=0.0, mass=0.0, magMoment=0.0, spin=0.0;
0070      G4double omegac=0.0, anomaly=0.0011659208;
0071      G4double beta=0.0, gamma=0.0;
0072 };
0073
0074 #endif