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