include/Geant4/G4MonopoleEq.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 // G4MonopoleEq
0027 //
0028 // Class description:
0029 //
0030 // This is the right-hand side of equation of motion for monopole
0031 // in a combined electric and magnetic field:
0032 // d(p_c)/ds=g{c-energyB_ - p_c x E}/pc.
0033
0034 // Author: Vladimir Grichine (CERN), 17.11.2009
0035 // -------------------------------------------------------------------
0036 #ifndef G4EQMAGELECTRICFIELD_HH
0037 #define G4EQMAGELECTRICFIELD_HH
0038
0039 #include "G4ChargeState.hh"
0040 #include "G4EquationOfMotion.hh"
0041 #include "G4ElectroMagneticField.hh"
0042
0043 /**
0044  * @brief G4MonopoleEq defines the right-hand side of equation of motion
0045  * for monopole in a combined electric and magnetic field:
0046  * d(p_c)/ds=g{c-energyB_ - p_c x E}/pc.
0047  */
0048
0049 class G4MonopoleEq : public G4EquationOfMotion
0050 {
0051   public:
0052
0053     /**
0054      * Constructor for G4MonopoleEq.
0055      *  @param[in] emField Pointer to the field.
0056      */
0057     G4MonopoleEq(G4ElectroMagneticField* emField);
0058
0059     /**
0060      * Default Destructor.
0061      */
0062     ~G4MonopoleEq() override = default;
0063
0064     /**
0065      * Sets the charge, momentum and mass of the current particle.
0066      * Used to set the equation's coefficients.
0067      *  @param[in] particleCharge Magnetic charge and moments in e+ units.
0068      *  @param[in] MomentumXc Particle momentum.
0069      *  @param[in] mass Particle mass.
0070      */
0071     void  SetChargeMomentumMass(G4ChargeState particleCharge,
0072                                 G4double MomentumXc,
0073                                 G4double mass) override;
0074
0075     /**
0076      * Calculates the value of the derivative, given the value of the 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      * Returns the equation type-ID, "kEqMonopole".
0087      */
0088     inline G4EquationType GetEquationType() const override { return kEqMonopole; }
0089
0090   private:
0091
0092     G4double fElectroMagCof = 0.0;
0093     G4double fMassCof = 0.0;
0094 };
0095
0096 #endif