magneticfield/include/G4EqEMFieldWithSpin.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 // G4EqEMFieldWithSpin
0027 //
0028 // Class description:
0029 //
0030 // This is the right-hand side of equation of motion in a combined
0031 // electric and magnetic field.
0032
0033 // Authors: Chris Gong & Peter Gumplinger (TRIUMF), 30.08.2007
0034 // -------------------------------------------------------------------
0035 #ifndef G4EQEMFIELDWITHSPIN_HH
0036 #define G4EQEMFIELDWITHSPIN_HH
0037
0038 #include "G4ChargeState.hh"
0039 #include "G4EquationOfMotion.hh"
0040
0041 class G4ElectroMagneticField;
0042
0043 /**
0044  * @brief G4EqEMFieldWithSpin implements the right-hand side of equation
0045  * of motion in a combined electric and magnetic field.
0046  */
0047
0048 class G4EqEMFieldWithSpin : public G4EquationOfMotion
0049 {
0050   public:
0051
0052     /**
0053      * Constructor for G4EqEMFieldWithSpin.
0054      *  @param[in] emField Pointer to the electromagnetic field.
0055      */
0056     G4EqEMFieldWithSpin(G4ElectroMagneticField* emField );
0057
0058     /**
0059      * Default Destructor.
0060      */
0061     ~G4EqEMFieldWithSpin() override = default;
0062
0063     /**
0064      * Sets the charge, momentum and mass of the current particle.
0065      * Used to set the equation's coefficients.
0066      *  @param[in] particleCharge Magnetic charge and moments in e+ units.
0067      *  @param[in] MomentumXc Particle momentum.
0068      *  @param[in] mass Particle mass.
0069      */
0070     void SetChargeMomentumMass(G4ChargeState particleCharge, // in e+ units
0071                                G4double MomentumXc,
0072                                G4double mass) override;
0073
0074     /**
0075      * Calculates the value of the derivative, given the value of the
0076      * electromagnetic field.
0077      *  @param[in] y Coefficients array.
0078      *  @param[in] Field Field value.
0079      *  @param[out] dydx Derivatives array.
0080      */
0081     void EvaluateRhsGivenB(const G4double y[],
0082                            const G4double Field[],
0083                                  G4double dydx[] ) const override;
0084
0085     /**
0086      * Setter and getter for magnetic anomaly.
0087      */
0088     inline void SetAnomaly(G4double a) { anomaly = a; }
0089     inline G4double GetAnomaly() const { return anomaly; }
0090
0091     /**
0092      * Returns the equation type-ID, "kEqEMfieldWithSpin".
0093      */
0094     inline G4EquationType GetEquationType() const override { return kEqEMfieldWithSpin; }
0095
0096   private:
0097
0098     G4double charge{0.}, mass{0.}, magMoment{0.}, spin{0.};
0099
0100     G4double fElectroMagCof{0.};
0101     G4double fMassCof{0.};
0102
0103     G4double omegac{0.}, anomaly{0.0011659208};
0104     G4double beta{0.}, gamma{0.};
0105 };
0106
0107 #endif