include/Geant4/G4RepleteEofM.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 // G4RepleteEofM
0027 //
0028 // Class description:
0029 //
0030 // This is the right-hand side of equation of motion in a combined
0031 // field, including: magnetic, electric, gravity, and gradient B field,
0032 // as well as spin tracking.
0033
0034 // Author: Peter Gumplinger (TRIUMF), 08.04.2013
0035 // -------------------------------------------------------------------
0036 #ifndef G4EOFM_HH
0037 #define G4EOFM_HH
0038
0039 #include "G4ChargeState.hh"
0040 #include "G4EquationOfMotion.hh"
0041
0042 class G4Field;
0043
0044 /**
0045  * @brief G4RepleteEofM is the right-hand side of equation of motion in a
0046  * combined field, including: magnetic, electric, gravity, and gradient
0047  * B field, as well as spin tracking.
0048  */
0049
0050 class G4RepleteEofM : public G4EquationOfMotion
0051 {
0052   public:
0053
0054     /**
0055      * Constructor for G4EquationOfMotion.
0056      *  @param[in] field Pointer to the field.
0057      *  @param[in] nvar The number of integration variables.
0058      */
0059     G4RepleteEofM(G4Field* field, G4int nvar = 8);
0060
0061     /**
0062      * Default Destructor.
0063      */
0064     ~G4RepleteEofM() override = default;
0065
0066     /**
0067      * Sets the charge, momentum and mass of the current particle.
0068      * Used to set the equation's coefficients.
0069      *  @param[in] particleCharge Magnetic charge and moments in e+ units.
0070      *  @param[in] MomentumXc Particle momentum.
0071      *  @param[in] mass Particle mass.
0072      */
0073     void SetChargeMomentumMass(G4ChargeState particleCharge, // in e+ units
0074                                G4double MomentumXc,
0075                                G4double mass) override;
0076
0077     /**
0078      * Calculates the value of the derivative, given the value of the 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 the magnetic anomaly.
0089      */
0090     inline void SetAnomaly(G4double a) { anomaly = a; }
0091     inline G4double GetAnomaly() const { return anomaly; }
0092
0093     /**
0094      * Modifiers.
0095      */
0096     inline void SetBField() { fBfield = true; }
0097     inline void SetEField() { fEfield = true; }
0098     inline void SetgradB()  { fgradB  = true; }
0099     inline void SetSpin()   { fSpin   = true; }
0100
0101   private:
0102
0103     G4int fNvar = 0;
0104
0105     G4bool fBfield=false, fEfield=false,
0106            fGfield=false, fgradB=false, fSpin=false;
0107
0108     G4double charge=0.0, mass=0.0, magMoment=0.0, spin=0.0;
0109
0110     G4double ElectroMagCof=0.0;
0111
0112     G4double omegac=0.0, anomaly=0.0;
0113     G4double beta=0.0, gamma=0.0;
0114 };
0115
0116 #endif